Skip to main content
PUT
Assign a customer managed plan or update renewal settings

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.

Path Parameters

user_id
string<uuid>
required

Customer user UUID.

Body

application/json
request_id
string<uuid>
required

Unique idempotency UUID. Reuse the same UUID only with identical input after an ambiguous response.

plan_id
string<uuid>
required

Reseller plan UUID from the current overview.

billing_interval
enum<string>
required

Monthly funding, or yearly funding with monthly allowance delivery.

Available options:
monthly,
yearly
shortage_policy
enum<string>
required

wait preserves the plan and remaining credits and retries funding hourly; auto_topup first uses the reseller saved top-up settings. If renewal stays unfunded for three days after the term ends, the managed plan ends, unused funded credits return to the reseller wallet and the customer falls back to the free plan.

Available options:
wait,
auto_topup
expected_version
integer | null
required

Current managed plan version from the overview. Use null only when assigning the first managed plan.

Required range: x >= 1
max_debit_credits
number
required

Maximum net credit debit accepted for this change after refundable credits. The operation fails if the current quote exceeds this amount.

Required range: 0 <= x <= 13000000000000
workspace_id
string<uuid>

Customer workspace UUID. Required when the customer workspace cannot be selected unambiguously.

ends_at
string<date-time> | null

Optional future end timestamp. Omit or use null for no scheduled end.

enable_auto_topup
boolean

Explicit consent to enable the reseller workspace existing auto-top-up settings. May lead to a saved-card charge; requires a configured amount and saved payment method.

Consent token from the reviewed overview auto-top-up settings. Required when shortage_policy is auto_topup, including when automatic top-up is already enabled; settings changes invalidate this token.

Pattern: ^[a-f0-9]{64}$
quote_token
string

Selected offer monthly_quote_token or yearly_quote_token from the reviewed overview. Required for a new assignment; not required when editing only existing agreement settings. Any change to the catalog or funding terms invalidates it.

Pattern: ^[a-f0-9]{64}$

Response

Managed plan operation result.

data
object
required