The plan object

This object represents a plan. This plan can then be assigned to a customer.

The plan object

{
  "plan": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Startup",
    "invoice_display_name": "Startup plan",
    "created_at": "2023-06-27T19:43:42Z",
    "code": "startup",
    "interval": "monthly",
    "description": "",
    "amount_cents": 10000,
    "amount_currency": "USD",
    "trial_period": 5,
    "pay_in_advance": true,
    "bill_charges_monthly": null,
    "active_subscriptions_count": 0,
    "draft_invoices_count": 0,
    "minimum_commitment": {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "plan_code": "premium",
      "amount_cents": 100000,
      "invoice_display_name": "Minimum Commitment (C1)",
      "interval": "monthly",
      "created_at": "2022-04-29T08:59:51Z",
      "updated_at": "2022-04-29T08:59:51Z",
      "taxes": [
        {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "name": "TVA",
          "code": "french_standard_vat",
          "description": "French standard VAT",
          "rate": 20,
          "applied_to_organization": true,
          "add_ons_count": 0,
          "charges_count": 0,
          "customers_count": 0,
          "plans_count": 0,
          "created_at": "2023-07-06T14:35:58Z"
        }
      ]
    },
    "charges": [
      {
        "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,
        "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,
        "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,
        "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,
        "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,
        "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": []
      }
    ],
    "taxes": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "TVA",
        "code": "french_standard_vat",
        "description": "French standard VAT",
        "rate": 20,
        "applied_to_organization": true,
        "add_ons_count": 0,
        "charges_count": 0,
        "customers_count": 0,
        "plans_count": 0,
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}

Attributes

plan · object

Hide object

lago_id · string · required

Unique identifier of the plan created by Lago.

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.

name · string · required

The name of the 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.

interval · 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: weekly, monthly, quarterly or yearly.

description · string

The description on the 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.

amount_currency · 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.

trial_period · float

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

pay_in_advance · boolean · required

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.

bill_charges_monthly · boolean

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.

tax_code · string

List of unique code used to identify the taxes.

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.

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.

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.

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.

minimum_commitment · object

Show minimum_commitment

lago_id · string · required

Unique identifier of charge, created by Lago.

plan_code · string

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

amount_cents · integer · required

The amount of the minimum commitment in cents.

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.

interval · string

The interval used for recurring billing. It represents the frequency at which minimum commitment billing occurs. Available options: weekly, monthly, quarterly, yearly.

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

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.

taxes · object[]

All taxes applied to the minimum commitment.

charges · array

Show charges

lago_id · string · required

Unique identifier of the minimum commitment, created by Lago.

lago_billable_metric_id · string · required

Unique identifier of the billable metric created by Lago.

billable_metric_code · string · required

Unique code identifying a billable metric.

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.

charge_model · string · required

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

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.

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.

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.

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.

prorated · boolean · required

Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. If not defined, this argument is set to false by default. - 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. Note that only a charge_model sets to standard, graduated and volume can be prorated.

tax_code · string

List of unique code used to identify the taxes.

properties · JSON

Show child attributes

Case of groups and dimensions

group_properties · array

Show child attributes

invoice_display_name · string

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.

values · string

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

Case of graduated pricing model

graduated_ranges · array · required

Show child attributes

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.

to_value · integer · 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.

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.

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.

Case of package pricing model

amount · string · required

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

package_size · integer · required

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.

free_units · integer · required

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.

Case of percentage pricing model

rate · string · required

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

fixed_amount · string

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

free_units_per_events · integer

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.

free_units_per_total_aggregation · integer

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.

per_transaction_min_amount · string

Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. Cannot be greater than the per_transaction_max_amount value.

per_transaction_max_amount · string

Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. Cannot be lower than the per_transaction_min_amount value.

Case of volume pricing model

volume_ranges · array · required

Show child attributes

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.

to_value · integer · 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.

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.

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.

Case of graduated percentage pricing model

graduated_percentage_ranges · array · required

Show child attributes

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.

to_value · integer · 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.

rate · string · required

The percentage rate that is applied to the amount of each transaction for a graduated percentage charge model. It is expressed as a decimal value, and only set for a specific tier.

flat_amount · string · required

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

Case of standard pricing model

amount · string · required

The unit price, excluding tax, for a standard charge model. It is expressed as a decimal value.

grouped_by · array

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