Subscriber Self-Service

These endpoints are called on behalf of a subscriber, not by the ISP. They require a subscriber JWT obtained through your authentication flow, not your provider API key.

Authentication

Authorization: Bearer <subscriber_jwt> — the JWT issued to the subscriber after login.

Endpoints

Method	Path	Description
`GET`	`/partner/subscriber/me`	Profile, subscriptions, external sessions, branding
`GET`	`/partner/subscriber/me/details`	Full account details including addresses
`PATCH`	`/partner/subscriber/me/invoice-contact`	Update invoice contact
`PATCH`	`/partner/subscriber/me/contract-contact`	Update contract contact
`PATCH`	`/partner/subscriber/me/password`	Change password
`GET`	`/partner/subscriber/me/invoices`	List invoices
`GET`	`/partner/subscriber/me/credit-notes`	List credit notes (refunds and credits)
`GET`	`/partner/subscriber/me/usage`	Per-month usage data
`GET`	`/partner/subscriber/me/preferences`	Communication preferences
`PATCH`	`/partner/subscriber/me/preferences`	Update communication preferences
`PATCH`	`/partner/subscriber/me/auto-pay`	Toggle AutoPay per subscription
`PATCH`	`/partner/subscriber/me/billing-day`	Choose the day of the month to be charged on (1–10)
`GET`	`/partner/subscriber/me/payment-method`	Get saved payment method
`POST`	`/partner/subscriber/me/payment-method/setup`	Start payment method setup
`POST`	`/partner/subscriber/me/payment-method/confirm`	Confirm new payment method
`GET`	`/partner/subscriber/me/pipeda-requests`	List PIPEDA data access requests
`POST`	`/partner/subscriber/me/pipeda-requests`	Submit a PIPEDA request (returns 201)
`GET`	`/partner/subscriber/status-history`	Subscriber’s own offline/recovery events

GET /partner/subscriber/me

Returns the subscriber record, all their subscriptions, any anonymous external-checkout sessions linked to the account, and provider branding:

{
  "subscriber": {
    "document_id": "uuid",
    "stripe_customer_id": "cus_... | null",
    "email": "alice@example.com",
    "username": "alice"
  },
  "subscriptions": [ { "...": "subscription with plan_version, location, service_provider embeds" } ],
  "external_sessions": [ { "...": "anonymous checkout hand-offs linked to this account" } ],
  "branding": {
    "name": "Provider Name",
    "primary_color": "#8100D0",
    "logo_url": "https://...",
    "contact_email": "support@provider.example"
  }
}

An account with no subscriber record yet (freshly registered, nothing ordered) gets a 200 with "subscriber": null and empty subscriptions — not a 404.

GET /partner/subscriber/me/details

Returns the full account profile used by the Account page. customer_number is the provider-scoped, human-readable customer number (four letters, dash, four digits — also printed on invoices); it is null for accounts linked before the number rollout that have not been backfilled:

{
  "document_id": "uuid",
  "customer_type": "RESIDENTIAL",
  "customer_number": "ABCD-1234 | null",
  "mac_address": "string | null",
  "invoice_contact": { "document_id": "uuid", "firstname": "string", "lastname": "string", "phonenumber": "string | null", "company": "string | null", "email": "string" },
  "contract_contact": { "document_id": "uuid", "firstname": "string", "lastname": "string", "phonenumber": "string | null", "company": "string | null", "email": "string" },
  "invoice_address": { "document_id": "uuid", "street": "string", "housenumber": "string", "unitnumber": "string | null", "floor": "string | null", "postalcode": "string", "city": "string", "province": "string", "country": "string", "full_address": "string | null" },
  "user": { "document_id": "uuid", "email": "alice@example.com", "username": "alice" }
}

A user with no subscriber record gets a 404 (unlike /me, which returns "subscriber": null).

PATCH /partner/subscriber/me/password

{
  "current_password": "string",
  "new_password": "string"
}

Response: {"success": true, "message": "Password updated successfully"}. A wrong current password returns 400 "Current password is incorrect".

GET /partner/subscriber/me/invoices

Returns the subscriber’s kurnl invoices (local invoice rows, not Invoice Ninja objects), sorted by invoice_date descending:

{
  "invoices": [
    {
      "id": "uuid",
      "invoice_number": "INV-0001",
      "invoice_status": "string",
      "paid": true,
      "currency": "CAD",
      "invoice_date": "2026-06-01",
      "invoice_period_start": "2026-06-01",
      "invoice_period_end": "2026-06-30",
      "due_date": "2026-06-15",
      "total_net_amount": 49.99,
      "total_tax_amount": 6.50,
      "total_gross_amount": 56.49,
      "invoice_pdf_url": "https://...",
      "invoice_external_id": "string | null",
      "stripe_payment_intent_id": "pi_... | null",
      "subscription_id": "uuid",
      "service_provider_id": "uuid",
      "created_at": "2026-06-01T00:00:00Z",
      "invoice_lines": [
        { "id": "uuid", "line_type": "string", "description": "string", "quantity": 1, "unit_price": 49.99, "amount": 49.99 }
      ]
    }
  ]
}

Returns 404 "No subscriber record found for this account" when the account has no subscriber record (same for the other /me/* sub-resources).

GET /partner/subscriber/me/credit-notes

Returns the subscriber’s credit notes — cancellation refunds and credits, plan-change and operator credits — read live from the provider’s billing system (Invoice Ninja), newest first. Drafts, archived and voided notes are never listed. Unlike invoices, nothing is stored on the kurnl side.

{
  "credit_notes": [
    {
      "id": "string",
      "number": "0008",
      "date": "2026-09-16",
      "amount": 42.00,
      "state": "open | refunded | paid_out | applied",
      "kind": "cancellation_refund | cancellation_credit | plan_change | operator | other",
      "description": "Cancellation refund — 14 unused day(s)"
    }
  ]
}

state is the customer-facing status: open (issued, not yet settled), refunded (refunded to the card), paid_out (paid out by other means), applied (applied against an invoice). amount is the gross amount in the provider’s currency. The PDF of a credit note is served by GET /api/v1/credit-notes/{id}/pdf with the subscriber’s session — the same access model as invoice PDFs; a note that does not belong to the subscriber answers 404. Returns 404 when the account has no subscriber record and 502 when the billing system is unreachable (never an empty list in that case).

GET /partner/subscriber/me/usage

Per-month download/upload usage in GB for the subscriber’s active subscription — the last 6 complete calendar months plus the current month to date. Returns {"status": "no_subscription" | "no_data", "months": []} when no subscription or no network data exists.

GET /partner/subscriber/status-history

The subscriber’s own connection timeline, newest first: {"events": [{"id", "started_at", "resolved_at", "ongoing"}]}. Degrades to an empty list on any failure so it stays loadable during outages.

PATCH /partner/subscriber/me/billing-day

Choose the day of the calendar month one of the subscriber’s own subscriptions is invoiced and charged on. Allowed values are 1 to 10; the default is 1.

{ "subscription_id": "subn-1", "billing_day": 8 }

{
  "subscription_id": "subn-1",
  "billing_day": 8,
  "effective_period": "2026-01-01",
  "next_send_date": "2026-01-08"
}

effective_period is the first calendar month the new day applies to, as its 1st.
next_send_date is when the recurring invoice will next send, or null when the subscription has no recurring invoice yet.

The billing period is always the calendar month, so this changes only when money is collected — never what is owed. No invoice, no credit note and no correction is ever produced by a billing-day change. If the current month has already been invoiced, the new day takes effect from the next month instead.

Status codes: 200 on success · 404 when the subscription is not the caller’s · 422 when billing_day is outside 1–10 · 409 when the current month has not been invoiced yet and the chosen day has already passed (or is today) — pick a day still ahead of today, or wait until this month’s invoice is issued · 502 when the day was saved but the next invoice could not be rescheduled (retry).

GET/POST /partner/subscriber/me/payment-method*

GET .../me/payment-method, POST .../me/payment-method/setup and POST .../me/payment-method/confirm manage the subscriber’s saved card in their provider’s own Stripe account. If that provider has no Stripe connection, each returns 409:

{
  "detail": {
    "code": "payments_not_configured",
    "message": "This provider has not connected a Stripe account yet, so online payment is not available.",
    "provider_id": "uuid"
  }
}

Subscriber management for ISPs (listing subscribers, looking up accounts, triggering cancel) is done through the dashboard, not the partner API. Subscribers are created automatically as part of the provisioning flows — see External Checkout and Provider-Initiated Provisioning.

Overview

Plan Discovery

Provisioning

Reports

Checkout Utilities

Subscribers & Subscriptions

AI Support Agent

Provider Operations (Internal API)

Authentication

Endpoints

GET /partner/subscriber/me

GET /partner/subscriber/me/details

PATCH /partner/subscriber/me/password

GET /partner/subscriber/me/invoices

GET /partner/subscriber/me/credit-notes

GET /partner/subscriber/me/usage

GET /partner/subscriber/status-history

PATCH /partner/subscriber/me/billing-day

GET/POST /partner/subscriber/me/payment-method*

​Authentication

​Endpoints

​GET /partner/subscriber/me

​GET /partner/subscriber/me/details

​PATCH /partner/subscriber/me/password

​GET /partner/subscriber/me/invoices

​GET /partner/subscriber/me/credit-notes

​GET /partner/subscriber/me/usage

​GET /partner/subscriber/status-history

​PATCH /partner/subscriber/me/billing-day

​GET/POST /partner/subscriber/me/payment-method*

Authentication

Endpoints

GET /partner/subscriber/me

GET /partner/subscriber/me/details

PATCH /partner/subscriber/me/password

GET /partner/subscriber/me/invoices

GET /partner/subscriber/me/credit-notes

GET /partner/subscriber/me/usage

GET /partner/subscriber/status-history

PATCH /partner/subscriber/me/billing-day

GET/POST /partner/subscriber/me/payment-method*