Create subscription

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_period

enum<string>

required

Available options:

MONTHLY,

ANNUAL,

WEEKLY,

DAILY

billing_period_count

integer

required

Required range: x > 1

currency

string

required

customer_id

string

required

invoice_cadence

enum<string>

required

Available options:

ARREAR,

ADVANCE

plan_id

string

required

start_date

string

required

end_date

string

lookup_key

string

metadata

object

trial_end

string

trial_start

string

Response

201 - application/json

billing_anchor

string

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.

billing_cadence

any

billing_period

any

billing_period_count

integer

BillingPeriodCount is the total number units of the billing period.

cancel_at

string

CancelAt is the date the subscription will be canceled

cancel_at_period_end

boolean

CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period

cancelled_at

string

CanceledAt is the date the subscription was canceled

created_at

string

created_by

string

currency

string

Currency is the currency of the subscription in lowercase 3 digit ISO codes

current_period_end

string

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.

current_period_start

string

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.

customer

object

customer_id

string

CustomerID is the identifier for the customer in our system

end_date

string

EndDate is the end date of the subscription

string

ID is the unique identifier for the subscription

invoice_cadence

any

line_items

object[]

lookup_key

string

LookupKey is the key used to lookup the subscription in our system

metadata

object

Metadata is a map of key-value pairs that can be attached to the subscription

plan

object

plan.created_at

string

plan.created_by

string

plan.description

string

plan.entitlements

object[]

plan.entitlements.created_at

string

plan.entitlements.created_by

string

plan.entitlements.feature

object

plan.entitlements.feature_id

string

plan.entitlements.feature_type

enum<string>

Available options:

metered,

boolean,

static

plan.entitlements.id

string

plan.entitlements.is_enabled

boolean

plan.entitlements.is_soft_limit

boolean

plan.entitlements.plan

object

plan.entitlements.plan.created_at

string

plan.entitlements.plan.created_by

string

plan.entitlements.plan.description

string

plan.entitlements.plan.entitlements

object[]

plan.entitlements.plan.id

string

plan.entitlements.plan.invoice_cadence

enum<string>

Available options:

ARREAR,

ADVANCE

plan.entitlements.plan.lookup_key

string

plan.entitlements.plan.name

string

plan.entitlements.plan.prices

object[]

plan.entitlements.plan.prices.amount

number

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

plan.entitlements.plan.prices.billing_cadence

any

plan.entitlements.plan.prices.billing_model

any

plan.entitlements.plan.prices.billing_period

any

plan.entitlements.plan.prices.billing_period_count

integer

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

plan.entitlements.plan.prices.created_at

string

plan.entitlements.plan.prices.created_by

string

plan.entitlements.plan.prices.currency

string

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

plan.entitlements.plan.prices.description

string

Description of the price

plan.entitlements.plan.prices.display_amount

string

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

plan.entitlements.plan.prices.filter_values

object

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

plan.entitlements.plan.prices.id

string

ID uuid identifier for the price

plan.entitlements.plan.prices.lookup_key

string

LookupKey used for looking up the price in the database

plan.entitlements.plan.prices.metadata

object

Metadata is a jsonb field for additional information

plan.entitlements.plan.prices.meter

object

plan.entitlements.plan.prices.meter_id

string

MeterID is the id of the meter for usage based pricing

plan.entitlements.plan.prices.plan_id

string

PlanID is the id of the plan for plan based pricing

plan.entitlements.plan.prices.status

enum<string>

Available options:

published,

deleted,

archived

plan.entitlements.plan.prices.tenant_id

string

plan.entitlements.plan.prices.tier_mode

any

plan.entitlements.plan.prices.tiers

object[]

Tiers are the tiers for the price when BillingModel is TIERED

plan.entitlements.plan.prices.transform_quantity

object

Transform is the quantity transformation in case of PACKAGE billing model

plan.entitlements.plan.prices.type

any

plan.entitlements.plan.prices.updated_at

string

plan.entitlements.plan.prices.updated_by

string

plan.entitlements.plan.status

enum<string>

Available options:

published,

deleted,

archived

plan.entitlements.plan.tenant_id

string

plan.entitlements.plan.trial_period

integer

plan.entitlements.plan.updated_at

string

plan.entitlements.plan.updated_by

string

plan.entitlements.plan_id

string

plan.entitlements.static_value

string

plan.entitlements.status

enum<string>

Available options:

published,

deleted,

archived

plan.entitlements.tenant_id

string

plan.entitlements.updated_at

string

plan.entitlements.updated_by

string

plan.entitlements.usage_limit

integer

plan.entitlements.usage_reset_period

enum<string>

Available options:

MONTHLY,

ANNUAL,

WEEKLY,

DAILY

plan.id

string

plan.invoice_cadence

enum<string>

Available options:

ARREAR,

ADVANCE

plan.lookup_key

string

plan.name

string

plan.prices

object[]

plan.prices.amount

number

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

plan.prices.billing_cadence

any

plan.prices.billing_model

any

plan.prices.billing_period

any

plan.prices.billing_period_count

integer

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

plan.prices.created_at

string

plan.prices.created_by

string

plan.prices.currency

string

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

plan.prices.description

string

Description of the price

plan.prices.display_amount

string

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

plan.prices.filter_values

object

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

plan.prices.id

string

ID uuid identifier for the price

plan.prices.lookup_key

string

LookupKey used for looking up the price in the database

plan.prices.metadata

object

Metadata is a jsonb field for additional information

plan.prices.meter

object

plan.prices.meter_id

string

MeterID is the id of the meter for usage based pricing

plan.prices.plan_id

string

PlanID is the id of the plan for plan based pricing

plan.prices.status

enum<string>

Available options:

published,

deleted,

archived

plan.prices.tenant_id

string

plan.prices.tier_mode

any

plan.prices.tiers

object[]

Tiers are the tiers for the price when BillingModel is TIERED

plan.prices.transform_quantity

object

Transform is the quantity transformation in case of PACKAGE billing model

plan.prices.type

any

plan.prices.updated_at

string

plan.prices.updated_by

string

plan.status

enum<string>

Available options:

published,

deleted,

archived

plan.tenant_id

string

plan.trial_period

integer

plan.updated_at

string

plan.updated_by

string

plan_id

string

PlanID is the identifier for the plan in our system

start_date

string

StartDate is the start date of the subscription

status

enum<string>

Available options:

published,

deleted,

archived

subscription_status

any

tenant_id

string

trial_end

string

TrialEnd is the end date of the trial period

trial_start

string

TrialStart is the start date of the trial period

updated_at

string

updated_by

string

version

integer

Version is used for optimistic locking

API Documentation

Auth

Customers

Invoices

Wallets

Entitlements

Environments

Events

Features

Meters

Plans

Prices

Subscriptions

Tenants

Users

Create subscription

Authorizations

Body

Response