Replace an agent billing plan
Whole-plan replacement, never a field merge: a field left out means ‘this plan does not state that’, not ‘keep what was there’. Editing a plan spends nothing, refunds nothing and resets no window — it changes what the NEXT call costs for every scope on the plan. mode cannot be changed. Turning overage_mode to metered mints the plan’s invoice container first when it has none.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Replace plan payload
Human-readable resource name.
1 - 120"Support agent plan"
Rate card reference. On policy writes, omission preserves the current reference and null detaches it; on plan replacement omission clears it.
1"airc_example"
Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.
- refuse: Rejects the call that crosses the boundary without deducting usage.
- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.
refuse, metered "metered"
Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.
40^\d+(\.\d+)?$"20"
Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.
40^\d+(\.\d+)?$"10"
Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.
1"airc_overage"
Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.
1 - 8 elementsCredits granted per seat per billing period. Null grants no credits.
40^\d+(\.\d+)?$"10000"
Whether granted credits survive renewal. Purchased credits always roll over.
true
Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.
60 <= x <= 4464060
Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.
- calendar_month: Settles at the end of each UTC calendar month.
calendar_month "calendar_month"
Response
Unique Hyperline identifier for this resource.
"d18603dd-7285-4bf5-a45e-88d7de8f37c9"
Human-readable resource name.
"Support agent plan"
Billing mode.
- wallet: Charges a monetary wallet.
- credits: Consumes a credit balance.
- windows: Meters weighted units against rolling allowances.
wallet, credits, windows "wallet"
Public rate card used by this plan, or null when the plan supplies none.
null
Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.
Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.
^-?\d+(\.\d+)?(e[+-]?\d+)?$/i"20"
Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.
- refuse: Rejects the call that crosses the boundary without deducting usage.
- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.
refuse, metered "metered"
Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.
^-?\d+(\.\d+)?(e[+-]?\d+)?$/i"10"
Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.
"airc_overage"
Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.
60
Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.
- calendar_month: Settles at the end of each UTC calendar month.
calendar_month "calendar_month"
Credits granted per seat per billing period. Null grants no credits.
^-?\d+(\.\d+)?(e[+-]?\d+)?$/i"10000"
Whether granted credits survive renewal. Purchased credits always roll over.
true
Public product identifiers for this plan's invoice charges, in creation order. Read-only; amounts are defined by the corresponding price configurations.
Public price configuration identifiers corresponding to billing_item_ids. Read-only.
Number of customer policy scopes referencing this resource.
1
Whether this is the default plan or shared customer scope.
false

