Skip to main content
GET
Listar faturas da assinatura
Requer o header account. Retorna as faturas (pedidos) geradas para a assinatura, com seus itens e cobranças. A resposta retorna diretamente {"data": [...]}, sem o envelope padrão APIReturnUtil. Todos os valores monetários (amount, unitary_amount) são retornados em centavos.
Filtre por status usando os valores do enum StatusOrder: New, Canceled, Paid, ChargeBack, Reversed, PartialReversed, Reproved, Pending, Fail, Challenged, Unprocessed.

Authorizations

Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Path Parameters

subscription_code
string
required

Código único da assinatura

Example:

"sub_abc123"

Query Parameters

status
enum<string>

Filtrar faturas por status (StatusOrder)

Available options:
New,
Canceled,
Paid,
ChargeBack,
Reversed,
PartialReversed,
Reproved,
Pending,
Fail,
Challenged,
Unprocessed
Example:

"Paid"

limit
integer

Quantidade máxima de faturas a retornar (1-100)

Required range: 1 <= x <= 100
Example:

20

Response

Lista de faturas retornada com sucesso

Resposta da listagem de faturas. Esta rota NÃO usa o envelope APIReturnUtil; retorna diretamente um objeto com a propriedade data.

data
object[]