List all plans

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

Response

Plans

plans

object[]

required

Show child attributes

plans.lago_id

string<uuid>

required

Unique identifier of the plan created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.name

string

required

The name of the plan.

Example:

"Startup"

plans.created_at

string<date-time>

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.

Example:

"2023-06-27T19:43:42Z"

plans.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.

Example:

"startup"

plans.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, semiannual, quarterly, monthly or weekly.

Available options:

weekly,

monthly,

quarterly,

semiannual,

yearly

Example:

"monthly"

plans.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.

Example:

10000

plans.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,

GHS,

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

Example:

"USD"

plans.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.

Example:

"Startup plan"

plans.description

string

The description on the plan.

Example:

""

plans.trial_period

number

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

Example:

5

plans.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.

Example:

true

plans.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 or semiannual. 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 or semiannual.

Example:

null

plans.minimum_commitment

object

Show child attributes

plans.minimum_commitment.lago_id

string<uuid>

required

Unique identifier of the minimum commitment, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.minimum_commitment.amount_cents

integer

required

The amount of the minimum commitment in cents.

Example:

100000

plans.minimum_commitment.created_at

string<date-time>

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.

Example:

"2022-04-29T08:59:51Z"

plans.minimum_commitment.plan_code

string

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

Example:

"premium"

plans.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.

Example:

"Minimum Commitment (C1)"

plans.minimum_commitment.interval

enum<string>

Available options:

weekly,

monthly,

quarterly,

semiannual,

yearly

Example:

"monthly"

plans.minimum_commitment.updated_at

string<date-time>

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.

Example:

"2022-04-29T08:59:51Z"

plans.minimum_commitment.taxes

object[]

All taxes applied to the minimum commitment.

Show child attributes

plans.minimum_commitment.taxes.lago_id

string<uuid>

required

Unique identifier of the tax, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.minimum_commitment.taxes.name

string

required

Name of the tax.

Example:

"TVA"

plans.minimum_commitment.taxes.code

string

required

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

plans.minimum_commitment.taxes.rate

number

required

The percentage rate of the tax

Example:

20

plans.minimum_commitment.taxes.applied_to_organization

boolean

required

deprecated

This field is deprecated and will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the PUT /billing_entities/:code endpoint instead.

Example:

true

plans.minimum_commitment.taxes.created_at

string<date-time>

required

Creation date of the tax.

Example:

"2023-07-06T14:35:58Z"

plans.minimum_commitment.taxes.description

string | null

Internal description of the tax

Example:

"French standard VAT"

plans.charges

object[]

Additional usage-based charges for this plan.

Show child attributes

plans.charges.lago_id

string<uuid>

required

Unique identifier of charge, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.charges.lago_billable_metric_id

string<uuid>

required

Unique identifier of the billable metric created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.charges.billable_metric_code

string

required

Unique code identifying a billable metric.

Example:

"requests"

plans.charges.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 name of the actual charge will be used as the default display name.

Example:

"Setup"

plans.charges.created_at

string<date-time>

required

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

Example:

"2022-09-14T16:35:31Z"

plans.charges.charge_model

enum<string>

required

Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:

Available options:

dynamic,

graduated,

graduated_percentage,

package,

percentage,

standard,

volume

plans.charges.pay_in_advance

boolean

required

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.

Example:

true

plans.charges.invoiceable

boolean

required

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.

Example:

true

plans.charges.regroup_paid_fees

enum<string> | null

required

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

Example:

"invoice"

plans.charges.prorated

boolean

required

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.

Example:

false

plans.charges.min_amount_cents

integer

required

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.

Example:

1200

plans.charges.properties

object

required

List of all thresholds utilized for calculating the charge.

Show child attributes

plans.charges.properties.grouped_by

string[]

deprecated

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

Example:

["agent_name"]

plans.charges.properties.pricing_group_keys

string[]

The list of event properties that are used to group the events on the invoice.

Example:

["agent_name"]

plans.charges.properties.graduated_ranges

object[]

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

Show child attributes

plans.charges.properties.graduated_ranges.from_value

integer

required

Specifies the lower value of a tier for a graduated charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.properties.graduated_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a graduated charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.properties.graduated_ranges.flat_amount

string

required

The flat amount for a whole tier, excluding tax, for a graduated charge model. It is expressed as a decimal value.

Example:

"10"

plans.charges.properties.graduated_ranges.per_unit_amount

string

required

The unit price, excluding tax, for a specific tier of a graduated charge model. It is expressed as a decimal value.

Example:

"0.5"

plans.charges.properties.graduated_percentage_ranges

object[]

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

Show child attributes

plans.charges.properties.graduated_percentage_ranges.from_value

integer

required

Specifies the lower value of a tier for a graduated_percentage charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.properties.graduated_percentage_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a graduated_percentage charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.properties.graduated_percentage_ranges.rate

string<^[0-9]+.?[0-9]*$>

required

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

Example:

"1"

plans.charges.properties.graduated_percentage_ranges.flat_amount

string<^[0-9]+.?[0-9]*$>

required

The flat amount for a whole tier, excluding tax, for a graduated_percentage charge model. It is expressed as a decimal value.

Example:

"10"

plans.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.

Example:

"30"

plans.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.

Example:

100

plans.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.

Example:

1000

plans.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.

Example:

"1"

plans.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.

Example:

"0.5"

plans.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.

Example:

5

plans.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.

Example:

"500"

plans.charges.properties.per_transaction_max_amount

string<^[0-9]+.?[0-9]*$> | null

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

Example:

"3.75"

plans.charges.properties.per_transaction_min_amount

string<^[0-9]+.?[0-9]*$> | null

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

Example:

"1.75"

plans.charges.properties.volume_ranges

object[]

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

Show child attributes

plans.charges.properties.volume_ranges.from_value

integer

required

Specifies the lower value of a tier for a volume charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.properties.volume_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a volume charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.properties.volume_ranges.flat_amount

string

required

The flat amount for a whole tier, excluding tax, for a volume charge model. It is expressed as a decimal value.

Example:

"10"

plans.charges.properties.volume_ranges.per_unit_amount

string

required

The unit price, excluding tax, for a specific tier of a volume charge model. It is expressed as a decimal value.

Example:

"0.5"

plans.charges.filters

object[]

required

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

Show child attributes

plans.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.

Example:

"AWS"

plans.charges.filters.properties

object

required

List of all thresholds utilized for calculating the charge.

Show child attributes

plans.charges.filters.properties.grouped_by

string[]

deprecated

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

Example:

["agent_name"]

plans.charges.filters.properties.pricing_group_keys

string[]

The list of event properties that are used to group the events on the invoice.

Example:

["agent_name"]

plans.charges.filters.properties.graduated_ranges

object[]

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

Show child attributes

plans.charges.filters.properties.graduated_ranges.from_value

integer

required

Specifies the lower value of a tier for a graduated charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.filters.properties.graduated_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a graduated charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.filters.properties.graduated_ranges.flat_amount

string

required

The flat amount for a whole tier, excluding tax, for a graduated charge model. It is expressed as a decimal value.

Example:

"10"

plans.charges.filters.properties.graduated_ranges.per_unit_amount

string

required

The unit price, excluding tax, for a specific tier of a graduated charge model. It is expressed as a decimal value.

Example:

"0.5"

plans.charges.filters.properties.graduated_percentage_ranges

object[]

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

Show child attributes

plans.charges.filters.properties.graduated_percentage_ranges.from_value

integer

required

Specifies the lower value of a tier for a graduated_percentage charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.filters.properties.graduated_percentage_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a graduated_percentage charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.filters.properties.graduated_percentage_ranges.rate

string<^[0-9]+.?[0-9]*$>

required

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

Example:

"1"

plans.charges.filters.properties.graduated_percentage_ranges.flat_amount

string<^[0-9]+.?[0-9]*$>

required

The flat amount for a whole tier, excluding tax, for a graduated_percentage charge model. It is expressed as a decimal value.

Example:

"10"

plans.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.

Example:

"30"

plans.charges.filters.properties.free_units

integer

Example:

100

plans.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.

Example:

1000

plans.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.

Example:

"1"

plans.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.

Example:

"0.5"

plans.charges.filters.properties.free_units_per_events

integer | null

Example:

5

plans.charges.filters.properties.free_units_per_total_aggregation

string | null

Example:

"500"

plans.charges.filters.properties.per_transaction_max_amount

string<^[0-9]+.?[0-9]*$> | null

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

Example:

"3.75"

plans.charges.filters.properties.per_transaction_min_amount

string<^[0-9]+.?[0-9]*$> | null

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

Example:

"1.75"

plans.charges.filters.properties.volume_ranges

object[]

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

Show child attributes

plans.charges.filters.properties.volume_ranges.from_value

integer

required

Specifies the lower value of a tier for a volume charge model. It must be either 0 or the previous range's to_value + 1 to maintain the proper sequence of values.

Example:

0

plans.charges.filters.properties.volume_ranges.to_value

integer | null

required

Specifies the highest value of a tier for a volume charge model.

This value must be higher than the from_value of the same tier.
This value must be null for the last tier.

Example:

10

plans.charges.filters.properties.volume_ranges.flat_amount

string

required

The flat amount for a whole tier, excluding tax, for a volume charge model. It is expressed as a decimal value.

Example:

"10"

plans.charges.filters.properties.volume_ranges.per_unit_amount

string

required

The unit price, excluding tax, for a specific tier of a volume charge model. It is expressed as a decimal value.

Example:

"0.5"

plans.charges.filters.values

object

required

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

Show child attributes

plans.charges.filters.values.{key}

string[]

Example:

{ "region": ["us-east-1"] }

plans.charges.taxes

object[]

All taxes applied to the charge.

Show child attributes

plans.charges.taxes.lago_id

string<uuid>

required

Unique identifier of the tax, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.charges.taxes.name

string

required

Name of the tax.

Example:

"TVA"

plans.charges.taxes.code

string

required

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

plans.charges.taxes.rate

number

required

The percentage rate of the tax

Example:

20

plans.charges.taxes.applied_to_organization

boolean

required

deprecated

Example:

true

plans.charges.taxes.created_at

string<date-time>

required

Creation date of the tax.

Example:

"2023-07-06T14:35:58Z"

plans.charges.taxes.description

string | null

Internal description of the tax

Example:

"French standard VAT"

plans.charges.applied_pricing_unit

object

The pricing unit applied to the charge.

Show child attributes

plans.charges.applied_pricing_unit.code

string

required

The code of the pricing unit.

Example:

"unit_code"

plans.charges.applied_pricing_unit.conversion_rate

string

required

The conversion rate from pricing units to the plan's currency.

Example:

"0.5"

Example:

[
  {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
    "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
    "billable_metric_code": "requests",
    "created_at": "2023-06-27T19:43:42Z",
    "charge_model": "package",
    "invoiceable": true,
    "invoice_display_name": "Setup",
    "pay_in_advance": false,
    "regroup_paid_fees": null,
    "prorated": false,
    "min_amount_cents": 3000,
    "properties": {
      "amount": "30",
      "free_units": 100,
      "package_size": 1000
    },
    "filters": []
  },
  {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a92",
    "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a92",
    "billable_metric_code": "cpu",
    "created_at": "2023-06-27T19:43:42Z",
    "charge_model": "graduated",
    "invoiceable": true,
    "invoice_display_name": "Setup",
    "pay_in_advance": false,
    "regroup_paid_fees": null,
    "prorated": false,
    "min_amount_cents": 0,
    "properties": {
      "graduated_ranges": [
        {
          "from_value": 0,
          "to_value": 10,
          "flat_amount": "10",
          "per_unit_amount": "0.5"
        },
        {
          "from_value": 11,
          "to_value": null,
          "flat_amount": "0",
          "per_unit_amount": "0.4"
        }
      ]
    },
    "filters": []
  },
  {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a93",
    "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a93",
    "billable_metric_code": "seats",
    "created_at": "2023-06-27T19:43:42Z",
    "charge_model": "standard",
    "invoiceable": true,
    "invoice_display_name": "Setup",
    "pay_in_advance": true,
    "regroup_paid_fees": null,
    "prorated": false,
    "min_amount_cents": 0,
    "properties": {},
    "filters": [
      {
        "invoice_display_name": "Europe",
        "properties": { "amount": "10" },
        "values": { "region": ["Europe"] }
      },
      {
        "invoice_display_name": "USA",
        "properties": { "amount": "5" },
        "values": { "region": ["USA"] }
      },
      {
        "invoice_display_name": "Africa",
        "properties": { "amount": "8" },
        "values": { "region": ["Africa"] }
      }
    ]
  },
  {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a94",
    "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a94",
    "billable_metric_code": "storage",
    "created_at": "2023-06-27T19:43:42Z",
    "charge_model": "volume",
    "invoiceable": true,
    "invoice_display_name": "Setup",
    "pay_in_advance": false,
    "regroup_paid_fees": null,
    "prorated": false,
    "min_amount_cents": 0,
    "properties": {
      "volume_ranges": [
        {
          "from_value": 0,
          "to_value": 100,
          "flat_amount": "0",
          "per_unit_amount": "0"
        },
        {
          "from_value": 101,
          "to_value": null,
          "flat_amount": "0",
          "per_unit_amount": "0.5"
        }
      ]
    },
    "filters": []
  },
  {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
    "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
    "billable_metric_code": "payments",
    "created_at": "2023-06-27T19:43:42Z",
    "charge_model": "percentage",
    "invoiceable": false,
    "invoice_display_name": "Setup",
    "pay_in_advance": true,
    "regroup_paid_fees": "invoice",
    "prorated": false,
    "min_amount_cents": 0,
    "properties": {
      "rate": "1",
      "fixed_amount": "0.5",
      "free_units_per_events": 5,
      "free_units_per_total_aggregation": "500"
    },
    "filters": []
  }
]

plans.taxes

object[]

All taxes applied to the plan.

Show child attributes

plans.taxes.lago_id

string<uuid>

required

Unique identifier of the tax, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.taxes.name

string

required

Name of the tax.

Example:

"TVA"

plans.taxes.code

string

required

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

plans.taxes.rate

number

required

The percentage rate of the tax

Example:

20

plans.taxes.applied_to_organization

boolean

required

deprecated

Example:

true

plans.taxes.created_at

string<date-time>

required

Creation date of the tax.

Example:

"2023-07-06T14:35:58Z"

plans.taxes.description

string | null

Internal description of the tax

Example:

"French standard VAT"

plans.usage_thresholds

object[]

List of usage thresholds applied to the plan.

Show child attributes

plans.usage_thresholds.lago_id

string<uuid>

required

Unique identifier of the usage threshold created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plans.usage_thresholds.threshold_display_name

string | null

required

The display name of the usage threshold.

Example:

"Threshold 1"

plans.usage_thresholds.amount_cents

integer

required

The amount to reach to trigger a progressive_billing invoice.

Example:

10000

plans.usage_thresholds.recurring

boolean

required

This field when set to true indicates that a progressive_billing invoice will be created every time the lifetime usage increases by the specified amount.

Example:

true

plans.usage_thresholds.created_at

string<date-time>

required

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

Example:

"2023-06-27T19:43:42Z"

plans.usage_thresholds.updated_at

string<date-time>

required

The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard.

Example:

"2023-06-27T19:43:42Z"

plans.entitlements

object[]

List of all feature entitlements and their privileges available for this plan.

Show child attributes

plans.entitlements.entitlement

object

required

Show child attributes

plans.entitlements.entitlement.code

string

required

Unique code used to identify the feature. Max 255 characters.

Example:

"seats"

plans.entitlements.entitlement.name

string | null

required

Name of the feature. Max 255 characters.

Example:

"Number of seats"

plans.entitlements.entitlement.description

string | null

required

Description of the feature. Max 600 characters.

Example:

"Number of users of the account"

plans.entitlements.entitlement.privileges

object[]

required

Privileges associated with this feature. Each privilege must have a value assigned.

Show child attributes

plans.entitlements.entitlement.privileges.code

string

required

Unique code for the privilege.

Example:

"max"

plans.entitlements.entitlement.privileges.name

string | null

required

Display name for the privilege.

Example:

"Maximum"

plans.entitlements.entitlement.privileges.value_type

enum<string>

required

Data type of the privilege value. Default: string

Available options:

integer,

boolean,

string,

select

Example:

"integer"

plans.entitlements.entitlement.privileges.config

object

required

Show child attributes

plans.entitlements.entitlement.privileges.config.select_options

string[]

Array of string, required only when value_type is select.

Example:

["google", "okta"]

plans.entitlements.entitlement.privileges.value

required

Value assigned to this privilege in the entitlement. Type depends on the privilege's value_type.

Example:

10

Example:

[
  {
    "code": "max",
    "name": "Maximum",
    "value_type": "integer",
    "config": {},
    "value": 10
  },
  {
    "code": "max_admins",
    "name": "Max Admins",
    "value_type": "integer",
    "config": {},
    "value": 5
  },
  {
    "code": "root",
    "name": "Allow root user",
    "value_type": "boolean",
    "config": {},
    "value": true
  },
  {
    "code": "provider",
    "name": "SSO Provider",
    "value_type": "select",
    "value": "google",
    "config": { "select_options": ["google", "okta"] }
  }
]

API Reference

Authorizations

Query Parameters

Response