> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cope.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. The body names the business, the order, the line item and the subscription, each as `object` and `id`; store `subscription.id` to match later events on the same subscription, and read everything else about them through the API.

## Delivery Contract

| Field        | Value                                                                                                   |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| Encoding     | JSON: `id`, `type`, `version`, `source`, `created_at`, `data`                                           |
| Delivery     | At least once                                                                                           |
| Idempotency  | Deduplicate on `id`: every retry and replay of this event repeats it, and `X-Cope-Event-Id` carries it. |
| Source       | `cope.subscription`                                                                                     |
| Category     | Subscriptions                                                                                           |
| Availability | Available in the public webhook reference.                                                              |
| Schema title | subscription.paused webhook body                                                                        |
| Schema ID    | `https://schemas.cope.com/webhooks/subscription.paused/v1`                                              |

## Payload Fields

| Field          | Required | Type     | Allowed Values                       | Description                                                                                                                                                                                                                                   |
| -------------- | -------- | -------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `business`     | no       | `object` | -                                    | The business that sold the subscription.                                                                                                                                                                                                      |
| `line_item`    | no       | `object` | -                                    | The order line the subscription belongs to.                                                                                                                                                                                                   |
| `order`        | no       | `object` | -                                    | The order the subscription was bought on.                                                                                                                                                                                                     |
| `pause_reason` | yes      | `string` | `payment_failed`, `business_request` | `business_request`: you paused it through the API, and only a resume lifts it. `payment_failed`: a renewal charge failed and collection is held while it is retried; it restarts by itself once the buyer pays, with no subscription.resumed. |
| `paused_at`    | yes      | `string` | -                                    | When collection stopped.                                                                                                                                                                                                                      |
| `subscription` | no       | `object` | -                                    | The subscription. Absent when the event names no subscription id of the right shape.                                                                                                                                                          |

## Example delivery

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "created_at": "2026-05-12T16:30:13Z",
  "data": {
    "business": {
      "id": "biz_g7-Jq2PxT_4mRvNa",
      "object": "business"
    },
    "line_item": {
      "id": "li_4nHs8QwZ2pLk7XcY",
      "object": "line_item"
    },
    "order": {
      "id": "ord_V7kP2mQx9RtL",
      "object": "order"
    },
    "pause_reason": "business_request",
    "paused_at": "2026-05-12T16:30:12Z",
    "subscription": {
      "id": "ps_Gm3Tq8ZrW1bN",
      "object": "subscription"
    }
  },
  "id": "8d2f6c1a-4e7b-4a39-b5d0-2c9e1f7a3b64",
  "source": "cope.subscription",
  "type": "subscription.paused",
  "version": "v1"
}
```

## Compatibility

Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.