Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
plans

List all plans

Lists all plans in the current environment.

Use this to retrieve all plans for displaying pricing pages or managing plan configurations.

post/v1/plans.list

Headers

x-api-versionstring required

Request body

customer_idstring

Customer ID to include eligibility info (trial availability, attach scenario).

entity_idstring

Entity ID for entity-scoped plans.

include_archivedboolean

If true, includes archived plans in the response.

all_versionsboolean

If true, includes all plan versions.

Example request

{}

Response

OK

Example response

{
  "list": [
    {
      "id": "pro",
      "name": "Pro Plan",
      "description": null,
      "group": null,
      "version": 1,
      "addOn": false,
      "autoEnable": false,
      "price": {
        "amount": 10,
        "interval": "month",
        "display": {
          "primaryText": "$10",
          "secondaryText": "per month"
        }
      },
      "items": [
        {
          "featureId": "messages",
          "included": 100,
          "unlimited": false,
          "reset": {
            "interval": "month"
          },
          "price": {
            "amount": 0.5,
            "interval": "month",
            "billingUnits": 100,
            "billingMethod": "usage_based",
            "maxPurchase": null
          },
          "display": {
            "primaryText": "100 messages",
            "secondaryText": "then $0.5 per 100 messages"
          }
        },
        {
          "featureId": "users",
          "included": 0,
          "unlimited": false,
          "reset": null,
          "price": {
            "amount": 10,
            "interval": "month",
            "billingUnits": 1,
            "billingMethod": "prepaid",
            "maxPurchase": null
          },
          "display": {
            "primaryText": "$10 per Users"
          }
        }
      ],
      "createdAt": 1771513979217,
      "env": "sandbox",
      "archived": false,
      "baseVariantId": null,
      "config": {
        "ignore_past_due": false
      },
      "billing_controls": {},
      "metadata": {}
    }
  ]
}