Skip to content

Read one bill of fixed issues across every workspace whose billing you can read

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.

GET
/v1/settings/billing/all
curl --request GET \  --url https://api.xovris.ai/v1/settings/billing/all \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
billed
required
Array<object>
object
currency
required
string
amountMinor
required
number
left
required
number
workspaces
required
Array
One of:
object
billed
required
Array<object>
object
currency
required
string
amountMinor
required
number
settled
required
number
refunded
required
number
unproven
required
number
id
required
string
name
required
One of:
string
current
required
boolean
read
required
boolean
why
days
required
Array<object>
object
settled
required
number
refunded
required
number
day
required
string
settled
required
number
refunded
required
number
unproven
required
number
span
required
string
Allowed values: month year quarter
month
required
string
from
required
string
to
required
string
readAt
required
string
months
required
Array<string>

Example

{  "billed": [    {      "currency": "string",      "amountMinor": 1    }  ],  "left": 1,  "workspaces": [    {      "billed": [        {          "currency": "string",          "amountMinor": 1        }      ],      "settled": 1,      "refunded": 1,      "unproven": 1,      "id": "string",      "name": "string",      "current": true,      "read": true,      "why": null    }  ],  "days": [    {      "settled": 1,      "refunded": 1,      "day": "string"    }  ],  "settled": 1,  "refunded": 1,  "unproven": 1,  "span": "month",  "month": "string",  "from": "string",  "to": "string",  "readAt": "string",  "months": [    "string"  ]}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

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.