{
  "plan": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Startup",
    "created_at": "2023-06-27T19:43:42Z",
    "code": "startup",
    "interval": "monthly",
    "description": null,
    "amount_cents": 1000,
    "amount_currency": "USD",
    "trial_period": 10,
    "pay_in_advance": true,
    "bill_charges_monthly": null,
    "active_subscriptions_count": 0,
    "draft_invoices_count": 0,
    "invoice_display_name": "",
    "charges": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a92",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a92",
        "billable_metric_code": "api_request",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "graduated",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "graduated_ranges": [
            {
              "from_value": 0,
              "to_value": 10000,
              "per_unit_amount": "0.02",
              "flat_amount": "50"
            },
            {
              "from_value": 10001,
              "to_value": null,
              "per_unit_amount": "0.01",
              "flat_amount": "100"
            }
          ]
        },
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
        "billable_metric_code": "requests",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "package",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "amount": "30",
          "free_units": 1000,
          "package_size": 10000
        },
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a94",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a94",
        "billable_metric_code": "payments",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "percentage",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "rate": "0.15",
          "fixed_amount": "0.5",
          "free_units_per_events": 5,
          "free_units_per_total_aggregation": "500",
          "per_transaction_min_amount": "1.75",
          "per_transaction_max_amount": "2"
        },
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
        "billable_metric_code": "seat",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "standard",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "amount": "10"
        },
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a93",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a93",
        "billable_metric_code": "sms_sent",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "volume",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "volume_ranges": [
            {
              "from_value": 0,
              "to_value": 1000,
              "per_unit_amount": "0.75",
              "flat_amount": "0"
            },
            {
              "from_value": 1001,
              "to_value": null,
              "per_unit_amount": "0.50",
              "flat_amount": "0"
            }
          ]
        },
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a96",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a96",
        "billable_metric_code": "api_request_groups",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "graduated",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "graduated_ranges": [
            {
              "from_value": 0,
              "to_value": null,
              "per_unit_amount": "0",
              "flat_amount": "0"
            }
          ]
        },
        "group_properties": [
          {
            "group_id": "651e2cf0-7c60-41f1-94c3-6872eec4e961",
            "values": {
              "graduated_ranges": [
                {
                  "from_value": 0,
                  "to_value": 20000,
                  "per_unit_amount": "0.02",
                  "flat_amount": "50"
                },
                {
                  "from_value": 20001,
                  "to_value": null,
                  "per_unit_amount": "0.01",
                  "flat_amount": "100"
                }
              ]
            }
          }
        ],
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a100",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a100",
        "billable_metric_code": "request_groups",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "package",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "amount": "0",
          "free_units": 0,
          "package_size": 1
        },
        "group_properties": [
          {
            "group_id": "651e2cf0-7c60-41f1-94c3-6872eec4e961",
            "values": {
              "amount": "30",
            "free_units": 1000,
            "package_size": 10000
            }
          }
        ],
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a98",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a99",
        "billable_metric_code": "payment_groups",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "percentage",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "rate": "0",
          "per_transaction_min_amount": "1.75",
          "per_transaction_max_amount": "2"
        },
        "group_properties": [
          {
            "group_id": "651e2cf0-7c60-41f1-94c3-6872eec4e961",
            "values": {
              "rate": "0.15",
            "fixed_amount": "0.5",
            "free_units_per_events": 5,
            "free_units_per_total_aggregation": "500"
            }
          }
        ],
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a95",
        "billable_metric_code": "seats_groups",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "standard",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "amount": "0"
        },
        "group_properties": [
          {
            "group_id": "651e2cf0-7c60-41f1-94c3-6872eec4e961",
            "values": {
              "amount": "15"
            }
          }
        ],
        "taxes": []
      },
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a97",
        "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a97",
        "billable_metric_code": "sms_sent_groups",
        "created_at": "2023-06-27T19:43:42Z",
        "charge_model": "volume",
        "invoiceable": true,
        "pay_in_advance": false,
        "prorated": false,
        "min_amount_cents": 0,
        "invoice_display_name": "",
        "properties": {
          "volume_ranges": [
            {
              "from_value": 0,
              "to_value": null,
              "per_unit_amount": "0",
              "flat_amount": "0"
            }
          ]
        },
        "group_properties": [
          {
            "group_id": "651e2cf0-7c60-41f1-94c3-6872eec4e961",
            "values": {
              "volume_ranges": [
                {
                  "from_value": 0,
                  "to_value": 2000,
                  "per_unit_amount": "0.75",
                  "flat_amount": "0"
                },
                {
                  "from_value": 2001,
                  "to_value": null,
                  "per_unit_amount": "0.50",
                  "flat_amount": "0"
                }
              ]
            }
          }
        ],
        "taxes": []
      }
    ],
    "taxes": []
  }
}

​
Attributes

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

charges
array

Was this page helpful?

Update your organizationCreate a plan