Events

The following webhook events are available for integration.

Name	Description
order.created	A new order was created.
subscription.renewed	A subscription was renewed, either by the customer or via the auto-renewal process.
subscription.paused	A subscription was temporarily paused by the customer.
subscription.resumed	A subscription was reactivated after being temporarily paused.
customer.created	A new customer record was created.
customer.updated	An existing customer record was updated.
customer.deactivated	An existing customer record was deactivated.
payment.success	A payment was successfully processed.
payment.failed	A payment was unable to be processed.
payment.refunded	A refund was issued for a payment.

Event payloads

order.created

JSON

{
  "order_id": "12345",
  "customer_id": "789",
  "subscription_id": 101,
  "order_date": "2025-06-01T12:00:00Z",
  "order_source": "online_singleitem",
  "order_total": 19.99,
  "currency": "GBP",
  "order_items": [
    {
      "product_id": "MHEMH1",
      "product_name": "Men's Health Print + Digital",
      "promotion_code": "HMU100352",
      "price": 19.99
    }
  ]
}

subscription.renewed

JSON

{
  "subscription_id": 101,
  "renewal_date": "01-01-2025",
  "next_term_end": "01-01-2026",
  "amount": 29.99,
  "currency": "GBP",
}

subscription.paused

JSON

{
  "subscription_id": 101,
  "pause_start": "01-07-2025",
  "pause_end": "01-09-2025",
  "reason": "Going on holiday",
}

subscription.resumed

JSON

{
  "subscription_id": 101,
  "status": "active"
}

customer.created

JSON

{
  "customer_id": "789",
  "title": "Mr",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@cdsglobal.co.uk",
  "phone_number": "07111111111",
  "company_name": "",
  "date_of_birth": "01.01.1990",
  "address_line_1": "1 The Street",
  "address_line_2": "",
  "address_line_3": "",
  "town": "Market Harborough",
  "state": "",
  "postcode": "LE16 9EF",
  "zip_code": "",
  "country": "United Kingdom",
  "created_at": "2025-06-01T12:00:00Z"
}

customer.updated

JSON

{
  "customer_id": "789",
  "title": "Mr",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@cdsglobal.co.uk",
  "phone_number": "07111111111",
  "company_name": "",
  "date_of_birth": "01.01.1990",
  "address_line_1": "1 The Street",
  "address_line_2": "",
  "address_line_3": "",
  "town": "Market Harborough",
  "state": "",
  "postcode": "LE16 9EF",
  "zip_code": "",
  "country": "United Kingdom",
  "updated_at": "2025-06-01T12:00:00Z"
}

customer.deactivated

JSON

{
  "customer_id": "789",
  "deactivated_at": "2025-06-01T12:00:00Z"
}

payment.success

JSON

{
  "payment_id": "001",
  "subscription_id": 101,
  "customer_id": "789",
  "amount": 19.99,
  "currency": "GBP",
  "payment_method": "card",
  "payment_date": "2025-06-01T12:05:00Z"
}

payment.failed

JSON

{
  "payment_id": "002",
  "subscription_id": 101,
  "customer_id": "789",
  "amount": 19.99,
  "currency": "GBP",
  "attempt_date": "2025-06-01T12:10:00Z",
  "failure_reason": "Card declined"
}

payment.refunded

JSON

{
  "refund_id": "ref_001",
  "original_payment_id": "pay_001",
  "subscription_id": 101,
  "customer_id": "789",
  "amount": 10.00,
  "currency": "GBP",
  "refund_date": "2025-06-01T13:00:00Z",
  "reason": "Prorated downgrade"
}