On this page
No Headings
amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
descriptionstringThe description on the plan
invoice_display_namestringSpecifies the name that will appear on the invoice
namestringThe name of the plan
chargesarrayitemsobjectidrequiredstringUnique identifier of the charge
metric_idrequiredstringUnique identifier of the metric
charge_modelstring"STANDARD", "GRADUATED", "PACKAGE", "PERCENTAGE", "VOLUME""STANDARD"Defines the pricing model to calculate the charge
propertiesobjectPricing thresholds that determine the charges
taxesarrayList of tax entities configured for the usage based charge.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
min_amountobjectminimum_commitmentobjectMinimum commitment for this plan.
amountrequiredobjectinvoice_display_namestringSpecifies 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.
taxesarrayList of tax entities configured for the minimum commitment.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
idstringuuidUnique identifier of the minimum commitment, created by Lago.
plan_codestringThe unique code representing the plan to be attached to the customer.
created_atstringdate-timeThe 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.
updated_atstringdate-timeThe 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.
chargeUsagearrayitemsobjectidstringRefers to the charge usage threshold unique identifier
recurringstringIndicates if recurring invoices will be created
threshold_display_namestringIndicates the name for the usage threshold
created_atstringdate-timeDate and time in ISO 8601 format.
updated_atstringdate-timeDate and time in ISO 8601 format.
amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
taxesarrayList of tax entities configured for the plan.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
trial_periodintegerThe number of days the plan's base cost is provided at no charge