Listar faturas de uma assinatura

get https://sandbox.api.assinaturas.pagseguro.com/subscriptions/{subscription_id}/invoices

time	status	user agent
Retrieving recent requests…

Loading…

Utilize esse recurso para recuperar os dados de faturas associadas a uma fatura. Você tem a opção de filtrar os tipos de fatura de acordo com o status desejado e utilizar paginação para melhorar a organização das informações recebidas.

📘
Acesse o guia do serviço de Pagamentos Recorrentes para mais informações sobre seu funcionamento e funcionalidades disponíveis.
Você também pode consultar o guia específico da funcionalidade de assinaturas.

Path Params

subscription_id

string

required

Identificador único da assinatura que deseja consultar. Formato SUBS_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

Query Params

status

string

enum

Defaults to PAID,UNPAID,WAITING,OVERDUE

Status das faturas que deseja consultar. Se não for definido, todas as faturas associadas a assinatura serão retornadas.

Allowed:

offset

int32

Defaults to 0

Número da página que deseja consultar. Deve ser um valor igual ou maior que zero, representando o deslocamento da página desejada.

limit

int32

Defaults to 100

Tamanho da página desejada. Este valor determina a quantidade de resultados a serem retornados em uma única consulta.

Headers

Authorization

string

required

Defaults to Bearer <token>

Token de autenticação. Deve ser enviado no formato Bearer <token>.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.api.assinaturas.pagseguro.com/subscriptions/subscription_id/invoices?status=PAID%2CUNPAID%2CWAITING%2COVERDUE&offset=0&limit=100' \
3
     --header 'Authorization: Bearer <token>' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘

200200

400400