List of prices

get https://api.copperx.dev/api/v1/prices

Returns the list of prices

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

page

number

required

Defaults to 1

Page number. Starts from 1

limit

number

required

Defaults to 200

Number of items per page

count

number

required

hasMore

boolean

required

query

object

page

number

≥ 1

Defaults to 1

Page number. Starts from 1

limit

number

1 to 200

Defaults to 200

Number of items per page

createdAt

object

Filter by created date

data

array of objects

required

data*

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

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 GET \
2
     --url https://api.copperx.dev/api/v1/prices \
3
     --header 'accept: application/json'

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

application/json

200

500