Skip to main content
POST
Create a payment recovery link

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Headers

Idempotency-Key
string
required

Required. At most 255 characters of valid UTF-8 with no NUL byte. The link is bound to this key. A repeat under the same key answers 201 with Idempotent-Replayed: true and a new url for the same link: the secret in any earlier answer stops working, so a response lost in transit leaves no working link behind, and expires_at does not move. Only the latest answer under a key works, so do not send concurrent requests with the same key. A key binds to one subscription. A repeat after the link expired is refused with 409 idempotency_key_spent; send a new key.

Maximum string length: 255

Path Parameters

id
string
required

id public identifier.

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

"ps_A1b2C3d4E5f6"

Body

application/json

The body is of type object.

Response

Successful response

data
object
required