subscription.resumed

Generated from COPE public event contracts. Do not edit this page by hand.

Use this event to resume tracking renewals on a subscription you paused. It is the counterpart of subscription.paused with pause_reason business_request only: when collection restarts after a failed payment is settled (pause_reason payment_failed), no subscription.resumed is sent, so do not wait for one. Nothing is charged at the moment of resuming. Billing continues from the existing cycle boundary, and next_billing_at is when the next renewal is due, or null if that date could not be determined. resume_reason is always business_request on this event.

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:<identifier>`
Category	Subscriptions
Availability	Available in the public webhook reference.
Schema title	subscription.resumed v1 payload
Schema ID	`https://schemas.cope.com/events/subscription.resumed/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.resumed`	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`	-	-
`manage_subscription_url`	yes	`string`	-	Where the buyer manages their subscriptions.
`next_billing_at`	yes	`string	null`	-	When the next renewal is due: the end of the billing period that was current when the subscription resumed. Null if that date could not be determined.
`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.
`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, which the next renewal bills.
`resume_reason`	yes	`string`	`business_request`	Why collection resumed. `business_request`: you resumed a subscription you had paused.
`resumed_at`	yes	`string`	-	When collection resumed.
`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`	yes	`string`	-	The subscription’s public reference (‘sub_’ followed by 16 alphanumerics) — the identifier the subscriptions API accepts, and the handle to use for this subscription.

Example CloudEvent

{
  "data": {
    "buyer": {
      "email": "buyer@example.com",
      "first_name": "example_first_name",
      "last_name": "example_last_name",
      "locale": "example_locale"
    },
    "manage_subscription_url": "https://example.com",
    "next_billing_at": "2026-05-05T12:00:00.000Z",
    "resume_reason": "business_request",
    "resumed_at": "2026-05-05T12:00:00.000Z",
    "subscription_id": "example_id"
  },
  "datacontenttype": "application/json",
  "dataschema": "https://schemas.cope.com/events/subscription.resumed/v1",
  "id": "subscription.resumed:example",
  "idempotency_key": "subscription.resumed:example",
  "source": "cope.subscription",
  "specversion": "1.0",
  "subject": "subscription:example",
  "time": "2026-05-05T12:00:00.000Z",
  "type": "subscription.resumed"
}

Compatibility

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

Changelog

Reference

subscription.resumed

subscription.resumed

Delivery Contract

Payload Fields

Example CloudEvent

Compatibility

​subscription.resumed

​Delivery Contract

​Payload Fields

​Example CloudEvent

​Compatibility

subscription.resumed

Delivery Contract

Payload Fields

Example CloudEvent

Compatibility