Billing agreement status updated

Webhook notification sent when a billing agreement's status changes

postWebhookagreementStatusUpdated

Headers

User-Agentstring required

Payload

agreementTokenstring required

Token identifying the billing agreement

status'ACTIVE' | 'INACTIVE' | 'TERMINATED' required

Current status of the agreement

reasonsstring[] required

List of reasons for the status update such as {PAYMENT_METHOD_EXPIRED, PENDING_RENEWAL, ACCOUNT_DEACTIVATED, USER_CANCELLED}

messagestring

Optional message providing additional context

dateTimestring date-time required

Timestamp of the status update

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.