Skip to content

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.

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

A token that can read is enough.

Done.

Media typeapplication/json
object
fixed
required
object
span
required
string
Allowed values: month year quarter
month
required
string
months
required
Array<string>
readAt
required
string
from
required
string
to
required
string
lines
required
Array<object>
object
resolutionId
required
string
incidentId
required
string
title
required
string
state
required
string
Allowed values: settled refunded
fixedAt
required
One of:
string
refundedAt
required
One of:
string
refundReason
required
One of:
string
proof
required
One of:
object
runId
required
string
receipt
required
One of:
object
outcome
required
string
at
required
string
before
required
One of:
object
passed
required
boolean
digest
required
string
at
required
string
after
required
One of:
object
passed
required
boolean
digest
required
string
at
required
string
proven
required
boolean
settled
required
number
refunded
required
number
unproven
required
number
invoices
required
Array<object>
object
id
required
string
number
required
string
amountMinor
required
number
currency
required
string
status
required
string
periodStart
required
One of:
string
periodEnd
required
One of:
string
pdfUrl
required
null
hostedUrl
required
null
paymentMethod
required
null
portalUrl
required
null
provider
required
object
connected
required
boolean
why
required
string
next
required
string

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.

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.