/
Subscription order paused

Subscription order paused
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of subscription pause-related webhook event.

subscriptionIdstring

ID of the order.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
subscriptionPauseIdstring

ID of the subscription pause.

Example:"sub_pau_01H085J3ZR1WKD120D73D7N4C9"
eventTypestring

Type of event that triggered the webhook.

Enum:"subscription-pause-created""subscription-pause-modified""subscription-pause-revoked""subscription-paused""subscription-resumed"
_embeddedobject

Embedded objects related to the subscription pause event.

Payload
{
  "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
  "subscriptionPauseId": "sub_pau_01H085J3ZR1WKD120D73D7N4C9",
  "eventType": "subscription-pause-created",
  "_embedded": {
    "subscription": { … },
    "pause": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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