Appearance

Events ​

Event list ​

The following webhook events are available for integration.

NameDescription
order.createdOccurs when a new subscription order is created. This event is emitted immediately upon order creation and does not wait for subsequent order posting processes or fulfilment activities to complete.
subscription.createdOccurs when a new subscription is created following completion of the order posting process.
subscription.auto_renew_disabledOccurs when automatic renewal is disabled for a subscription. The subscription remains active until the end of its current term but will not automatically renew into a future term.
subscription.cancelled_customer_requestOccurs when a subscription is cancelled with immediate effect following an explicit customer request. This event is not emitted when a customer chooses to cancel at the end of the current term by disabling automatic renewal.
subscription.cancelled_payment_failureOccurs when a subscription is cancelled due to payment failure after all configured retry attempts have been exhausted.
subscription.expiredOccurs when a subscription reaches the end of its current term and expires without renewing into a future term. This event is emitted when the subscription enters an expired state.
subscription.term.updatedOccurs when the current subscription term is updated without the creation of a new renewal term, for example when additional issues are appended to the existing term.
subscription.renewal_term.createdOccurs when a future renewal term is created for an existing subscription before that term becomes active. This may occur following an early renewal or as part of the automatic renewal process.
subscription.renewedOccurs when a subscription enters a new active term, whether through automatic renewal or a customer or agent-initiated renewal. This event is emitted when the new term becomes active, rather than when the future/renewal term is first created.
subscription.item.changedOccurs when the item associated with a subscription is replaced as part of an upgrade or migration to a different subscription offering.
subscription.pausedOccurs when a subscription enters a temporary paused state at the customer’s request. This event is emitted when the pause becomes active and does not apply to scheduled, indefinite, or fulfilment-only suspensions.
subscription.resumedOccurs when a subscription previously in a paused state is reactivated and returns to an active status.
subscription.updatedOccurs when a subscription is updated and the change is not represented by a more specific subscription event. This event acts as a general-purpose subscription update notification.
customer.updatedOccurs when information associated with an existing customer record is updated.
customer.anonymisedOccurs when a customer record is anonymised following a request to erase or remove the customer's data.

Event Payload ​

A common payload format used by all subscription events, ensuring a consistent structure regardless of the event type.

{
  "subscriptionId": 123456789,
  "productId": "PROD-001",
  "startDate": "2026-01-01",
  "endDate": "2027-01-01",
  "rate": 19.99,
  "currency": "GBP",
  "status": "Active",
  "autoRenew": true,
  "billing": {
    "customer": {
      "id": "192834437382",
      "email": "john.smith@cdsglobal.co.uk",
      "title": "Mr",
      "firstName": "John",
      "lastName": "Smith",
      "companyName": "CDS Global",
      "phoneNumber": "0800 000 000",
      "dateOfBirth": "1985-06-15",
      "extendedValues": {
        "ExtendedValueOne": "Value",
      }
    },
    "address": {
      "code": "01",
      "line1": "123 High Street",
      "line2": "Suite 4",
      "line3": null,
      "town": "Edinburgh",
      "state": "Scotland",
      "postcode": "EH1 1AA",
      "country": "UNITED KINGDOM"
    }
  },
  "shipping": {
    "customer": {
      "id": "192834437382",
      "email": "john.smith@cdsglobal.co.uk",
      "title": "Mr",
      "firstName": "John",
      "lastName": "Smith",
      "companyName": "CDS Global",
      "phoneNumber": "0800 000 000",
      "dateOfBirth": "1985-06-15",
      "extendedValues": {
        "ExtendedValueOne": "Value",
      }
    },
    "address": {
      "code": "01",
      "line1": "456 Market Street",
      "line2": null,
      "line3": null,
      "town": "Glasgow",
      "state": "Scotland",
      "postcode": "G1 1AA",
      "country": "UNITED KINGDOM"
    }
  }
}