Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Price ID
Response
OK
Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
RECURRING
, ONETIME
FLAT_FEE
, PACKAGE
, TIERED
MONTHLY
, ANNUAL
, WEEKLY
, DAILY
, QUARTERLY
, HALF_YEARLY
BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
ConversionRate is the rate of the price unit to the base currency For BTC: 1 BTC = 100000000 USD
Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp
Description of the price
DisplayAmount is the formatted amount with currency symbol For USD: $12.50
DisplayPriceUnitAmount is the formatted amount with price unit symbol For BTC: 0.00000001 BTC
EndDate is the end date of the price
EntityID holds the value of the "entity_id" field.
PLAN
, SUBSCRIPTION
, ADDON
, PRICE
EnvironmentID is the environment identifier for the price
ID uuid identifier for the price
ARREAR
, ADVANCE
LookupKey used for looking up the price in the database
MeterID is the id of the meter for usage based pricing
ParentPriceID references the parent price (only set when scope is SUBSCRIPTION)
TODO: Remove this once we have a proper price entity type
PriceUnit 3 digit ISO currency code in lowercase ex btc For BTC: btc
PriceUnitAmount is the amount stored in price unit For BTC: 0.00000001 means 0.00000001 BTC
PriceUnitID is the id of the price unit
PriceUnitTiers are the tiers for the price unit
FIAT
, CUSTOM
StartDate is the start date of the price
published
, deleted
, archived
VOLUME
, SLAB
TrialPeriod is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)
USAGE
, FIXED