<back to all web services
SubscriptionWebhook
The following routes are available for this service:| POST,OPTIONS | /subscription/webhook | | |
|---|
To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /xml/oneway/SubscriptionWebhook HTTP/1.1
Host: api.kidkare.com
Content-Type: application/xml
Content-Length: length
<SubscriptionWebhook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KidKare.Api.Requests.Subscription">
<payload>String</payload>
<payloadData xmlns:d2p1="http://schemas.datacontract.org/2004/07/KidKare.Bll.Zoho.Models">
<d2p1:data>
<d2p1:payment>
<d2p1:autotransaction>
<d2p1:last_four_digits>String</d2p1:last_four_digits>
</d2p1:autotransaction>
<d2p1:date>0001-01-01T00:00:00</d2p1:date>
<d2p1:invoices>
<d2p1:SubscriptionWebhookModel.WebhookData.Payment.Invoice>
<d2p1:amount_applied>0</d2p1:amount_applied>
<d2p1:invoice_id>0</d2p1:invoice_id>
<d2p1:subscription_ids xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</d2p1:subscription_ids>
</d2p1:SubscriptionWebhookModel.WebhookData.Payment.Invoice>
</d2p1:invoices>
</d2p1:payment>
<d2p1:subscription>
<d2p1:activated_at>0001-01-01T00:00:00</d2p1:activated_at>
<d2p1:addons>
<d2p1:SubscriptionWebhookModel.WebhookData.Subscription.AddOn>
<d2p1:addon_code>String</d2p1:addon_code>
<d2p1:quantity>0</d2p1:quantity>
</d2p1:SubscriptionWebhookModel.WebhookData.Subscription.AddOn>
</d2p1:addons>
<d2p1:amount>0</d2p1:amount>
<d2p1:bank_account>
<d2p1:account_id>0</d2p1:account_id>
<d2p1:last_four_digits>0</d2p1:last_four_digits>
<d2p1:payment_gateway>String</d2p1:payment_gateway>
</d2p1:bank_account>
<d2p1:cancelled_at>0001-01-01T00:00:00</d2p1:cancelled_at>
<d2p1:card>
<d2p1:card_id>0</d2p1:card_id>
<d2p1:expiry_month>0</d2p1:expiry_month>
<d2p1:expiry_year>0</d2p1:expiry_year>
<d2p1:last_four_digits>0</d2p1:last_four_digits>
<d2p1:payment_gateway>String</d2p1:payment_gateway>
</d2p1:card>
<d2p1:child_invoice_id>String</d2p1:child_invoice_id>
<d2p1:coupon>
<d2p1:coupon_code>String</d2p1:coupon_code>
<d2p1:discount_amount>0</d2p1:discount_amount>
</d2p1:coupon>
<d2p1:custom_fields xmlns:d5p1="http://schemas.datacontract.org/2004/07/KidKare.Api.Requests.ZohoRequests">
<d5p1:ZohoCustomField>
<d5p1:label>String</d5p1:label>
<d5p1:value>String</d5p1:value>
</d5p1:ZohoCustomField>
</d2p1:custom_fields>
<d2p1:customer>
<d2p1:customer_id>0</d2p1:customer_id>
<d2p1:email>String</d2p1:email>
<d2p1:first_name>String</d2p1:first_name>
<d2p1:ip_address>String</d2p1:ip_address>
<d2p1:last_name>String</d2p1:last_name>
</d2p1:customer>
<d2p1:interval>0</d2p1:interval>
<d2p1:interval_unit>String</d2p1:interval_unit>
<d2p1:next_billing_at>0001-01-01T00:00:00</d2p1:next_billing_at>
<d2p1:plan>
<d2p1:name>String</d2p1:name>
<d2p1:plan_code>String</d2p1:plan_code>
<d2p1:plan_id>0</d2p1:plan_id>
<d2p1:price>0</d2p1:price>
<d2p1:quantity>0</d2p1:quantity>
</d2p1:plan>
<d2p1:product_id>0</d2p1:product_id>
<d2p1:product_name>String</d2p1:product_name>
<d2p1:status>String</d2p1:status>
<d2p1:subscription_id>0</d2p1:subscription_id>
<d2p1:trial_ends_at>0001-01-01T00:00:00</d2p1:trial_ends_at>
</d2p1:subscription>
</d2p1:data>
<d2p1:event_id>0</d2p1:event_id>
<d2p1:event_source>String</d2p1:event_source>
<d2p1:event_time>0001-01-01T00:00:00</d2p1:event_time>
<d2p1:event_type>String</d2p1:event_type>
</payloadData>
</SubscriptionWebhook>