Skip to content
Xaalis

List invoices

GET
/v1/invoices
curl --request GET \
  --url 'http://localhost:4000/v1/invoices?limit=20&status=open' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 100
starting_after
string
subscription
string
status
string
Allowed values: open paid void uncollectible

Responses

Section titled “ Responses ”

200

Section titled “200”

Invoices

Media typeapplication/json
object
object
required
string
Allowed values: list
data
required
Array<object | null>
object
id
required
string
object
required
string
Allowed values: invoice
livemode
required
boolean
subscription
required
string
period_index
required
integer
period_start
required
string
period_end
required
string
amount
required
integer
currency
required
string
Allowed values: XOF
status
required
string
Allowed values: open paid void uncollectible
payment
required

Current payment attempt; a confirmed failed attempt may be replaced

string | null
hosted_invoice_url
required

Stable customer link, payable until grace_ends_at

string format: uri
due_at
required

Invoice becomes overdue after this time but remains payable during grace

string
grace_ends_at
required
string
paid_at
required
string | null
reminders_sent
required
integer
created_at
required
string
has_more
required
boolean
Example
{
  "object": "list",
  "data": [
    {
      "object": "invoice",
      "currency": "XOF",
      "status": "open"
    }
  ]
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Authentication error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}