> ## Documentation Index > Fetch the complete documentation index at: https://docs.staging.cope-demo.com/llms.txt > Use this file to discover all available pages before exploring further. # subscription.paused > A subscription has stopped collecting renewals. # subscription.paused > Generated from COPE public event contracts. Do not edit this page by hand. Use this event to stop expecting renewal charges on a subscription. `pause_reason` says why, and the two reasons behave differently. `business_request` means you paused the subscription through the API: it reads `paused`, no renewal is charged, and it stays paused until you resume it, which sends subscription.resumed. `payment_failed` means a recurring charge failed and collection is held while the payment is retried: the subscription reads `overdue`, not `paused`, collection restarts by itself once the buyer pays, and that restart sends no subscription.resumed. Identify the subscription by `subscription.id`, with `subscription_id` carrying the same value until it retires; `line_item_id`, `business_id` and `processor_subscription_id` are internal references, so do not store them. ## Delivery Contract | Field | Value | | --------------- | ------------------------------------------------------------------------------------ | | Encoding | CloudEvents 1.0 structured JSON | | Delivery | At least once | | Idempotency | Use the CloudEvents `source` + `id` tuple, or COPE `idempotency_key` when available. | | Source | `cope.subscription` | | Subject pattern | `subscription:` | | Category | Subscriptions | | Availability | Available in the public webhook reference. | | Schema title | subscription.paused v1 payload | | Schema ID | `https://schemas.cope.com/events/subscription.paused/v1` | ## Payload Fields | Field | Required | Type | Allowed Values | Description | | | --------------------------- | -------- | --------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additional_recipients` | no | `array` | - | Inboxes you configured to be copied on this notification type. Absent when there are none. | | | `business` | no | `object` | - | The business selling the subscription. Carries `object` (what it is) and `id` (which one); `id` is the public identifier a merchant addresses it by. | | | `business_name` | no | \`string | null\` | - | - | | `buyer` | yes | `object` | - | - | | | `currency` | no | \`string | null\` | - | - | | `event_type` | no | `const` | `subscription.paused` | Optional on the wire, and normally absent: the event's type is carried by the CloudEvents envelope as `type`, so the payload does not repeat it. It is declared here so that if you copy the envelope's type onto the payload before validating the payload against this schema, that validation still passes. Read the envelope rather than depending on this field — a payload without it is valid. | | | `interval` | no | \`string | null\` | `day`, `week`, `month`, `year` | - | | `interval_count` | no | \`integer | null\` | - | - | | `line_item` | no | `object` | - | The order line the subscription belongs to. Carries `object` (what it is) and `id` (which one); `id` is the public identifier a merchant addresses it by. | | | `line_item_id` | yes | `integer` | - | An internal reference. Do not store it or use it to identify the subscription. It is a database row number, not a public identifier — use `subscription.id` instead. It is removed at the contract cut (plan 53 D-13), and the removal is legal here because a public identifier for the same entity is in this same payload. | | | `manage_subscription_url` | yes | `string` | - | Where the buyer manages their subscriptions. | | | `order` | no | `object` | - | The order the subscription was bought on. Carries `object` (what it is) and `id` (which one); `id` is the public identifier a merchant addresses it by. | | | `pause_reason` | yes | `string` | `payment_failed`, `business_request` | Why collection stopped. `business_request`: you paused the subscription; it reads `paused` and only a resume lifts it, announced as subscription.resumed. `payment_failed`: a recurring charge failed; the subscription reads `overdue`, collection restarts by itself when the buyer pays, and no subscription.resumed is sent. | | | `paused_at` | yes | `string` | - | When collection was paused. | | | `processor_subscription_id` | yes | `string` | - | An internal reference. Do not store it or use it to identify the subscription — use subscription\_id. | | | `product` | no | `object` | - | The product the subscription is for. Carries `object` (what it is) and `id` (which one); `id` is the public identifier a merchant addresses it by. | | | `product_name` | no | \`string | null\` | - | The product's name as it was when the subscription was bought, so it is still present after the product is renamed or deleted. | | `recurring_amount_cents` | no | \`integer | null\` | - | The recurring charge per billing cycle in minor units, as it stood when collection was paused. | | `subscription` | no | `object` | - | The subscription this event concerns. Carries `object` (what it is) and `id` (which one); `id` is the public identifier a merchant addresses it by. | | | `subscription_id` | no | \`string | null\` | - | The subscription's public reference ('sub\_' followed by 16 alphanumerics) — the identifier the subscriptions API accepts, and the handle to use for this subscription. Null only for a subscription that has never been given a public reference; order\_uuid identifies the purchase in that case. | ## Example CloudEvent ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} { "data": { "buyer": { "email": "buyer@example.com", "first_name": "example_first_name", "last_name": "example_last_name", "locale": "example_locale" }, "line_item_id": 1000, "manage_subscription_url": "https://example.com", "pause_reason": "payment_failed", "paused_at": "2026-05-05T12:00:00.000Z", "processor_subscription_id": "example_id" }, "datacontenttype": "application/json", "dataschema": "https://schemas.cope.com/events/subscription.paused/v1", "id": "subscription.paused:example", "idempotency_key": "subscription.paused:example", "source": "cope.subscription", "specversion": "1.0", "subject": "subscription:example", "time": "2026-05-05T12:00:00.000Z", "type": "subscription.paused" } ``` ## Compatibility Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.