Skip to main content
GET
/
public_api
/
subscriptions
/
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/subscriptions/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "<string>",
      "amount": "<string>",
      "parent_order": {},
      "paymentMethod": {},
      "customer": {},
      "product": {},
      "offer": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "current_period": 123,
      "recurrence_period": 123,
      "quantity_recurrences": 123,
      "trial_days": 123,
      "max_retries": 123,
      "retry_interval": 123,
      "paid_payments_quantity": 123,
      "retention": "<string>",
      "orders": [
        {}
      ],
      "next_payment_date": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Escopo

    read subscriptions

​
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.
ValorDescrição
newAssinatura recém-criada
renewedAssinatura já renovada 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

​
limit
integer

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

​
page
integer

Número da página a ser retornada.

​
search
string

Busca por cliente, produto, oferta, pedido ou pagamento.

​
ordering
enum<string>

Ordenação dos resultados.

Available options:
status,
amount,
paymentMethod,
createdAt,
updatedAt,
canceledAt,
next_payment_date
​
status
enum<string>

Filtra por status da assinatura.

  • active - Ativa
  • inactive - Inativa
  • canceled - Cancelada
  • expired - Expirada
  • paused - Pausada
  • trial - Em período de teste
Available options:
active,
inactive,
canceled,
expired,
paused,
trial
​
paymentMethod
string

Filtra por método de pagamento.

​
current_situation
enum<string>

Filtra pela situação atual da assinatura.

Available options:
new,
renewed

Response

Lista de assinaturas retornada com sucesso.

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