Billing

What CIS Manager charges the authenticated user, across every tenant they own (no tenant in the route): kept in Account Hub, which invoices and collects: the billing details (invoice address and Direct Debit state), the Direct Debit mandate with its GoCardless setup through Account Hub (start a setup, send the customer to GoCardless, complete it), the Account Hub invoices with their PDFs, and the usage not yet charged.

GET Get Billing Profile
The caller's billing details from their Account Hub billing account: the address invoices are made out to and the state of their Direct Debit. An acco...
/me/billing/profile
PUT Update Billing Profile
Replaces the caller's billing address (company name, invoice email, address, postcode, country) on their Account Hub billing account, making the accou...
/me/billing/profile
GET Get Billing Mandate
The caller's Direct Debit mandate, its status refreshed from GoCardless through Account Hub. 404 until there is one.
/me/billing/mandate
PUT Complete Mandate Setup
Completes a Direct Debit setup the customer has finished on GoCardless: the redirect_flow_id GoCardless appended to the success URL. Returns the manda...
/me/billing/mandate
DELETE Cancel Billing Mandate
Cancels the caller's Direct Debit mandate. Automatic payments stop; a new setup can be started at any time. 404 when there is no mandate; 409 when the...
/me/billing/mandate
POST Create Mandate Setup
Starts a Direct Debit setup with GoCardless through Account Hub, making the billing account on first use. Send the customer's browser to the returned ...
/me/billing/mandate-setups
GET List Billing Usage
The usage not yet charged, across every tenant the caller owns: each monthly return HMRC has accepted, with the subcontractors on it. Charged at the e...
/me/billing/usage
GET List Billing Invoices
The caller's invoices from Sodium (Account Hub), latest first: their CIS Manager charges, with any other Sodium products the same billing account pays...
/me/billing/invoices
GET Get Billing Invoice PDF
The invoice as the PDF that was emailed. 404 when the invoice is not the caller's or has no PDF yet (hasPdf).
/me/billing/invoices/{invoice}/pdf