Billing agreement status updated

Webhook notification sent when a billing agreement's status changes

Payload

The payload of this webhook request is an object.
agreementTokenstringRequired
Token identifying the billing agreement
statusenumRequired
Current status of the agreement
Allowed values:
reasonslist of stringsRequired

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

dateTimestringRequiredformat: "date-time"
Timestamp of the status update
messagestring or nullOptional
Optional message providing additional context

Response

200
any
Return a 200 status to indicate that the data was received successfully.