These docs are for v2. Click to read the latest docs for v5.

Retornando assinaturas

get

https://api.pagar.me/1/subscriptions

Essa rota é utilizada para retornar os dados de todas assinaturas.

Query Params

string

Filtro por id

payment_method

string

Filtro pelo meio de pagamento

card_brand

string

Filtro pela bandeira do cartão

card_last_digits

string

Filtro pelos 4 ultimos dígitos do cartão

current_period_start

date

Filtro pelo começo do período atual da assinatura em ISODate

current_period_end

date

Filtro pelo fim do período atual em ISODate

status

string

Filtro pelo status da assinatura

date_created

date-time

Filtro pela data de criação

metadata

json

Filtro pelo metadata

count

int32

Defaults to 10

Retorna n resultados, com um máximo de 1000

cursor

int32

Defaults to 1

Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.

x-cursor-nextpage

string

Retornado nos headers da resposta contém o Token que permite acesso a próxima página.

x-cursor-previouspage

string

Retornado nos headers da resposta contém o Token que permite acesso a página anterior.

date_updated

date-time

Filtro pela data de atualização da assinatura

Response

Language

Credentials

Query

Request

Response

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

application/json

Transaction IDs

200200