Subscription quantity filled limit reached
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of subscription quantity limit-related webhook event.
subscriptionIdstring
ID of the order.
Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
subscriptionItemIdstring
ID of the subscription item.
Example:"sub_01HW2V1Y3A6QPM1NX4WCYHFSRS"
quantityinteger
Quantity of the subscription item.
quantityFillednumber, (double)
Reported quantity.
Example:5.125
previousQuantityFillednumber, (double)
Reported quantity before the subscription item updates.
Example:4.037
eventTypestring
Type of event that triggered the webhook.
Value:"subscription-quantity-filled-limit-reached"
_embeddedobject
Embedded objects related to the subscription quantity limit event.
POST
orders-experimental-subscription-quantity-filled-limit-reached
Payload
{ "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "subscriptionItemId": "sub_01HW2V1Y3A6QPM1NX4WCYHFSRS", "quantity": 0, "quantityFilled": 5.125, "previousQuantityFilled": 4.037, "eventType": "subscription-quantity-filled-limit-reached", "_embedded": { "subscription": { … } }, "_links": [ { … } ] }

Responses

Returns any 2xx status to indicate that data is received.