Read your invoices, in exact amounts, and how payment is set up
What you can call today
Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.
const url = 'https://api.xovris.ai/v1/settings/billing';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/settings/billing \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
Example
{ "fixed": { "span": "month", "month": "string", "months": [ "string" ], "readAt": "string", "from": "string", "to": "string", "lines": [ { "resolutionId": "string", "incidentId": "string", "title": "string", "state": "settled", "fixedAt": "string", "refundedAt": "string", "refundReason": "string", "proof": { "runId": "string", "receipt": { "outcome": "string", "at": "string" }, "before": { "passed": true, "digest": "string", "at": "string" }, "after": { "passed": true, "digest": "string", "at": "string" } }, "proven": true } ], "settled": 1, "refunded": 1, "unproven": 1 }, "invoices": [ { "id": "string", "number": "string", "amountMinor": 1, "currency": "string", "status": "string", "periodStart": "string", "periodEnd": "string", "pdfUrl": null, "hostedUrl": null } ], "paymentMethod": null, "portalUrl": null, "provider": { "connected": true, "why": "string", "next": "string" }}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Signed in, but this token or role may not do this. The answer names the permission it needs.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Nothing with that id here, or it belongs to another workspace. Nothing was changed.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Your data is never used to train our AI. How your data is kept
A problem is called fixed only once it works again. How each fix is checked
XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.