Administration

Modify billing plan

Update the billing plan.

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

Path parameters

namestring string required

The name of the billing plan to modify.

Request body

namestring

Name and unique identifier of the of the billing plan.

planIdstring

ID of the billing plan.

descriptionstring

Description of the billing plan.

featureGatesstring[]

List of the billing plan feature gates.

attributionstring

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

labelstring

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

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 updated billing plan data.