Skip to main content
POST
Resume a paused subscription

Authorizations

Authorization
string
header
required

Bearer credential for the public API. Vendor integrations should send a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Clerk bearer tokens are also accepted when paired with X-Cope-Business-Id.

Headers

Idempotency-Key
string
required

Required. At most 255 characters of valid UTF-8 with no NUL byte. The change attempt is recorded against this key for this subscription: a retry that carries the same key and the same body returns the original response instead of changing the subscription twice, and the same key with a different body is refused with 409 idempotency_conflict.

Maximum string length: 255

Path Parameters

id
string
required

id public identifier.

Pattern: ^sub_[A-Za-z0-9]{8,32}$
Example:

"sub_A1b2C3d4E5f6G7h8"

Body

application/json
reason
string

Optional. Recorded on the attempt and returned as reason; longer text is truncated to 500 characters.

Maximum string length: 500

Response

Successful response

data
object
required