For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • POSTStart Billing Agreement Approval Process
      • POSTCreate Billing Agreement
      • POSTCreate Billing Agreement Alias
      • PUTCancel Billing Agreement (Alternative)
      • POSTRetrieve Billing Agreement Offers
      • POSTRetrieve Billing Agreement
      • POSTStart Billing Agreement Link Flow
      • GETGet Billing Agreement Details
      • DELCancel Billing Agreement
      • POSTCapture Full Recurring Payment
      • POSTAuthorize Recurring Payment
      • POSTBilling agreement status updated
LogoLogo
ReferenceBilling Agreements (Deprecated)

Billing agreement status updated

Payload
1{
2  "agreementToken": "string",
3  "status": "ACTIVE",
4  "reasons": [
5    "string"
6  ],
7  "dateTime": "2024-01-15T09:30:00Z"
8}
Webhook notification sent when a billing agreement's status changes
Was this page helpful?
Previous

Create Checkout

Next
Built with

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.