HomeGuiaAPI ReferenceNovidadesComunidade
API Reference

Listar assinantes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Este recurso possibilita que você liste todos os assinantes criados previamente.

📘

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 do assinante, e sim a uma referência adicionada durante o processo de importação. Caso você deseje fazer uma consulta utilizando o customer_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 assinantes.

Query Params
int32

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

int32

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

string

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

Headers
string
required
Defaults to Bearer <token>

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

string

Informação complementar de identificação. Forneça apenas uma das seguintes informações:
- Número do documento do assinante (CPF ou CNPJ).
- Nome do assinante.
- E-mail do assinante.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001