Skip to main content
POST
Confirm 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
review_ref
string
required
Maximum string length: 16000
confirm
enum<boolean>
required

Explicit approval of the reviewed selection, amount, currency and selected card. The selected card also becomes the subscription renewal method.

Available options:
true
payment_method_ref
string

Reference from the same review, required when payment is due. Omit when no payment is due.

Maximum string length: 4000

Response

Confirm subscription change.

data
object
required