Preview CPS and concurrency pricing

GET

api

accounts

{auth_id}

channel-pricing-preview

Preview CPS or concurrency pricing

curl --request GET \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-pricing-preview \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "breakdown": []
}

Preview the monthly price for additional calls-per-second (CPS) or concurrent-call capacity. This endpoint calculates the charge from the account’s assigned pricing tier without creating a subscription or debiting the account.

GET https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-pricing-preview

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 preview pricing 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`.

Query parameters

Field	Type	Required	Description
`resource_type`	string	Yes	Capacity to price. 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 GET \
  "https://api.vobiz.ai/api/v1/accounts/MA_XXXX/channel-pricing-preview?resource_type=concurrent_calls&quantity=30" \
  --header "X-Auth-ID: MA_XXXX" \
  --header "X-Auth-Token: YOUR_AUTH_TOKEN"

cURL

curl --request GET \
  "https://api.vobiz.ai/api/v1/accounts/MA_XXXX/channel-pricing-preview?resource_type=cps&quantity=10" \
  --header "X-Auth-ID: MA_XXXX" \
  --header "X-Auth-Token: YOUR_AUTH_TOKEN"

Response

The values below are illustrative. The actual monthly cost and currency come from the target account’s assigned pricing tier.

Preview response

{
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "breakdown": []
}

Field	Type	Description
`resource_type`	string	Capacity type that was priced.
`quantity`	integer	Capacity quantity included in the calculation.
`monthly_cost`	string	Calculated recurring monthly charge as a decimal string.
`currency`	string	Currency assigned by the account’s pricing tier.
`breakdown`	array	Pricing-bracket calculation details when supplied by the tier.

Show this response to the customer before submitting a purchase so they can confirm the exact recurring charge.

Pricing rules

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.
The request fails if the account has no pricing tier or the quantity violates its tier rules.

When the customer confirms the previewed amount, use Purchase CPS or concurrency capacity.

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 preview only its own pricing; administrators may act for another account.

Example:

"MA_XXXX"

Query Parameters

resource_type

enum<string>

required

Capacity type to price. Account capacity to price or purchase.

Available options:

concurrent_calls,

cps

Example:

"concurrent_calls"

quantity

integer

required

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

Required range: 1 <= x <= 10000

Example:

30

Response

Calculated monthly capacity price. No balance is debited.

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

Calculated monthly charge as a decimal string.

Example:

"10470.00"

currency

string

required

Currency assigned by the account's pricing tier.

Example:

"INR"

breakdown

object[]

required

Pricing-bracket calculation details when supplied by the pricing tier.

⌘I

Preview CPS or concurrency pricing

curl --request GET \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/channel-pricing-preview \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "resource_type": "concurrent_calls",
  "quantity": 30,
  "monthly_cost": "10470.00",
  "currency": "INR",
  "breakdown": []
}

​Authentication

​Parameters

​Path parameter

​Query parameters

​Examples

​Response

​Pricing rules

Authorizations

Path Parameters

Query Parameters

Response

Authentication

Parameters

Path parameter

Query parameters

Examples

Response

Pricing rules