The subscription object

lago_id

string

required

Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system

external_id

string

required

The subscription external unique identifier (provided by your own application).

lago_customer_id

string

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

external_customer_id

string

required

The customer external unique identifier (provided by your own application).

billing_time

enum<string>

required

The billing time for the subscription, which can be set as either anniversary or calendar. If not explicitly provided, it will default to calendar. The billing time determines the timing of recurring billing cycles for the subscription. By specifying anniversary, the billing cycle will be based on the specific date the subscription started (billed fully), while calendar sets the billing cycle at the first day of the week/month/year (billed with proration).

Available options:

calendar,

anniversary

name

string | null

The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.

plan_code

string

required

The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans.

status

enum<string>

required

The status of the subscription, which can have the following values:

pending: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period.
active: the subscription is currently active and applied to the customer.
terminated: the subscription is no longer active.
canceled: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.

Available options:

active,

pending,

terminated,

canceled

created_at

string

required

The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.

canceled_at

string | null

The cancellation date of the subscription. This field is not null when the subscription is canceled. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

started_at

string | null

The effective start date of the subscription. This field can be null if the subscription is pending or canceled. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

ending_at

string

The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).

subscription_at

string

required

The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with anniversary billing time. The anniversary_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

terminated_at

string | null

The termination date of the subscription. This field is not null when the subscription is terminated. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC)

previous_plan_code

string | null

The code identifying the previous plan associated with this subscription.

next_plan_code

string | null

The code identifying the next plan in the case of a downgrade.

downgrade_plan_date

string | null

The date when the plan will be downgraded, represented in ISO 8601 date format.

trial_ended_at

string | null

The date when the free trial is ended, represented in ISO 8601 date format.

plan

object

plan.lago_id

string

required

Unique identifier of the plan created by Lago.

plan.name

string

required

The name of the plan.

plan.invoice_display_name

string

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.

plan.created_at

string

required

The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created.

plan.code

string

required

The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.

plan.interval

enum<string>

required

The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: yearly, quarterly, monthly or weekly.

Available options:

weekly,

monthly,

quarterly,

yearly

plan.description

string

The description on the plan.

plan.amount_cents

integer

required

The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.

plan.amount_currency

enum<string>

required

The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

plan.trial_period

number

The duration in days during which the base cost of the plan is offered for free.

plan.pay_in_advance

boolean

This field determines the billing timing for the plan. When set to true, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to false, the base cost of the plan is due at the end of each billing period.

plan.bill_charges_monthly

boolean | null

This field, when set to true, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is yearly.

plan.active_subscriptions_count

integer

required

The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted.

plan.draft_invoices_count

integer

required

The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted.

plan.minimum_commitment

object | null

plan.minimum_commitment.lago_id

string

required

Unique identifier of the minimum commitment, created by Lago.

plan.minimum_commitment.plan_code

string

The unique code representing the plan to be attached to the customer.

plan.minimum_commitment.amount_cents

integer

required

The amount of the minimum commitment in cents.

plan.minimum_commitment.invoice_display_name

string

Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.

plan.minimum_commitment.interval

enum<string>

The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: yearly, quarterly, monthly or weekly.

Available options:

weekly,

monthly,

quarterly,

yearly

plan.minimum_commitment.created_at

string

required

The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

plan.minimum_commitment.updated_at

string

The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.

plan.minimum_commitment.taxes

object[]

All taxes applied to the minimum commitment.

plan.charges

object[]

Additional usage-based charges for this plan.

plan.charges.lago_id

string

required

Unique identifier of charge, created by Lago.

plan.charges.lago_billable_metric_id

string

required

Unique identifier of the billable metric created by Lago.

plan.charges.billable_metric_code

string

required

Unique code identifying a billable metric.

plan.charges.invoice_display_name

string

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.

plan.charges.created_at

string

required

The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard.

plan.charges.charge_model

enum<string>

required

Specifies the pricing model used for the calculation of the final fee. It can be standard, graduated, graduated_percentage, package, percentage or volume.

Available options:

standard,

graduated,

graduated_percentage,

package,

percentage,

volume

plan.charges.pay_in_advance

boolean

This field determines the billing timing for this specific usage-based charge. When set to true, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.

plan.charges.invoiceable

boolean

This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to false when pay_in_advance is true.

plan.charges.regroup_paid_fees

enum<string> | null

This setting can only be configured if pay_in_advance is true and invoiceable is false. This field determines whether and when the charge fee should be included in the invoice. If null, no invoice will be issued for this charge fee. If invoice, an invoice will be generated at the end of the period, consolidating all charge fees with a succeeded payment status.

Available options:

invoice

plan.charges.prorated

boolean

Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.

If set to true, the charge is prorated based on the remaining days in the current billing period.
If set to false, the charge is billed in full.
If not defined in the request, default value is false.

plan.charges.min_amount_cents

integer

The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.

plan.charges.properties

object

List of all thresholds utilized for calculating the charge.

plan.charges.properties.graduated_ranges

object[]

Graduated ranges, sorted from bottom to top tiers, used for a graduated charge model.

plan.charges.properties.graduated_percentage_ranges

object[]

Graduated percentage ranges, sorted from bottom to top tiers, used for a graduated_percentage charge model.

plan.charges.properties.amount

string

The unit price, excluding tax, for a standard charge model. It is expressed as a decimal value.
The amount, excluding tax, for a complete set of units in a package charge model. It is expressed as a decimal value.

plan.charges.properties.free_units

integer

The quantity of units that are provided free of charge for each billing period in a package charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.

plan.charges.properties.package_size

integer

The quantity of units included in each pack or set for a package charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.

plan.charges.properties.rate

string

The percentage rate that is applied to the amount of each transaction for a percentage charge model. It is expressed as a decimal value.

plan.charges.properties.fixed_amount

string

The fixed fee that is applied to each transaction for a percentage charge model. It is expressed as a decimal value.

plan.charges.properties.free_units_per_events

integer | null

The count of transactions that are not impacted by the percentage rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.

plan.charges.properties.free_units_per_total_aggregation

string | null

The transaction amount that is not impacted by the percentage rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.

plan.charges.properties.per_transaction_max_amount

string | null

Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.

plan.charges.properties.per_transaction_min_amount

string | null

Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.

plan.charges.properties.grouped_by

string[]

The list of event properties that are used to group the events on the invoice for a standard charge model.

plan.charges.properties.volume_ranges

object[]

Volume ranges, sorted from bottom to top tiers, used for a volume charge model.

plan.charges.filters

object[]

List of filters used to apply differentiated pricing based on additional event properties.

plan.charges.filters.invoice_display_name

string | null

required

Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.

plan.charges.filters.properties

object

required

List of all thresholds utilized for calculating the charge.

plan.charges.filters.properties.graduated_ranges

object[]

Graduated ranges, sorted from bottom to top tiers, used for a graduated charge model.

plan.charges.filters.properties.graduated_percentage_ranges

object[]

Graduated percentage ranges, sorted from bottom to top tiers, used for a graduated_percentage charge model.

plan.charges.filters.properties.amount

string

The unit price, excluding tax, for a standard charge model. It is expressed as a decimal value.
The amount, excluding tax, for a complete set of units in a package charge model. It is expressed as a decimal value.

plan.charges.filters.properties.free_units

integer

The quantity of units that are provided free of charge for each billing period in a package charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.

plan.charges.filters.properties.package_size

integer

The quantity of units included in each pack or set for a package charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.

plan.charges.filters.properties.rate

string

The percentage rate that is applied to the amount of each transaction for a percentage charge model. It is expressed as a decimal value.

plan.charges.filters.properties.fixed_amount

string

The fixed fee that is applied to each transaction for a percentage charge model. It is expressed as a decimal value.

plan.charges.filters.properties.free_units_per_events

integer | null

The count of transactions that are not impacted by the percentage rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.

plan.charges.filters.properties.free_units_per_total_aggregation

string | null

The transaction amount that is not impacted by the percentage rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.

plan.charges.filters.properties.per_transaction_max_amount

string | null

Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.

plan.charges.filters.properties.per_transaction_min_amount

string | null

Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.

plan.charges.filters.properties.grouped_by

string[]

The list of event properties that are used to group the events on the invoice for a standard charge model.

plan.charges.filters.properties.volume_ranges

object[]

Volume ranges, sorted from bottom to top tiers, used for a volume charge model.

plan.charges.filters.values

object

required

List of possible filter values. The key and values must match one of the billable metric filters.

plan.charges.taxes

object[]

All taxes applied to the charge.

plan.taxes

object[]

All taxes applied to the plan.

API Reference