COconfirmo
Webhooks

A subscription was canceled

Sent when a subscription is canceled before its natural end. See data.cancellation.reason for who canceled it and why. data is the full Subscription.

postWebhooksubscription.canceled

Payload

idstring uuid required

Unique id of this delivery (UUIDv7), mirrored in the webhook-id header and covered by the signature. Retries of the same event repeat this id, so use it to dedupe. A replayed event gets a new id — see sequence.

type'subscription.canceled' required

Identifies the event — one of the types listed under Webhooks. Also sent as the webhook-type header.

timestampstring date-time required

When the event occurred (ISO-8601 UTC, sub-second precision). This is the event's own time and is preserved on retries and replays — it is not the webhook-timestamp header, which is stamped per attempt and is what the signature covers.

sequenceinteger required

Monotonically increasing counter, per resourceId, starting at 1. Payment events share their parent subscription's counter. Apply an event only if its sequence is higher than the last one you applied for that resourceId; that discards both stale redeliveries and replays of old events. Also sent as the webhook-sequence header. Not guaranteed gap-free.

resourceType'subscription' required

The kind of resource this event is about. Always subscription.

resourceIdstring uuid required

The subscription this event concerns — always the subscription id, even for payment events, which route to their parent subscription.

Example payload

{
  "id": "019832f1-7ac6-7d58-8f19-2b6e04d1a9c7",
  "type": "subscription.canceled",
  "timestamp": "2026-08-02T11:20:00.019873542Z",
  "sequence": 8,
  "resourceType": "subscription",
  "resourceId": "019807c2-6f2a-7b41-9c58-2f9c1a4b8d21",
  "data": {
    "id": "019807c2-6f2a-7b41-9c58-2f9c1a4b8d21",
    "planId": "019801a3-4d5e-7f80-9a1b-2c3d4e5f6071",
    "planName": "Pro Monthly",
    "amount": {
      "amount": "29.00",
      "asset": "USD"
    },
    "customerProfileId": "acct_8842",
    "email": "ada@example.com",
    "notifyUrl": "https://merchant.example/confirmo/webhook",
    "returnUrl": "https://merchant.example/subscription/thanks",
    "status": "CANCELED",
    "startDate": 1780041852,
    "cycleNumber": 3,
    "currentPeriod": {
      "start": 1785312252,
      "end": 1787990652
    },
    "cancellation": {
      "at": 1785669600,
      "reason": "MERCHANT"
    },
    "createdAt": 1780041521,
    "updatedAt": 1785669600
  }
}

Response

Return any 2xx status to acknowledge receipt. Any other response (or a timeout) is treated as a delivery failure and retried.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.