--- title: "Listar faturas" url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-faturas-1" --- > Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md # Listar faturas `GET` `/invoices` Operation ID: `listar-faturas-1` Este recurso permite listar os descontos associados a uma assinatura. Pode ser utilizados alguns parâmetros como filtro da listagem. ## Query parameters - `status` (string, optional) - Status das faturas. Valores possíveis: **pending**, **paid**, **canceled**, **scheduled** ou **failed** - `customer_id` (string, optional) - Código do cliente. - `subscription_id` (string, optional) - Código da fatura. - `due_since` (string, date, optional) - Data de início do período de vencimento a ser listado. - `due_until` (string, date, optional) - Data final do período de vencimento a ser listado. - `created_since` (string, date, optional) - Data de início do período de criação a ser listado. - `created_until` (string, date, optional) - Data final do período de criação a ser listado. - `page` (integer, int32, optional) - Página atual. - `size` (integer, int32, optional) - Quantidade de itens por página. ## Responses - `200` - 200 - `401` - 401 ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Pagar.me v5 API (Legado) version: 5.0.0 servers: - url: https://api.stone.com.br/core/v5 paths: /invoices: get: summary: Listar faturas description: Este recurso permite listar os descontos associados a uma assinatura. Pode ser utilizados alguns parâmetros como filtro da listagem. operationId: listar-faturas-1 parameters: - name: status in: query description: "Status das faturas. Valores possíveis: **pending**, **paid**, **canceled**, **scheduled** ou **failed**" schema: type: string - name: customer_id in: query description: Código do cliente. schema: type: string - name: subscription_id in: query description: Código da fatura. schema: type: string - name: due_since in: query description: Data de início do período de vencimento a ser listado. schema: type: string format: date - name: due_until in: query description: Data final do período de vencimento a ser listado. schema: type: string format: date - name: created_since in: query description: Data de início do período de criação a ser listado. schema: type: string format: date - name: created_until in: query description: Data final do período de criação a ser listado. schema: type: string format: date - name: page in: query description: Página atual. schema: type: integer format: int32 default: 1 - name: size in: query description: Quantidade de itens por página. schema: type: integer format: int32 default: 10 responses: "200": description: "200" content: application/json: examples: Result: value: >- { "data": [ { "id": "in_DnQj6J8iWhEg0MrK", "code": "0E6RC91AE1", "url": "/invoices/in_DnQj6J8iWhEg0MrK", "amount": 1490, "status": "paid", "payment_method": "credit_card", "due_at": "2017-04-04T00:00:00Z", "created_at": "2017-04-04T15:54:46Z", "items": [ { "name":"Nome - teste", "amount": 1490, "quantity": 1, "description": "Bola" } ], "customer": { "id": "cus_J4wRXJ0U6ytZrpAx", "name": "Tony Star8k", "email": "tstark@avengers.com", "delinquent": false, "created_at": "2016-09-28T21:04:37Z", "updated_at": "2017-04-04T15:08:20Z" }, "subscription": { "id": "sub_49O5RwPh5sl0wyqM", "code": "G2X5F99FXX", "start_at": "2017-04-04T00:00:00Z", "interval": "month", "interval_count": 1, "billing_type": "postpaid", "next_billing_at": "2017-05-04T00:00:00Z", "payment_method": "credit_card", "currency": "BRL", "statement_descriptor": "Spotify", "installments": 1, "status": "active", "created_at": "2017-04-04T15:54:19Z", "updated_at": "2017-04-04T15:54:19Z" }, "cycle": { "id": "cycle_O6vXjrvUbecMjpgq", "start_at": "2017-04-04T00:00:00Z", "end_at": "2017-05-03T23:59:59Z", "billing_at": "2017-05-04T00:00:00Z" }, "charge": { "id": "ch_1DaVYVQCds28rOm3", "code": "G2X5F99FXX-01", "gateway_id": "1e3a21f7-ad65-4ad0-a68c-3eb37e8115c9", "amount": 1490, "status": "paid", "currency": "BRL", "payment_method": "credit_card", "due_at": "2017-04-04T00:00:00Z", "paid_at": "2017-04-04T15:54:49Z", "created_at": "2017-04-04T15:54:46Z", "updated_at": "2017-04-04T15:54:46Z" } } ], "paging": { "total": 1 } } schema: type: object properties: data: type: array items: type: object properties: id: type: string example: in_DnQj6J8iWhEg0MrK code: type: string example: 0E6RC91AE1 url: type: string example: /invoices/in_DnQj6J8iWhEg0MrK amount: type: integer example: 1490 default: 0 status: type: string example: paid payment_method: type: string example: credit_card due_at: type: string example: 2017-04-04T00:00:00Z created_at: type: string example: 2017-04-04T15:54:46Z items: type: array items: type: object properties: name: type: string example: Nome - teste amount: type: integer example: 1490 default: 0 quantity: type: integer example: 1 default: 0 description: type: string example: Bola customer: type: object properties: id: type: string example: cus_J4wRXJ0U6ytZrpAx name: type: string example: Tony Star8k email: type: string example: tstark@avengers.com delinquent: type: boolean example: false default: true created_at: type: string example: 2016-09-28T21:04:37Z updated_at: type: string example: 2017-04-04T15:08:20Z subscription: type: object properties: id: type: string example: sub_49O5RwPh5sl0wyqM code: type: string example: G2X5F99FXX start_at: type: string example: 2017-04-04T00:00:00Z interval: type: string example: month interval_count: type: integer example: 1 default: 0 billing_type: type: string example: postpaid next_billing_at: type: string example: 2017-05-04T00:00:00Z payment_method: type: string example: credit_card currency: type: string example: BRL statement_descriptor: type: string example: Spotify installments: type: integer example: 1 default: 0 status: type: string example: active created_at: type: string example: 2017-04-04T15:54:19Z updated_at: type: string example: 2017-04-04T15:54:19Z cycle: type: object properties: id: type: string example: cycle_O6vXjrvUbecMjpgq start_at: type: string example: 2017-04-04T00:00:00Z end_at: type: string example: 2017-05-03T23:59:59Z billing_at: type: string example: 2017-05-04T00:00:00Z charge: type: object properties: id: type: string example: ch_1DaVYVQCds28rOm3 code: type: string example: G2X5F99FXX-01 gateway_id: type: string example: 1e3a21f7-ad65-4ad0-a68c-3eb37e8115c9 amount: type: integer example: 1490 default: 0 status: type: string example: paid currency: type: string example: BRL payment_method: type: string example: credit_card due_at: type: string example: 2017-04-04T00:00:00Z paid_at: type: string example: 2017-04-04T15:54:49Z created_at: type: string example: 2017-04-04T15:54:46Z updated_at: type: string example: 2017-04-04T15:54:46Z paging: type: object properties: total: type: integer example: 1 default: 0 "401": description: "401" content: application/json: examples: Result: value: >- { "message": "Authorization has been denied for this request." } schema: type: object properties: message: type: string example: Authorization has been denied for this request. deprecated: false security: - sec0: [] components: securitySchemes: sec0: type: http scheme: basic ```