Essa rota é utilizada para retornar os dados de todas assinaturas.
Atenção: Essa versão de API será descontinuada
Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.
No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.
Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.
Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.
Filtros de objetos
Para filtrar por chaves nested de objetos usa-se a sintaxe de chaves. Por exemplo:
curl -X GET https://api.pagar.me/1/subscriptions \ -d 'api_key=SUA_API_KEY' -d 'metadata[chave]=valor'
Filtros de range
Todos os filtros mencionados podem ser usados para buscas em ranges usando os prefixos:
Prefixo Significado < menor que > maior que <= menor ou igual a > = maior ou igual a Por exemplo, para buscar em um range de date_created:
curl -X GET https://api.pagar.me/1/subscriptions \ -d 'api_key=SUA_API_KEY' -d 'date_created=>=1483236000000' -d 'date_created=<=1484689847590'Para campos que sejam strings, a comparação é lexicográfica, letras maiúsculas sendo 'maiores' que minúsculas.
Exemplo de paginação utilizando cursor
A primeira requisição da paginação não contém o parâmetro cursor visto que ainda nenhum token foi retornado. Segue abaixo o exemplo da primeira requisição:
curl -X GET https://api.pagar.me/1/subscriptions \ -d 'api_key=SUA_API_KEY'No retorno da requisição anterior, será retornado nos headers da resposta os parâmetros x-cursor-previouspagr e x-cursor-nextpage, onde o primeiro será vazio (porque não existe uma pagina anterior no momento) e o segundo conterá o Token de acesso a próxima página.
Dito isto, para acessar a próxima página da listagem, devemos informar dentro do campo cursor o Token retornado no parâmetro x-cursor-nextpage da resposta, como mostra a requisição abaixo:
curl -X GET https://api.pagar.me/1/subscriptions \ -d 'api_key=SUA_API_KEY' -d 'cursor=TOKEN_RETORNADO_NO_CURSOR_NEXTPAGE'Para ir avançando para as próximas páginas da listagem, basta ir substituindo o Token passado no parâmetro cursor pelo Token retornado em casa resposta da requisição.
Para consultar a página anterior de uma listagem seguimos a mesma estrutura, onde o que muda é apenas o Token informado no parâmetro cursor, como mostra o exemplo abaixo:
curl -X GET https://api.pagar.me/1/subscriptions \ -d 'api_key=SUA_API_KEY' -d 'cursor=TOKEN_RETORNADO_NO_CURSOR_PREVIOUSPAGE'
Filtros de data
É importante notar o formato das datas para o filtro. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome e utilizar o seguinte código em Javascript :
new Date("2017-12-25T02:00:00.000Z").getTime()que retornará
1514167200000. Da mesma maneira, para criar uma data ISO date, basta fazer:new Date().toISOString()
Rate Limit
Essa rota possui um limite de requisições.
Caso você ultrapasse esse valor será retornado o erro “StatusCode 429” por nossa API.Para saber qual o limite dessa e demais rotas acesse : Rate Limit