Skip to main content
POST
/
v1
/
plans.get
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.plans.get({
  planId: "pro_plan",
});
{
  "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
  }
}
Retrieves a single plan by its ID. Returns the latest version by default.

​
Common Use Cases

const plan = await autumn.plans.get({
  planId: "pro_plan"
});

​
Body Parameters

​
Response

{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-api-version
string
default:2.3.0
required

Body

application/json
​
plan_id
string
required

The ID of the plan to retrieve.

Minimum string length: 1
​
version
number

The version of the plan to get. Defaults to the latest version.

Response

200 - application/json

OK

A plan defines a set of features, pricing, and entitlements that can be attached to customers.

​
id
string
required

Unique identifier for the plan.

​
name
string
required

Display name of the plan.

​
description
string | null
required

Optional description of the plan.

​
group
string | null
required

Group identifier for organizing related plans. Plans in the same group are mutually exclusive.

​
version
number
required

Version number of the plan. Incremented when plan configuration changes.

​
add_on
boolean
required

Whether this is an add-on plan that can be attached alongside a main plan.

​
auto_enable
boolean
required

If true, this plan is automatically attached when a customer is created. Used for free plans.

​
price
object
required

Base recurring price for the plan. Null for free plans or usage-only plans.

​
items
object[]
required

Feature configurations included in this plan. Each item defines included units, pricing, and reset behavior for a feature.

​
created_at
number
required

Unix timestamp (ms) when the plan was created.

​
env
enum<string>
required

Environment this plan belongs to ('sandbox' or 'live').

Available options:
sandbox,
live
​
archived
boolean
required

Whether the plan is archived. Archived plans cannot be attached to new customers.

​
base_variant_id
string | null
required

If this is a variant, the ID of the base plan it was created from.

​
config
object
required

Miscellaneous plan-level configuration flags.

​
free_trial
object

Free trial configuration. If set, new customers can try this plan before being charged.

​
customer_eligibility
object