API Documentation
Customers
Invoices
Wallets
Entitlements
Environments
Features
Meters
Plans
Subscriptions
Users
Create a new entitlement
Create a new entitlement with the specified configuration
Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
metered, boolean, static MONTHLY, ANNUAL, WEEKLY, DAILY Response
Key is the key for the filter from $event.properties Currently we support only first level keys in the properties and not nested keys
Values are the possible values for the filter to be considered for the meter For ex "model_name" could have values "o1-mini", "gpt-4o" etc
BILLING_PERIOD, NEVER published, deleted, archived metered, boolean, static metered, boolean, static BILLING_PERIOD, NEVER published, deleted, archived metered, boolean, static metered, boolean, static metered, boolean, static published, deleted, archived MONTHLY, ANNUAL, WEEKLY, DAILY ARREAR, ADVANCE Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
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
FilterValues are the filter values for the price in case of usage based pricing
ID uuid identifier for the price
LookupKey used for looking up the price in the database
Metadata is a jsonb field for additional information
MeterID is the id of the meter for usage based pricing
PlanID is the id of the plan for plan based pricing
published, deleted, archived Tiers are the tiers for the price when BillingModel is TIERED
Transform is the quantity transformation in case of PACKAGE billing model
published, deleted, archived published, deleted, archived MONTHLY, ANNUAL, WEEKLY, DAILY ARREAR, ADVANCE Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
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
FilterValues are the filter values for the price in case of usage based pricing
ID uuid identifier for the price
LookupKey used for looking up the price in the database
Metadata is a jsonb field for additional information
Key is the key for the filter from $event.properties Currently we support only first level keys in the properties and not nested keys
Values are the possible values for the filter to be considered for the meter For ex "model_name" could have values "o1-mini", "gpt-4o" etc
BILLING_PERIOD, NEVER MeterID is the id of the meter for usage based pricing
PlanID is the id of the plan for plan based pricing
published, deleted, archived Tiers are the tiers for the price when BillingModel is TIERED
FlatAmount is the flat amount for the given tier and it is applied on top of the unit amount*quantity. It solves cases in banking like 2.7% + 5c
UnitAmount is the amount per unit for the given tier
Upto is the quantity up to which this tier applies. It is null for the last tier
published, deleted, archived published, deleted, archived MONTHLY, ANNUAL, WEEKLY, DAILY