Provider-Initiated Provisioning (PAY-03)

See Subscriber Management for the full guide.

Endpoint

POST /partner/provisioning/provider-initiated

Auth: X-API-Key
Rate limit: 120 requests / minute

When to use

PAY-03 is for ISP-initiated provisioning — you already have the subscriber’s details (from a sales CRM, a signed contract, or a migration from another system) and want to create their account and provision their port without redirecting them through a checkout flow.

Request body

{
  "plan_version_id": "uuid",
  "location_hash": "10-char hex",
  "location_identifier": "string (alternative to location_hash)",
  "subscriber": {
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "phonenumber": "string (optional)",
    "customer_type": "RESIDENTIAL | BUSINESS",
    "username": "string (min 3 chars)",
    "mac_address": "string (optional)",
    "invoice_contact_detail": {
      "firstname": "string",
      "lastname": "string",
      "email": "string"
    },
    "contract_contact_detail": {
      "firstname": "string",
      "lastname": "string",
      "email": "string"
    },
    "invoice_address": {
      "street": "string",
      "housenumber": "string",
      "postalcode": "string",
      "city": "string",
      "province": "string",
      "country": "Canada"
    }
  }
}

Provide either location_hash or location_identifier — not both.

Response — 200 OK

{
  "job_id": "uuid",
  "subscription_id": "uuid",
  "subscriber_id": "uuid",
  "message": "Provisioning started"
}

The job_id tracks the background provisioning job on the switch. A provisioning.completed webhook fires when the port is live.

Idempotency

The same email + plan_version_id combination returns the existing subscription rather than creating a duplicate. Safe to retry on network errors.

Error codes

Status	Error
`401`	Missing or invalid `X-API-Key`
`403`	`plan_version_id` belongs to a different provider
`404`	`location_hash` or `location_identifier` not found
`409`	Subscriber already has an active subscription at this location
`422`	Validation failure (missing fields, bad email format, etc.)
`429`	Rate limit exceeded

Overview

Plan Discovery

Provisioning

Reports

Checkout Utilities

Subscribers & Subscriptions

AI Support Agent

Provider Operations (Internal API)

Provider-Initiated Provisioning (PAY-03)

Endpoint

When to use

Request body

Response — 200 OK

Idempotency

Error codes

​Endpoint

​When to use

​Request body

​Response — 200 OK

​Idempotency

​Error codes

Endpoint

When to use

Request body

Response — 200 OK

Idempotency

Error codes