POST
/
prices

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json
billing_cadence
enum<string>
required
Available options:
RECURRING,
ONETIME
billing_model
enum<string>
required
Available options:
FLAT_FEE,
PACKAGE,
TIERED
billing_period
enum<string>
required
Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY
billing_period_count
integer
required
Required range: x > 1
currency
string
required
type
enum<string>
required
Available options:
USAGE,
FIXED
amount
string
description
string
filter_values
object
lookup_key
string
metadata
object
meter_id
string
plan_id
string
tier_mode
enum<string>
Available options:
VOLUME,
SLAB
tiers
object[]
transform_quantity
object

Response

201 - application/json
amount
number

Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50

billing_cadence
any
billing_model
any
billing_period
any
billing_period_count
integer

BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12

created_at
string
created_by
string
currency
string

Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp

description
string

Description of the price

display_amount
string

DisplayAmount is the formatted amount with currency symbol For USD: $12.50

filter_values
object

FilterValues are the filter values for the price in case of usage based pricing

id
string

ID uuid identifier for the price

lookup_key
string

LookupKey used for looking up the price in the database

metadata
object

Metadata is a jsonb field for additional information

meter
object
meter_id
string

MeterID is the id of the meter for usage based pricing

plan_id
string

PlanID is the id of the plan for plan based pricing

status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
tier_mode
any
tiers
object[]

Tiers are the tiers for the price when BillingModel is TIERED

transform_quantity
object

Transform is the quantity transformation in case of PACKAGE billing model

type
any
updated_at
string
updated_by
string