Skip to main content
GET
cURL

Escopo

O que faz

Gera e retorna um arquivo Excel (.xlsx) com os dados das assinaturas da sua conta. Utilize este endpoint para extrair a base completa de assinaturas e trabalhar com os dados em planilhas, relatórios de BI ou compartilhamentos internos.

Casos de uso

  • Consolidar a base de assinaturas para relatórios financeiros
  • Cruzar dados de assinaturas com outras fontes em planilhas
  • Compartilhar listagens com times de suporte, financeiro ou jurídico
  • Arquivar snapshots mensais da base recorrente

Filtros

O endpoint aceita os mesmos filtros de busca, status e situação atual disponíveis na listagem de assinaturas. Utilize-os para exportar apenas o segmento desejado.
Combine filtros antes de exportar para gerar relatórios segmentados. Por exemplo, exporte apenas assinaturas ativas com PIX para conciliação bancária.

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

amount
number
amount__gt
number
amount__gte
number
amount__lt
number
amount__lte
number
canceledAt
string<date-time>
canceledAt__gt
string<date-time>
canceledAt__gte
string<date-time>
canceledAt__lt
string<date-time>
canceledAt__lte
string<date-time>
createdAt
string<date-time>
createdAt__gt
string<date-time>
createdAt__gte
string<date-time>
createdAt__lt
string<date-time>
createdAt__lte
string<date-time>
currency
string

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

current_period
integer
current_period__gt
integer
current_period__gte
integer
current_period__lt
integer
current_period__lte
integer
current_situation
string
id
string[]

Valores múltiplos podem ser separados por vírgulas.

limit
integer

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

max_retries
integer
max_retries__gt
integer
max_retries__gte
integer
max_retries__lt
integer
max_retries__lte
integer
next_payment_date
string<date-time>
next_payment_date__gt
string<date-time>
next_payment_date__gte
string<date-time>
next_payment_date__lt
string<date-time>
next_payment_date__lte
string<date-time>
ordering
string

Which field to use when ordering the results.

page
integer

Número da página a ser retornada.

paid_payments_quantity
integer
paid_payments_quantity__gt
integer
paid_payments_quantity__gte
integer
paid_payments_quantity__lt
integer
paid_payments_quantity__lte
integer
paymentMethod
string[]

Valores múltiplos podem ser separados por vírgulas.

quantity_recurrences
integer
quantity_recurrences__gt
integer
quantity_recurrences__gte
integer
quantity_recurrences__lt
integer
quantity_recurrences__lte
integer
recurrence_period
integer
recurrence_period__gt
integer
recurrence_period__gte
integer
recurrence_period__lt
integer
recurrence_period__lte
integer
retry_interval
integer
retry_interval__gt
integer
retry_interval__gte
integer
retry_interval__lt
integer
retry_interval__lte
integer

A search term.

status
string[]

Valores múltiplos podem ser separados por vírgulas.

trial_days
integer
trial_days__gt
integer
trial_days__gte
integer
trial_days__lt
integer
trial_days__lte
integer
updatedAt
string<date-time>
updatedAt__gt
string<date-time>
updatedAt__gte
string<date-time>
updatedAt__lt
string<date-time>
updatedAt__lte
string<date-time>

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[]