Administration

Create billing plan

Create a new billing plan.

Note: Requires administrator permissions.

post/_api/plan

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Name and unique identifier of the of the billing plan.

planIdstring

ID of the billing plan.

descriptionstring

Description of the billing plan.

featureGatesstring[] required

List of the billing plan feature gates.

attributionstring required

Attribution of the billing plan. Combination of attribution and label must be unique for the plan.

labelstring required

Display label of the billing plan. Combination of attribution and label must be unique for the plan.

pricingstring

Pricing details of the billing plan.

isBundleboolean

Bundle.

metadataobject

Metadata of the plan, having set of key-value pairs.

activeboolean required

A mandatory flag that specifies whether the billing plan is active.

demoboolean

An flag that specifies whether the billing plan is demo or not.

Example request

{
  "name": "Test",
  "planId": "1",
  "description": "New billing plan.",
  "featureGates": [
    "KV"
  ],
  "attribution": "Macrometa",
  "label": "Enterprise",
  "pricing": "Custom pricing",
  "isBundle": true,
  "metadata": {
    "key": "value"
  },
  "metrics": [
    {
      "name": "kv-reads",
      "value": "c8db_service_kv_read_requests_count",
      "metricType": "counter"
    }
  ],
  "active": true
}

Response

Successfully created 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.