Skip to main content
GET
Get billing config by category

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-admin-api-key
string
required

The API key to access the admin API

Path Parameters

category
enum<string>
required

The category of the billing config

Available options:
upgrade,
downgrade,
billing,
grace_period,
terminate

Response

Returns the billing config

configKey
required

Config key - either a type or plan code

Available options:
timing_policy
configValue
required

Config value - either a type or grace period days

Available options:
immediate,
next_cycle
configCategory
string
required

Config key type (e.g. upgrade, downgrade, terminate)

Example:

"upgrade"

status
string
required

Status Type (e.g. active)

Example:

"active"

description
string
required

Description of the billing config

Example:

"Immediate Upgrade"