Skip to main content
PATCH
Update a product

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Path Parameters

product
string
required

The product's record id, or its exact name.

Body

application/json

Only the fields you send change.

name
string
Required string length: 1 - 200
description
string
Maximum string length: 2000
price
number

Per unit, in major units.

Required range: x >= 0
currency
string

ISO code.

Required string length: 3
Example:

"usd"

interval
enum<string>
Available options:
month,
year,
one_time
usageEvent
string

The usage event a metered product bills by.

Maximum string length: 200

Response

200 - application/json

The product.

data
object
reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"