> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar Faturas
> Retorna as faturas (pedidos) geradas para uma assinatura, com suporte a filtro por status e limite. Cada fatura inclui seus itens e cobranças associadas. Os valores monetários são retornados em centavos. Esta rota NÃO retorna o envelope APIReturnUtil; retorna diretamente `{"data": [...]}`.
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`.
## OpenAPI
````yaml GET /v1/subscriptions/{subscription_code}/invoices
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
paths:
/v1/subscriptions/{subscription_code}/invoices:
get:
tags:
- Assinaturas
summary: Listar faturas da assinatura
description: >
Retorna as faturas (pedidos) geradas para uma assinatura, com suporte a
filtro por status e limite. Cada fatura inclui seus itens e cobranças
associadas. Os valores monetários são retornados em centavos. Esta rota
NÃO retorna o envelope APIReturnUtil; retorna diretamente `{"data":
[...]}`.
operationId: listSubscriptionInvoices
parameters:
- $ref: '#/components/parameters/AccountHeader'
- name: subscription_code
in: path
required: true
description: Código único da assinatura
schema:
type: string
example: sub_abc123
- name: status
in: query
required: false
description: Filtrar faturas por status (StatusOrder)
schema:
type: string
enum:
- New
- Canceled
- Paid
- ChargeBack
- Reversed
- PartialReversed
- Reproved
- Pending
- Fail
- Challenged
- Unprocessed
example: Paid
- name: limit
in: query
required: false
description: Quantidade máxima de faturas a retornar (1-100)
schema:
type: integer
minimum: 1
maximum: 100
example: 20
responses:
'200':
description: Lista de faturas retornada com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/InvoicesListResponse'
example:
data:
- subscription_code: sub_abc123
code: ord_xyz456
status: Paid
amount: 9990
attempts: 1
created_at: '2026-03-11T10:00:00.000000Z'
items:
- id: item_abc123
unitary_amount: 9990
quantity: 1
code: plano_premium
name: Acesso Premium Mensal
charges:
- code: chg_abc123
status: Paid
amount: 9990
payment_type: CreditCard
installments: 1
account_client_card_id: card_abc123
payment:
type: CreditCard
card:
id: card_abc123
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Assinatura não encontrada ou não pertence à conta
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Um erro inesperado acabou de acontecer.
erro: true
mensagenserro:
- Assinatura não encontrada ou não pertence à conta informada.
codigoretorno: 404
id: 00000000-0000-0000-0000-000000000000
data: []
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
InvoicesListResponse:
type: object
description: >
Resposta da listagem de faturas. Esta rota NÃO usa o envelope
APIReturnUtil; retorna diretamente um objeto com a propriedade `data`.
properties:
data:
type: array
items:
$ref: '#/components/schemas/InvoiceItem'
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
InvoiceItem:
type: object
properties:
subscription_code:
type: string
description: Código da assinatura
example: sub_abc123
code:
type: string
description: Código do pedido (fatura)
example: ord_xyz456
status:
type: string
description: Status do pedido (StatusOrder)
enum:
- New
- Canceled
- Paid
- ChargeBack
- Reversed
- PartialReversed
- Reproved
- Pending
- Fail
- Challenged
- Unprocessed
example: Paid
amount:
type: integer
description: Valor total em centavos
example: 9990
attempts:
type: integer
description: Número de tentativas de cobrança
example: 1
created_at:
type: string
format: date-time
example: '2026-03-11T10:00:00.000000Z'
items:
type: array
items:
$ref: '#/components/schemas/InvoiceItemProduct'
charges:
type: array
items:
$ref: '#/components/schemas/InvoiceItemCharge'
InvoiceItemProduct:
type: object
properties:
id:
type: string
description: ID do item (account_item_id)
example: item_abc123
unitary_amount:
type: integer
description: Valor unitário em centavos
example: 9990
quantity:
type: integer
example: 1
code:
type: string
description: Código do item
example: plano_premium
name:
type: string
description: Nome do item
example: Acesso Premium Mensal
InvoiceItemCharge:
type: object
properties:
code:
type: string
description: Código da cobrança
example: chg_abc123
status:
type: string
description: Status da cobrança
example: Paid
amount:
type: integer
description: Valor em centavos
example: 9990
payment_type:
type: string
description: Método de pagamento
example: CreditCard
installments:
type: integer
example: 1
account_client_card_id:
type: string
nullable: true
description: ID do cartão do cliente (se cartão)
example: card_abc123
payment:
type: object
properties:
type:
type: string
description: Tipo de pagamento
example: CreditCard
pix:
type: object
nullable: true
description: Presente apenas quando payment_type é PIX
properties:
qrcode_url:
type: string
example: https://api.example.com/pix/qrcode
copy_paste:
type: string
example: 00020101021226...
expiration:
type: string
format: date-time
example: '2026-03-11T10:30:00.000000Z'
card:
type: object
nullable: true
description: Presente apenas quando payment_type é CreditCard
properties:
id:
type: string
example: card_abc123
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````