Soft usage limit reached
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of usage limit-related webhook event.
subscriptionIdstring
ID of the order.
Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
subscriptionItemIdstring
ID of the subscription item.
Example:"sub_01HW2V1Y3A6QPM1NX4WCYHFSRS"
planIdstring
ID of the plan.
Example:"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
usageQuantityinteger
Reported usage quantity.
usageAmountnumber, (double)
Billed usage amount.
currencystring
Currency of the billed usage amount.
eventTypestring
Type of event that triggered the webhook.
Enum:"soft-usage-limit-reached""hard-usage-limit-reached""trial-usage-limit-reached"
_embeddedobject
Embedded objects related to the usage limit event.
_linksArray of objects
Links to related resources.
POST
soft-usage-limit-reached
Payload
{
  "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
  "subscriptionItemId": "sub_01HW2V1Y3A6QPM1NX4WCYHFSRS",
  "planId": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X",
  "usageQuantity": 0,
  "usageAmount": 0.1,
  "currency": "string",
  "eventType": "soft-usage-limit-reached",
  "_embedded": {
    "subscription": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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