Listar assinaturas

get https://sandbox.api.assinaturas.pagseguro.com/subscriptions

Utilize esse recurso para recuperar os dados de todas as assinaturas associadas a sua conta.

📘
Sobre o parâmetro reference_id
O parâmetro reference_id disponibilizado nesse endpoint é destinado a clientes que tiveram seus dados importados de uma fonte externa ao PagBank. Portanto, eles não se referem ao id da assinatura, e sim a uma referência adicionada durante o processo de importação. Caso você deseje fazer uma consulta utilizando o subscription_id, utilize o endpoint Consultar por id.

📘
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.

Query Params

reference_id

string

Identificador único da assinatura na sua aplicação importada para o sistema PagBank (Max 65 caracteres).

Status

array of strings

Status das assinaturas. Opções disponíveis:
- ACTIVE
- EXPIRED
- CANCELED
- SUSPENDED
- OVERDUE
- TRIAL
-PENDING
- PENDING_ACTION

Status

payment_method_type

array of strings

Forma de pagamento da assinatura. Opções disponíveis:
- BOLETO
- CREDIT_CARD

payment_method_type

created_at_start

date

Data de início do intervalo de busca. Exemplo: 2000-12-20

created_at_end

date

Data final do intervalo de busca. Exemplo: 2020-01-02

Headers

Authorization

string

required

Defaults to Bearer <token>

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

string

Campo de busca de pagamentos. Forneça apenas uma das seguintes informações:
- Nome do assinante.
-E-mail do assinante.
- id da assinatura.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.api.assinaturas.pagseguro.com/subscriptions \
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

📘Sobre o parâmetro reference_id

📘

200200

400400

📘
Sobre o parâmetro `reference_id`