Skip to main content
POST
Revoke a studio-scoped checkout link

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id
string
required

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256
Pattern: ^stu_[A-Za-z0-9_-]+$
Required string length: 1 - 240

Response

Revoked checkout-link lifecycle record

Safe lifecycle projection. It deliberately excludes the token, recipient context, retail-line details, Stripe identifiers, and provider data.

expires_at
string<date-time>
required
id
string
required
revocable
boolean
required
status
enum<string>
required
Available options:
active,
checkout_created,
fulfilled,
revoked,
expired
preview_status
string

Present only in a Test Mode creation response. It is an explicit non-payable result, not a browser URL or checkout capability.

Allowed value: "non_payable"
share_url
string<uri>
read-only

Live Mode bearer URL, returned only once in the first successful creation response. Treat as a secret.

subtotal_cents
integer
Required range: x >= 0