Subscription webhook payload
The resource:url for a Subscription webhook payload uses this basic format:
https://
marketplace_url/api/billing/v1/subscriptions/
subscr_uuid
Here marketplace_url is the main URL for the marketplace (for example,
mycompany.byappdirect.com
), and subscr_uuid is a universally unique
identifier that the marketplace has generated for the subscription (for
example, d9d9e0fa-fbe1-4d98-a654-7921367aa3ed
).
When a Subscription:Added or Subscription:Changed webhook is triggered,
the content
payload matches the REST API Subscription definition
for the subscription.
The Subscription definition includes a reference to the Order object, which includes the REST API Order definition for the related order, as well as additional fields described in the Order webhook payload.
The payload also includes the following additional attributes that do not appear in the REST API documentation:
Attribute | Type | Description |
---|---|---|
parent SubscriptionId | String | If the subscription is for an add-on product, this is the identifier for the related parent product subscription. Only applies to subscriptions for add-ons. |
customAttributes | Object | If applicable, a list of custom attributes associated with the subscription. See the SubscriptionCustomAttribute definition. |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!