Skip to main content
GET
/
api
/
v1
/
plans
/
{plan_id}
Get plan
curl --request GET \
  --url https://api.example.com/api/v1/plans/{plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "available_parameters": {
    "billing_periods": {},
    "capacity_thresholds": {},
    "slot_components": [
      "<string>"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "id": "<string>",
  "name": "<string>",
  "net_terms": 123,
  "plan_type": "STANDARD",
  "price_components": [
    {
      "id": "<string>",
      "name": "<string>",
      "fee": {
        "rates": [
          {
            "price": "<string>",
            "term": "MONTHLY"
          }
        ]
      },
      "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "product_family": {
    "id": "<string>",
    "name": "<string>"
  },
  "status": "DRAFT",
  "version": 123,
  "version_id": "<string>",
  "description": "<string>",
  "trial": {
    "duration_days": 1,
    "is_free": true,
    "trialing_plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

plan_id
string<MeteroidId>
required

Plan ID

Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

Response

Plan details

available_parameters
object
required
created_at
string<date-time>
required
currency
string
required
id
string<MeteroidId>
required
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

name
string
required
net_terms
integer<int32>
required
plan_type
enum<string>
required
Available options:
STANDARD,
FREE,
CUSTOM
price_components
object[]
required
product_family
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
version
integer<int32>
required
version_id
string<MeteroidId>
required
Example:

"plv_7n42DGM5Tflk9n8mt7Fhc7"

description
string | null
trial
object