Account and billing endpoints

These endpoints work on the organisation your token belongs to and take no customer ID. None has a v1 operation yet: they are on https://one.vigilbase.com, and answer in One's older shapes. Sign-in, permissions, rate limits and error shapes are on Vigilbase One API.

When your organisation has no customer record yet, the reads below answer 200 with customer: null and empty lists, not 404.

Your account

GET/api/account returns who you are and the organisation and customer the token is for.

{
  "success": true,
  "user": { "id": "…", "email": "you@example.com", "name": "…" },
  "organization": { "id": "…", "name": "…", "slug": "…", "role": "owner" },
  "customer": { "id": "…", "name": "…", "domain": "example.com", "status": "customer", "isPartner": false },
  "isInternal": false
}

customer is filled in only when your role has read:customers or read:partner_customers; otherwise it is null and the request still succeeds. customer.id is the customer ID that other endpoints take.

Services

GET/api/account/services lists your active services, newest first.

Endpoints

GET/api/account/endpoints returns customer and endpoints, sorted by display name. Each endpoint has id, displayName, systemName, dnsName, deviceType, integration, isOffline and lastContact. The list isn't paged.

Organisation and members

GET/api/account/organization returns:

• organization: the token's organisation, with id, name, displayName and your role. name is the organisation's short name (slug); displayName is the name people see.
• members: its members, each with userId, email, name and role.
• organizations: every organisation you belong to, in the same shape. role is set only for the token's organisation.

Billing summary

GET/api/account/billing returns an overview without Stripe IDs:

{
  "success": true,
  "billing": {
    "customer": { "id": "…", "name": "…", "domain": "…", "status": "customer", "isPartner": false },
    "hasStripeCustomer": true,
    "serviceCount": 3,
    "endpointCount": 12,
    "serviceTypes": ["cloudflare"]
  }
}

billing is null when your organisation has no customer record. Invoices and subscriptions are on Customers.

Open the billing portal

POST/api/billing/portal creates a Stripe Customer Portal session for your organisation's Stripe customer. It needs write:billing (owners and admins) and a sign-in from the last 10 minutes.

Send a new random UUID as operationId with each new request:

{ "operationId": "3f1c2a9e-8b7d-4c6e-9f10-2a3b4c5d6e7f" }

The body must contain only operationId. Sending the same operationId again returns the same portal session rather than creating another one, so you can retry safely.

{
  "success": true,
  "data": {
    "operationId": "3f1c2a9e-8b7d-4c6e-9f10-2a3b4c5d6e7f",
    "replayed": false,
    "url": "https://billing.stripe.com/p/session/…"
  }
}

Open data.url in a browser. The portal's return link goes to Billing in One (/dashboard/billing).

Customers billed through a partner manage billing with that partner, so the portal isn't available to them. See Billing.