Update DID renewal (billing cycles) / description / detach E911
update_didManage a DID's renewal by setting billing_cycles_count. Three modes: null = the DID AUTO-RENEWS every billing cycle (monthly) indefinitely; N (a positive integer) = the DID renews for N MORE cycles (a countdown), then stops; 0 = STOP renewing: the DID keeps no renewal count and stays valid until the end of its current expiration date, then expires (this is the SOFT, reversible alternative to deleting a DID — set it back to null or N to resume renewing). Omit billing_cycles_count to leave it unchanged. Can also set or clear the DID description (to label several DIDs at once, use update_did_description). Can also DETACH the DID from its Emergency Calling Service (E911): pass emergency_calling_service_id: null (requires the emergency management permission, like the panel). Only unassignment is supported — assignment goes through the emergency domain verification flow. E911 is billed per number, so removing the number stops its charge from the next renewal; a service left with NO numbers is auto-canceled within a few hours (the customer is notified) — no extra cancellation step is needed. Returns the DID number, its resulting expiration date (expires_at), the new billing_cycles_count and the description.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| did_id | Yes | UUID of the DID to update (must belong to the customer). | |
| description | No | Free text, e.g. an internal ticket reference. null or "" clears it. Omit to leave unchanged. | |
| billing_cycles_count | No | Renewal control. null = auto-renew indefinitely; a positive integer N = renew for N more cycles then stop; 0 = stop renewing (DID stays valid until its expiration date, then expires — the soft alternative to deleting). Omit to leave unchanged. | |
| emergency_calling_service_id | No | ONLY null is accepted: detaches the DID from its Emergency Calling Service (E911). Errors if the DID is not assigned to one. Billing is per number — the detached number stops being charged; a service left with no numbers auto-cancels within a few hours. Omit to leave the E911 assignment unchanged. |