Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Price

Update a price

Updates a price nickname and metadata

put/api/v1/prices/{id}

Path parameters

idstring required

Request body

isActiveboolean

Whether the price is currently active

metadataobject

A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

visibilitystring
nicknamestring

A nickname for the price, not displayed to customer. Only visible in the dashboard

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
billingScheme'per_unit'
currency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu' required
productIdstring uuid required

Product's id

interval'day' | 'week' | 'month' | 'year'
intervalCountnumber

It is used to determine the frequency at which the subscription is billed. Only required for subscriptions

isActiveboolean

Whether the price is currently active

usageType'licensed'
type'one_time' | 'recurring' | 'streaming' required
unitAmountinteger

The unit amount in 8 decimals, represented as a whole integer. If not provided, the unit amount will be calculated from unit_amount_decimal.

unitAmountDecimalstring
customUnitMaxinteger

The maximum amount that can be billed per unit for this price. Only if unit amount is not provided

customUnitMininteger

The minimum amount that can be billed per unit for this price. Only if unit amount is not provided

customPresetinteger

The default amount to fill in the amount field for this price on checkout. Only if unit amount is not provided

customUnitAmountSuggestionsstring[]

Amount suggestions for this price. Only if unit amount is not provided

metadataobject

A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

visibilitystring
nicknamestring

A nickname for the price, not displayed to customer. Only visible in the dashboard

Example response

{
  "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "intervalCount": 1,
  "product": {
    "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
  }
}