Sign in

v12

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-07-0971442569.2 KB
Prices

Create price

Use when adding a new price to a plan or catalog (e.g. per-seat, flat, or metered). Ideal for both simple and usage-based pricing.

post/prices

Request body

amountstring
billing_model'FLAT_FEE' | 'PACKAGE' | 'TIERED' required
billing_period'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME' required
billing_period_countinteger
currencystring required
descriptionstring
display_namestring
end_datestring date-time
entity_idstring required
entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON' | 'PRICE' | 'COSTSHEET' required
filter_valuesobject
group_idstring

GroupID is the id of the group to add the price to

invoice_cadence'ARREAR' | 'ADVANCE' required
lookup_keystring
metadataobject
meter_idstring
min_quantityinteger

MinQuantity is the minimum quantity of the price

price_unit_type'FIAT' | 'CUSTOM' required
start_datestring date-time
tier_mode'VOLUME' | 'SLAB'
trial_period_daysinteger
type'USAGE' | 'FIXED' required

Response

Created

amountstring

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

billing_cadence'RECURRING'
billing_model'FLAT_FEE' | 'PACKAGE' | 'TIERED'
billing_period'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME'
billing_period_countinteger

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

conversion_ratestring

ConversionRate is the conversion rate of the price unit to the fiat currency

created_atstring date-time
created_bystring
currencystring

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

descriptionstring

Description of the price

display_amountstring

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

display_namestring

DisplayName is the name of the price

display_price_unit_amountstring

DisplayPriceUnitAmount is the formatted amount of the price unit

end_datestring date-time

EndDate is the end date of the price

entity_idstring

EntityID holds the value of the "entity_id" field.

entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON' | 'PRICE' | 'COSTSHEET'
environment_idstring

EnvironmentID is the environment identifier for the price

group_idstring

GroupID references the group this price belongs to

idstring

ID uuid identifier for the price

invoice_cadence'ARREAR' | 'ADVANCE'
lookup_keystring

LookupKey used for looking up the price in the database

metadataPriceJSONBMetadata
meter_idstring

MeterID is the id of the meter for usage based pricing

min_quantitystring nullable

MinQuantity is the minimum quantity of the price

parent_price_idstring

ParentPriceID references the root price (always set for price lineage tracking)

price_unitstring

PriceUnit is the code of the price unit (e.g., 'btc', 'eth')

price_unit_amountstring

PriceUnitAmount is the amount of the price unit

price_unit_idstring

PriceUnitID is the id of the price unit (for CUSTOM type)

price_unit_type'FIAT' | 'CUSTOM'
sequenceinteger

Sequence is the monotonic stamp bumped on every state change that subscription line items need to react to. Read by the plan-price sync; set by the database (DEFAULT nextval) on create and by the price repository on termination / compatibility-affecting edits.

start_datestring date-time

StartDate is the start date of the price

status'published' | 'deleted' | 'archived'
tenant_idstring
tier_mode'VOLUME' | 'SLAB'
trial_period_daysinteger

TrialPeriodDays is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)

type'USAGE' | 'FIXED'
updated_atstring date-time
updated_bystring