GET
/
plans
/
{code}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/plans/:code" \
  --header "Authorization: Bearer $API_KEY"
{
  "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": "<string>",
    "amount_cents": 10000,
    "amount_currency": "USD",
    "trial_period": 5,
    "pay_in_advance": true,
    "bill_charges_monthly": true,
    "active_subscriptions_count": 123,
    "draft_invoices_count": 123,
    "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": 123,
          "charges_count": 123,
          "customers_count": 123,
          "plans_count": 123,
          "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
        },
        "group_properties": []
      },
      {
        "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"
            }
          ]
        },
        "group_properties": []
      },
      {
        "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": {},
        "group_properties": [
          {
            "group_id": "1a901a90-1a90-1a90-1a90-1a901a901a01",
            "invoice_display_name": "Europe",
            "values": {
              "amount": "10"
            }
          },
          {
            "group_id": "1a901a90-1a90-1a90-1a90-1a901a901a02",
            "invoice_display_name": "USA",
            "values": {
              "amount": "5"
            }
          },
          {
            "group_id": "1a901a90-1a90-1a90-1a90-1a901a901a03",
            "invoice_display_name": "Africa",
            "values": {
              "amount": "8"
            }
          }
        ]
      },
      {
        "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"
            }
          ]
        },
        "group_properties": []
      },
      {
        "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"
        },
        "group_properties": []
      }
    ],
    "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": 123,
        "charges_count": 123,
        "customers_count": 123,
        "plans_count": 123,
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

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.

Response

200 - application/json
plan
object
required