Skip to main content
PUT
Update Custom Product

Headers

x-api-key
string
required

API key from your PriceOS dashboard.

Path Parameters

productKey
string
required

Product key.

Body

application/json
name
string

Custom product name.

productKey
string

Stable custom product key.

metadata
object

Custom product metadata.

isDefault
boolean

Whether this is the default custom product.

Response

Custom product updated

Product.

id
string
required

Product ID.

key
string
required

Product key.

name
string
required

Product name.

type
enum<string>
required

Product type.

Available options:
stripe,
custom
isDefault
boolean
required

Whether this is the default custom product.

version
number
required

Product version number.

stripeProductId
string | null
required

Stripe product ID (Stripe products only).

metadata
object
required

Custom product metadata (custom products only).

prices
object[]
required

Stripe prices linked to the product.

featureAccess
object[]
required

Feature access entries configured for this product.