Skip to main content
GET
cURL

Escopo

O que faz

Retorna uma lista paginada das assinaturas vinculadas à sua conta. Utilize filtros, busca e ordenação para localizar assinaturas específicas, acompanhar assinaturas ativas, identificar cancelamentos ou alimentar integrações e relatórios.
Combine filtros de status e situação atual para analisar novas assinaturas, renovações e cancelamentos em períodos específicos.

Casos de uso

  • Consultar assinaturas ativas e canceladas
  • Localizar assinaturas específicas
  • Monitorar a saúde da receita recorrente
  • Alimentar relatórios e integrações

Filtros e busca

Busca (search) Localize rapidamente assinaturas utilizando informações relacionadas ao cliente, produto, oferta, pedido ou pagamento. Situação atual (current_situation) Permite diferenciar assinaturas recém-criadas de assinaturas já renovadas pelo menos uma vez.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

currency
string

Filtra por moeda. Usa 'BRL' por padrão se não informado.

limit
integer

Número de resultados a serem retornados por página.

ordering
string

Which field to use when ordering the results.

page
integer

Número da página a ser retornada.

A search term.

Response

count
integer
Example:

123

next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

results
object[]