PriceList
items object[]required
The prices in this page, newest first.
Unique identifier for the price.
3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13The product of the price. It cannot change after the price is created.
8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60Three-letter ISO currency code, in uppercase. Must be a supported currency.
EURThe amount of the price: for each billing period of a RECURRING price, once for a
ONE_TIME price. A positive integer in the smallest currency unit (for example, 1990
cents to charge 19.90 EUR). Without tax for an EXCLUSIVE price.
Possible values: >= 1
1990How the price bills: RECURRING (the default) or ONE_TIME. Only a RECURRING price can
start or switch a subscription. Treat the set as open: more values can be added later.
RECURRINGRECURRINGrecurring object
The billing period of a RECURRING price. Absent on a ONE_TIME price. A subscription
created from the price copies these values.
The unit of the billing period. minute and hour are accepted in test mode only.
Possible values: [minute, hour, day, week, month, year]
monthNumber of intervals between payments. The billing period cannot be longer than one year.
Possible values: >= 1
1Number of trial days of a subscription created from the price.
Possible values: >= 1 and <= 1825
7How the tax of the product's tax rate applies to unitAmount:
INCLUSIVE:unitAmountholds the tax.EXCLUSIVE: the tax is added tounitAmount.
No value means INCLUSIVE. Treat the set as open: more values can be added later.
EXCLUSIVEWhether the price is active. An inactive price cannot start a subscription, and a
subscription cannot switch to it. Prices are never deleted: set active to false to
archive one. Subscriptions that already use it keep their copy of its values.
A new price is active unless created with active: false.
trueAn internal label of the price. Buyers never see it.
Possible values: <= 100 characters
MonthlyA set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.
{"systemId":"12345"}Time at which the resource was created. Measured in seconds since the Unix epoch.
1636366897Time at which the resource updated last time. Measured in seconds since the Unix epoch.
1636366897Pass this value as cursor to get the next page. Absent when there are no more items.
The last page can still carry it, and the next call then returns no items.
eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ{
"items": [
{
"id": "3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13",
"productId": "8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60",
"currency": "EUR",
"unitAmount": 1990,
"type": "RECURRING",
"recurring": {
"interval": "month",
"intervalCount": 1,
"trialPeriodDays": 7
},
"taxBehavior": "EXCLUSIVE",
"active": true,
"nickname": "Monthly",
"metadata": {
"systemId": "12345"
},
"createdAt": 1636366897,
"updatedAt": 1636366897
}
],
"nextCursor": "eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ"
}