Update a price

put https://api.copperx.dev/api/v1/prices/{id}

Updates a price nickname and metadata

Responses

Response body

object

string

required

createdAt

date-time

updatedAt

date-time

billingScheme

string

The billing scheme to use for this price

per_unit

currency

string

required

The currency symbol

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu

productId

uuid

required

Product's id

interval

string

The interval at which to bill for this price. Only required for subscriptions

day week month year

intervalCount

number

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

isActive

boolean

Whether the price is currently active

usageType

string

The usage type of the price.

licensed

type

string

required

The type of the price

one_time recurring streaming

unitAmount

int64

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

unitAmountDecimal

string

customUnitMax

int64

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

customUnitMin

int64

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

customPreset

int64

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

customUnitAmountSuggestions

array of strings

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

customUnitAmountSuggestions

product

object

required

The product this price belongs to

string

required

createdAt

date-time

updatedAt

date-time

name

string

required

The name of the product. Displayed on the checkout page

description

string

The description of the product. Displayed on the checkout page

isActive

boolean

Whether the product is currently active

images

array of strings

length ≤ 8

The url of product images. Displayed on the checkout page

images

publicImages

array of strings

Product images with absolute public url

publicImages

unitLabel

string

The label of the unit of the product. Displayed on the checkout page

url

string

The url of the product

defaultPriceId

uuid

Product's default price id

metadata

object

The metadata of the product

Has additional fields

visibility

string

The visibility of the product

10 20

metadata

object

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.

Has additional fields

visibility

string

The visibility of the price. If dashboard, the price is visible in the dashboard

10 20

nickname

string

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

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.copperx.dev/api/v1/prices/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

500