Skip to main content
POST
billing.price.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
priceId
string
required

Price ID from billing.prices.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

priceId
string
required

Your price record ID. Historic prices remain available.

variantId
string
required

Parent variant ID.

currency
string
required

Store currency code.

category
enum<string>
required

Product payment category.

Available options:
one_time,
subscription,
lead_magnet,
pay_what_you_want,
unknown
scheme
enum<string>
required

Price calculation scheme.

Available options:
standard,
package,
graduated,
volume,
unknown
usageAggregation
enum<string>

Metered usage aggregation.

Available options:
sum,
last_during_period,
last_ever,
max
unitPrice
number

Integer price in minor units.

unitPriceDecimal
string

Exact price in decimal minor units; never rounded.

setupFeeEnabled
boolean

Setup fee applies.

setupFee
number

Setup fee in minor units.

packageSize
number

Units per package.

tiers
object[]

Pricing tiers.

Maximum array length: 100
renewalIntervalUnit
enum<string>

Renewal interval unit.

Available options:
day,
week,
month,
year
renewalIntervalCount
number

Renewal interval count.

trialIntervalUnit
enum<string>

Trial interval unit.

Available options:
day,
week,
month,
year
trialIntervalCount
number

Trial interval count.

minimumPrice
number

Minimum chosen price in minor units.

suggestedPrice
number

Suggested chosen price in minor units.

taxCode
string

Tax category.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last update, ISO 8601.