Subscription - Billing

Billing account management for tenant subscriptions. Create and manage billing accounts, set up Direct Debit mandates via GoCardless, and view invoices. Only tenant administrators can access billing endpoints.

OpenAPI Spec

Guides Operations Schemas

GET Get Billing Account
Returns the billing account linked to this tenant, or 404 if billing has not been set up. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing
POST Start Subscription Billing
Creates a billing account for the tenant. The billing account name is set from the tenant name and the billing contact is set to the current user. Re...
/tenants/{tenant}/subscription/billing
PUT Update Billing Account
Updates the billing account's address and invoice recipients. Name and billing contact are not changeable. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing
POST Initiate Mandate Setup
Starts a GoCardless Direct Debit mandate setup. Returns a URL to redirect the user to for authorisation. If setup was already initiated in the last fe...
/tenants/{tenant}/subscription/billing/mandate-setup
POST Complete Mandate Setup
Completes the GoCardless Direct Debit mandate setup after the user has authorised it. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/mandate-setup/complete
POST Cancel Mandate
Cancels the active Direct Debit mandate for the tenant's billing account. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/mandate/cancel
GET Refresh Mandate Status
Fetches the current mandate status from GoCardless and updates the local record. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/mandate/refresh
GET List Invoices
Returns a paginated list of invoices for the tenant's billing account with optional filtering by status and date range. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/invoices
GET Download Invoice PDF
Downloads the invoice PDF. Returns 404 if the PDF has not been generated. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/invoices/{code}/pdf
GET Get Invoice
Returns the full invoice detail including line items. Use code 'draft' to get the current draft invoice. Requires: Admin on Billing.
/tenants/{tenant}/subscription/billing/invoices/{code}