Skip to main content
POST
/
api
/
v1
/
billing-configs
Create billing config
curl --request POST \
  --url https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-admin-api-key: <x-admin-api-key>' \
  --data '
{
  "configKey": "timing_policy",
  "configValue": "immediate",
  "configCategory": "upgrade",
  "status": "active",
  "description": "Immediate Upgrade"
}
'
{
  "configKey": "timing_policy",
  "configValue": "immediate",
  "configCategory": "upgrade",
  "status": "active",
  "description": "Immediate Upgrade"
}

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

Body

application/json
​
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"

Response

Billing config created successfully

​
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"