Skip to main content
GET
/
api
/
v1
/
invoices
Listar todas as faturas
curl --request GET \
  --url https://besimplo.com/api/v1/invoices \
  --header 'Authorization: <api-key>'
{
  "object": "list",
  "url": "/api/v1/invoices",
  "has_more": false,
  "data": [
    {
      "id": "in_01h455vb4pex5vsknk084sn02q",
      "object": "invoice",
      "amount_due": 9990,
      "created": 1704672000,
      "currency": "brl",
      "customer": "cus_01h455vb4pex5vsknk084sn02p",
      "live_mode": true,
      "status": "open",
      "total": 9990,
      "amount_paid": 0,
      "amount_remaining": 9990,
      "customer_email": "joao.silva@exemplo.com",
      "customer_name": "João Silva",
      "paid": false,
      "status_transitions": {
        "paid_at": 1704758400
      },
      "subscription": "sub_01h455vb4pex5vsknk084sn02s"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

​
customer
string

Filtrar pelo ID do cliente (TypeID com prefixo cus_).

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

​
subscription
string

Filtrar pelo ID da assinatura (TypeID com prefixo sub_).

Pattern: ^sub_[0-9a-z]{26}$
Example:

"sub_01h455vb4pex5vsknk084sn02s"

​
status
enum<string>

Filtrar por status

Available options:
draft,
open,
paid,
uncollectible,
void
​
limit
integer
default:20

Resultados por página

Required range: 1 <= x <= 100
​
page
string

Cursor para próxima página

Response

Lista de faturas

​
object
enum<string>
required

String representando o tipo do objeto. Sempre "list" para listas.

Available options:
list
Example:

"list"

​
url
string<uri-reference>
required

URL do recurso solicitado.

Example:

"/api/v1/invoices"

​
has_more
boolean
required

Indica se há mais resultados disponíveis para paginação.

Example:

false

​
data
object[]
required

Lista de faturas.