Buy Capacity Channels
buy_capacity_channelsDestructive
Purchase additional channels into one of the customer's Capacity Pools by creating an Order. Provide the capacity_pool_id (from list_capacity_pools) and qty — the number of channels to add to the pool. The price is prorated to the pool's renew date. Charges the customer's balance; the channels are added to the pool immediately and can then be distributed across Shared Capacity Groups or dedicated-channel reservations. A DID can only draw channels from a pool that covers its country — pass the optional country_iso to fail fast on a mismatched pool before any money is spent. All amounts are in USD. This spends real money.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| qty | Yes | Number of channels to purchase into the pool. | |
| country_iso | No | Optional pre-check: ISO 3166-1 alpha-2 country code of the DIDs this capacity is for. The purchase fails BEFORE any confirmation/charge if the pool does not cover that country (a DID can only draw channels from a pool covering its country — see covered_country_isos in list_capacity_pools). | |
| capacity_pool_id | Yes | UUID of the Capacity Pool to buy channels into (from list_capacity_pools). | |
| confirmation_token | No | Leave empty on the first call — the tool returns a confirmation_token + preview and charges nothing. Re-call with that confirmation_token to execute the purchase. If the confirming call's response is lost, it is safe to retry with the SAME confirmation_token — a repeat returns the original result and never purchases twice. |