See Subscriber Management for the full guide.

​
Endpoints

MethodPathDescription
GET/api/v1/provider/subscribers/{id}/subscriptionsList a subscriber’s subscriptions
POST/api/v1/subscription/{id}/activateActivate a PENDING subscription
POST/api/v1/subscription/{id}/cancelCancel and deprovision
POST/api/v1/subscription/{id}/suspendSuspend port access
POST/api/v1/subscription/{id}/reactivateRestore port access after suspension
POST/api/v1/subscription/{id}/change-planChange to a different plan version
All endpoints require X-API-Key. Cancel, suspend, reactivate, and change-plan trigger background network operations on the switch.

​
Change plan body

{
  "plan_version_id": "new-plan-version-uuid"
}

​
Subscription status values

StatusDescription
PENDINGCreated, not yet activated
PENDING_INSTALLHome-drop — waiting for technician
ACTIVEPort provisioned, internet live
SUSPENDEDPort blocked, subscription preserved
CANCELLEDPort deprovisioned, service ended