Skip to main content
POST
cURL

Authorizations

X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Body

price
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
name
string
Maximum string length: 100
code
string
Maximum string length: 100
description
string
interval
enum<string>
  • month - Monthly
  • quarter - Quarterly
  • year - Yearly
Available options:
month,
quarter,
year
balance
string<decimal>
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
runs_balance
integer
Required range: -2147483648 <= x <= 2147483647
call_logs_balance
integer
Required range: -2147483648 <= x <= 2147483647
max_members_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_agents_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_concurrent_runs_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_concurrent_chat_runs_limit
integer
Required range: -2147483648 <= x <= 2147483647
monitoring_minutes
integer
Required range: -2147483648 <= x <= 2147483647
premium_slack_support
boolean
custom_api_integrations
boolean
dedicated_support_engineer
boolean
sla_hours
integer
Required range: -2147483648 <= x <= 2147483647
custom_feature_requests
boolean
simulate_scenarios
boolean
downloadable_reports
boolean
slack_alerts
boolean
custom_sso
boolean
dedicated_cloud_instance
boolean
on_prem_deployment
boolean
multiple_organizations
boolean
hippa_compliance
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
billing_type
enum<string>

Billing type for the pack

  • subscription - Subscription
  • self_serve - Self Serve
Available options:
subscription,
self_serve
allow_view_only_role
boolean

Allow VIEW_ONLY role for memberships/invites on this pack. When False, view-only seats are blocked.

data_retention_days
integer | null

Data retention period in days. Leave blank to skip archival for this plan.

Required range: -2147483648 <= x <= 2147483647
free_members_count
integer

Number of members included for free (e.g. 1 = first user free). Only applies to self-serve billing. Self-serve packs with free members never expire: the base plan is free and only the seats beyond this count are billed through Stripe.

Required range: -2147483648 <= x <= 2147483647
one_time_credits
string<decimal>

One-time complimentary credits granted when the pack is provisioned. Added to the never-expiring extra balance; they do not recur.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

Response

200 - application/json
price
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
id
integer
read-only
name
string
Maximum string length: 100
code
string
Maximum string length: 100
description
string
interval
enum<string>
  • month - Monthly
  • quarter - Quarterly
  • year - Yearly
Available options:
month,
quarter,
year
trial_period_days
string
read-only
balance
string<decimal>
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
runs_balance
integer
Required range: -2147483648 <= x <= 2147483647
call_logs_balance
integer
Required range: -2147483648 <= x <= 2147483647
max_members_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_agents_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_concurrent_runs_limit
integer
Required range: -2147483648 <= x <= 2147483647
max_concurrent_chat_runs_limit
integer
Required range: -2147483648 <= x <= 2147483647
monitoring_minutes
integer
Required range: -2147483648 <= x <= 2147483647
premium_slack_support
boolean
custom_api_integrations
boolean
dedicated_support_engineer
boolean
sla_hours
integer
Required range: -2147483648 <= x <= 2147483647
custom_feature_requests
boolean
simulate_scenarios
boolean
downloadable_reports
boolean
slack_alerts
boolean
custom_sso
boolean
dedicated_cloud_instance
boolean
on_prem_deployment
boolean
multiple_organizations
boolean
hippa_compliance
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
billing_type
enum<string>

Billing type for the pack

  • subscription - Subscription
  • self_serve - Self Serve
Available options:
subscription,
self_serve
allow_view_only_role
boolean

Allow VIEW_ONLY role for memberships/invites on this pack. When False, view-only seats are blocked.

data_retention_days
integer | null

Data retention period in days. Leave blank to skip archival for this plan.

Required range: -2147483648 <= x <= 2147483647
free_members_count
integer

Number of members included for free (e.g. 1 = first user free). Only applies to self-serve billing. Self-serve packs with free members never expire: the base plan is free and only the seats beyond this count are billed through Stripe.

Required range: -2147483648 <= x <= 2147483647
one_time_credits
string<decimal>

One-time complimentary credits granted when the pack is provisioned. Added to the never-expiring extra balance; they do not recur.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only