Skip to main content
GET
Listar faturas da assinatura
As faturas vêm da mais recente para a mais antiga. Use limit (padrão 10, máximo 100) e o filtro opcional status.
A listagem não tem paginação por cursor. A resposta traz apenas as primeiras limit faturas e o campo has_more, que indica se existem outras além delas. Não há como buscar a página seguinte.
O filtro status aceita paid, failed, pending, canceled, refunded, partially_refunded e chargeback. O valor pending reúne as faturas em andamento, exibidas como processing ou requires_action.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

Query Parameters

status
enum<string>

Filtra as faturas pelo status

Available options:
paid,
failed,
pending,
canceled,
refunded,
partially_refunded,
chargeback
limit
integer
default:10

Quantidade máxima de faturas

Required range: 1 <= x <= 100

Response

Lista de faturas

object
enum<string>
Available options:
list
data
object[]
has_more
boolean

Existem mais faturas além do limit. A listagem não tem cursor de paginação