Get plan details

Retrieve a specific plan. Use ?version=draft for the draft version, ?version=2 for a specific version number, or omit for the active version.

GET /api/v1/plans/{plan_id}

Get plan details

cURL

curl --request GET \
  --url https://api.example.com/api/v1/plans/{plan_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "available_parameters": {
    "billing_periods": {},
    "capacity_thresholds": {},
    "slot_components": [
      "<string>"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "EUR",
  "id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
  "name": "<string>",
  "net_terms": 123,
  "plan_type": "STANDARD",
  "price_components": [
    {
      "id": "price_7n42DGM5Tflk9n8mt7Fhc7",
      "name": "<string>",
      "fee": {
        "rates": [
          {
            "price": "<string>",
            "term": "MONTHLY"
          }
        ]
      },
      "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "product_family": {
    "id": "pf_7n42DGM5Tflk9n8mt7Fhc7",
    "name": "<string>"
  },
  "status": "DRAFT",
  "tax_inclusive": true,
  "version": 123,
  "version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7",
  "billing_cycles": 123,
  "description": "<string>",
  "entitlements": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "feature_id": "feat_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "ent_7n42DGM5Tflk9n8mt7Fhc7",
      "updated_at": "2023-11-07T05:31:56Z",
      "value": {
        "enabled": true
      }
    }
  ],
  "minimum_commitment": {
    "amount": "<string>",
    "scope": {}
  },
  "period_start_day": 123,
  "self_service_rank": 123,
  "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"

Query Parameters

version · string

Filter by version: "draft", a version number, or omitted for active

Response

200

application/json

Plan details

available_parameters · object · required

Show child attributes

created_at · string<date-time> · required

currency · enum<string> · required

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

Example:

"EUR"

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

Show child attributes

product_family · object · required

Show child attributes

status · enum<string> · required

Available options: DRAFT, ACTIVE, INACTIVE, ARCHIVED

tax_inclusive · boolean · required

The plan's amounts are quoted tax-included ("9.99 incl. VAT"): tax is carved out of them at invoice time instead of being added on top, so the customer pays the quoted price whatever rate applies. A customer who bears no tax (reverse charge, exempt, export) still pays it in full. Defaults to false.

version · integer<int32> · required

version_id · string<MeteroidId> · required

Example:

"plv_7n42DGM5Tflk9n8mt7Fhc7"

billing_cycles · integer<int32> | null

description · string | null

entitlements · object[]

Show child attributes

minimum_commitment · object | null

Plan-level minimum commitment (period true-up floor). When set, every billing-period invoice for this plan is guaranteed to be at least minimum_commitment.amount after discounts, with a "Minimum commitment" line filling any shortfall.

Show child attributes

period_start_day · integer<int32> | null

self_service_rank · integer<int32> | null

trial · object | null

Show child attributes