Skip to main content
PATCH
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Body

application/json
metadata
object

Set of key-value pairs you can attach to the object — store your own system's IDs or grouping labels. Keys max 40 chars (up to 50 keys), values stored as strings max 500 chars. On update, keys merge individually; set a key to null or "" to remove it. Echoed back on reads and in webhook payloads.

Response

Checkout link updated

id
string
required
object
string
required
name
string | null
required
success_url
string | null
required
allow_discount_codes
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
metadata
object | null
required
url
string
required
discount

ID by default, full object when expanded

price_variants
object[]