Skip to main content
WEBHOOK
cancellation-succeeded
{
  "event": "CANCELLATION_SUCCEEDED",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 11,
    "name": "Uber"
  },
  "data": {
    "subscription_id": "ka8sdf0asdfm10as0a0sdfja7ssa8",
    "metadata": {
      "reference_token": "abc123",
      "trace_id": "def456"
    }
  },
  "timestamp": 1710864923198
}
Fired when a subscription or bill is canceled successfully.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Body

application/json
​
event
string

Name of the webhook event.

Example:

"CANCELLATION_SUCCEEDED"

​
session_id
string

Unique identifier for the session.

Example:

"fb5aa994-ed1c-4c3e-b29a-b2a53222e584"

​
external_user_id
string

Unique identifier for the user.

Example:

"3dcbb19a-b2f1-4a7b-8792-d76027b627b3"

​
merchant
object
​
data
object
​
timestamp
integer

Unix timestamp of the webhook event in UTC.

Example:

1710864923198