Purchase CPS or concurrency capacity

POST

api

accounts

{auth_id}

channel-subscriptions

Purchase CPS or concurrency capacity

curl --request POST \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_type": "concurrent_calls",
  "quantity": 30
}
'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions"

payload = {
    "resource_type": "concurrent_calls",
    "quantity": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resource_type: 'concurrent_calls', quantity: 30})
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "5ed57f90-b1f1-4c32-9475-b85aa6739aec",
  "account_id": 123456,
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "status": "active",
  "last_billing_date": "2026-07-16T10:00:00Z",
  "next_billing_date": "2026-08-15T10:00:00Z",
  "purchased_at": "2026-07-16T10:00:00Z",
  "cancelled_at": null,
  "cancellation_reason": null,
  "is_active": true,
  "created_at": "2026-07-16T10:00:00Z",
  "updated_at": "2026-07-16T10:00:00Z"
}

Purchase additional calls-per-second (CPS) or concurrent-call capacity for a Vobiz account.

POST https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions
Content-Type: application/json

A successful request immediately debits the first month’s charge from the account balance. Preview the exact price and obtain customer confirmation before purchasing.

Authentication

Use one of these authentication methods:

Method	Headers
Account access token	`Authorization: Bearer <ACCESS_TOKEN>`
Account API credentials	`X-Auth-ID: <AUTH_ID>` and `X-Auth-Token: <AUTH_TOKEN>`

The authenticated account can purchase capacity only for its own auth_id. An administrator may act on behalf of another account.

Parameters

Path parameter

Field	Type	Required	Description
`auth_id`	string	Yes	Target account Auth ID, such as `MA_XXXX`.

Request body

Field	Type	Required	Description
`resource_type`	string	Yes	Capacity to purchase. Use `concurrent_calls` or `cps`.
`quantity`	integer	Yes	Capacity quantity. Must be from `1` through `10000`; pricing-tier block and quantity rules also apply.

Examples

Concurrent calls
CPS

cURL

curl --request POST \
  "https://api.vobiz.ai/api/v1/accounts/MA_XXXX/channel-subscriptions" \
  --header "X-Auth-ID: MA_XXXX" \
  --header "X-Auth-Token: YOUR_AUTH_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "resource_type": "concurrent_calls",
    "quantity": 30
  }'

cURL

curl --request POST \
  "https://api.vobiz.ai/api/v1/accounts/MA_XXXX/channel-subscriptions" \
  --header "X-Auth-ID: MA_XXXX" \
  --header "X-Auth-Token: YOUR_AUTH_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "resource_type": "cps",
    "quantity": 10
  }'

Successful response

The values below are illustrative. The actual monthly cost, currency, and billing dates come from the account and its assigned pricing tier.

Subscription activated

{
  "id": "5ed57f90-b1f1-4c32-9475-b85aa6739aec",
  "account_id": 123456,
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "status": "active",
  "last_billing_date": "2026-07-16T10:00:00Z",
  "next_billing_date": "2026-08-15T10:00:00Z",
  "purchased_at": "2026-07-16T10:00:00Z",
  "cancelled_at": null,
  "cancellation_reason": null,
  "is_active": true,
  "created_at": "2026-07-16T10:00:00Z",
  "updated_at": "2026-07-16T10:00:00Z"
}

Field	Type	Description
`id`	string	Unique subscription identifier.
`account_id`	integer	Internal identifier of the account that owns the subscription.
`resource_type`	string	Purchased capacity type.
`quantity`	integer	Purchased capacity quantity.
`monthly_cost`	string	Recurring monthly charge as a decimal string.
`currency`	string	Billing currency from the account’s pricing tier.
`status`	string	Subscription status. A successful purchase is created as `active`.
`last_billing_date`	string	Date and time of the most recent subscription charge.
`next_billing_date`	string	Scheduled date and time of the next charge.
`purchased_at`	string	Date and time the capacity was purchased.
`cancelled_at`	string or null	Date and time the subscription was cancelled, if applicable.
`cancellation_reason`	string or null	Recorded cancellation reason, if applicable.
`is_active`	boolean	Whether the subscription is currently active.
`created_at`	string	Date and time the subscription record was created.
`updated_at`	string	Date and time the subscription record was last updated.

Billing and validation

resource_type must be concurrent_calls or cps.
quantity must be an integer from 1 through 10000.
Pricing uses the account’s assigned pricing tier and applicable pricing brackets.
The tier’s block-size, minimum-quantity, and maximum-quantity rules are enforced.
A successful purchase immediately debits the first month’s charge.
The subscription is created as active and scheduled to renew every 30 days.
The purchase fails if the account has no pricing tier, the quantity violates its pricing rules, or the balance debit fails.

Do not automatically retry a timed-out purchase. First retrieve the account and check its balance to avoid a duplicate charge.

Authorizations

Authorization

string

header

required

Account access token sent as Authorization: Bearer <ACCESS_TOKEN>.

Path Parameters

auth_id

string

required

Target account Auth ID. An account can purchase only for itself; administrators may act for another account.

Example:

"MA_XXXX"

Body

application/json

resource_type

enum<string>

required

Account capacity to price or purchase.

Available options:

concurrent_calls,

cps

Example:

"concurrent_calls"

quantity

integer

required

Capacity quantity to purchase. Pricing-tier block and quantity rules also apply.

Required range: 1 <= x <= 10000

Example:

30

Response

Capacity subscription purchased and activated.

string<uuid>

required

Example:

"5ed57f90-b1f1-4c32-9475-b85aa6739aec"

account_id

integer

required

Example:

123456

resource_type

enum<string>

required

Account capacity to price or purchase.

Available options:

concurrent_calls,

cps

Example:

"concurrent_calls"

quantity

integer

required

Required range: 1 <= x <= 10000

Example:

30

monthly_cost

string

required

Recurring monthly charge as a decimal string.

Example:

"10470.00"

currency

string

required

Example:

"INR"

status

string

required

Example:

"active"

last_billing_date

string<date-time>

required

Example:

"2026-07-16T10:00:00Z"

next_billing_date

string<date-time>

required

Example:

"2026-08-15T10:00:00Z"

purchased_at

string<date-time>

required

Example:

"2026-07-16T10:00:00Z"

cancelled_at

string<date-time> | null

required

Example:

null

cancellation_reason

string | null

required

Example:

null

is_active

boolean

required

Example:

true

created_at

string<date-time>

required

Example:

"2026-07-16T10:00:00Z"

updated_at

string<date-time>

required

Example:

"2026-07-16T10:00:00Z"

⌘I

Purchase CPS or concurrency capacity

curl --request POST \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_type": "concurrent_calls",
  "quantity": 30
}
'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions"

payload = {
    "resource_type": "concurrent_calls",
    "quantity": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resource_type: 'concurrent_calls', quantity: 30})
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "5ed57f90-b1f1-4c32-9475-b85aa6739aec",
  "account_id": 123456,
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "status": "active",
  "last_billing_date": "2026-07-16T10:00:00Z",
  "next_billing_date": "2026-08-15T10:00:00Z",
  "purchased_at": "2026-07-16T10:00:00Z",
  "cancelled_at": null,
  "cancellation_reason": null,
  "is_active": true,
  "created_at": "2026-07-16T10:00:00Z",
  "updated_at": "2026-07-16T10:00:00Z"
}

​Authentication

​Parameters

​Path parameter

​Request body

​Examples

​Successful response

​Billing and validation

Authorizations

Path Parameters

Body

Response

Authentication

Parameters

Path parameter

Request body

Examples

Successful response

Billing and validation