Listar Assinaturas

get

https://api.iugu.com/v1/subscriptions

Retorna uma lista com as assinaturas geradas pela sua conta, ordenadas pela data de criação, da mais nova para a mais antiga. O campo totalItems indica a quantidade de registros retornados nesta página (igual ao tamanho de items ). Para detectar o fim da listagem, compare items.length com limit : se for menor, não há mais páginas.

❗️
Importante - Limites de Busca

Janela padrão de 7 dias: sem filtro de data, customer_id ou
plan_identifier, retorna apenas assinaturas atualizadas nos últimos 7 dias.

Janela máxima de 90 dias entre updated_since e updated_until. Não se
aplica com customer_id ou plan_identifier.

Paginação profunda: start > 100 exige customer_id ou
plan_identifier. Sem isso, retorna 400 Bad Request.

Query Params

limit

int32

Limita em até 100 o número de registros listados.

start

int32

Quantos registros pular do início da pesquisa, utilizado para paginação

created_at_from

date

Registros criados a partir do momento passado no parâmetro

created_at_to

date

Registros criados até o momento passado no parâmetro

query

string

Texto para pesquisa. Ao utilizar, deve-se usar paginação (limit, start, etc)

updated_since

date

Registros atualizados desde o momento passado no parâmetro

updated_until

date

Registros atualizados até o momento passado no parâmetro

customer_id

string

ID do Cliente

status_filter

string

Usado para filtrar as assinaturas pelo status (due, active, suspended)

plan_identifier

string

Identificador único de plano, usado para filtrar assinaturas.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Query

Loading…

Response

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

application/json

text/plain

Importante - Limites de Busca

200200

400400