Skip to main content
POST
Review subscription change

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
addon_ids
string<uuid>[]
required

Complete desired add-on selection, including every add-on to keep.

Maximum array length: 100
interval
enum<string>
required
Available options:
monthly,
yearly
plan_id
string<uuid>

Target plan. Omit only for an add-on-only subscription.

addon_quantities
object

Response

Review subscription change.

data
object
required