API Documentation
Customers
Invoices
Wallets
Entitlements
Environments
Features
Meters
Plans
Subscriptions
Users
List subscriptions
Get subscriptions with optional filtering
Authorizations
Enter your API key in the format x-api-key <api-key>*
Query Parameters
Filter by customer ID
Filter by subscription status
Filter by plan ID
Offset for pagination
Limit for pagination
Response
BillingAnchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
BillingPeriodCount is the total number units of the billing period.
CancelAt is the date the subscription will be canceled
CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period
CanceledAt is the date the subscription was canceled
Currency is the currency of the subscription in lowercase 3 digit ISO codes
CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
CurrentPeriodStart is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
AddressCity is the city of the customer's address
AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)
AddressLine1 is the first line of the customer's address
AddressLine2 is the second line of the customer's address
AddressPostalCode is the postal code of the customer's address
AddressState is the state of the customer's address
Email is the email of the customer
ExternalID is the external identifier for the customer
ID is the unique identifier for the customer
Name is the name of the customer
published, deleted, archived CustomerID is the identifier for the customer in our system
EndDate is the end date of the subscription
ID is the unique identifier for the subscription
MONTHLY, ANNUAL, WEEKLY, DAILY USAGE, FIXED published, deleted, archived LookupKey is the key used to lookup the subscription in our system
Metadata is a map of key-value pairs that can be attached to the subscription
published, deleted, archived metered, boolean, static metered, boolean, static ARREAR, ADVANCE 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
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 PlanID is the identifier for the plan in our system
StartDate is the start date of the subscription
published, deleted, archived TrialEnd is the end date of the trial period
TrialStart is the start date of the trial period
Version is used for optimistic locking