---
title: "List details of the billing plan"
method: GET
path: "/_api/plan/{name}"
tags: ["Administration"]
---

# List details of the billing plan

`GET /_api/plan/{name}`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/plan/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch information about a billing plan.

## Path parameters

- `name` string, string, required

## Response `200`

Successfully fetched details of the billing plan.

- Plan201Billing
  - `active` boolean: Active status of the billing plan.
  - `attribution` string: Attribution name of the billing plan.
  - `demo` boolean: Flag about demo status of the billing plan.
  - `description` string: Information of the billing plan.
  - `featureGates` string[]: List of featureGates associated with billing plan.
  - `isBundle` boolean
  - `label` string: Label of the billing plan.
  - `metadata` object: Metadata about the billing plan.
  - `metrics` object[]: Metric values displayed along with name.
    - `name` string
    - `value` string
    - `metricType` string
  - `name` string: Name of the billing plan.
  - `planID` string: ID associated with the billing plan.
  - `pricing` string: Pricing details of the billing plan.

## Other responses

- `401`: Failed because you do not have administrator permissions.
- `403`: Failed to validate because you do not have access to the server.
- `404`: Failed to find specified billing plan.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)
