Administration

List details of the billing plan

Fetch information about a billing plan.

get/_api/plan/{name}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or 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.

Path parameters

namestring string required

The billing plan name for which we want to fetch info.

Response

Successfully fetched details of the billing plan.

activeboolean

Active status of the billing plan.

attributionstring

Attribution name of the billing plan.

demoboolean

Flag about demo status of the billing plan.

descriptionstring

Information of the billing plan.

featureGatesstring[]

List of featureGates associated with billing plan.

isBundleboolean

labelstring

Label of the billing plan.

metadataobject

Metadata about the billing plan.

namestring

Name of the billing plan.

planIDstring

ID associated with the billing plan.

pricingstring

Pricing details of the billing plan.

Example response

{
  "active": true,
  "demo": true,
  "description": "Information of the plan",
  "featureGates": [
    "KV"
  ],
  "label": "Free",
  "metadata": {
    "key": "value"
  },
  "metrics": [
    {
      "name": "kv-reads",
      "value": "c8db_service_kv_read_requests_count",
      "metricType": "counter"
    }
  ],
  "name": "enterprise",
  "planID": "aa2da2sd3s2ed3ssd3sd",
  "pricing": "Custom pricing"
}

Changes

No recorded changes to this operation across all 1 revision of this API.