Skip to main content
GET
/
public_api
/
subscriptions
/
{id}
/
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/subscriptions/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "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 todas as informações disponíveis de uma assinatura, incluindo status, método de pagamento, período atual, situação e dados do pedido de origem. Utilize este endpoint para validar o estado de uma assinatura antes de executar ações como pausa, cancelamento ou troca de método de pagamento.

​
Casos de uso

  • Consultar o status e detalhes de uma assinatura no suporte ao cliente
  • Validar o estado da assinatura antes de executar uma ação
  • Exibir informações da assinatura em painéis e integrações
  • Rastrear o histórico e ciclo de cobrança de um cliente específico

​
Parâmetro

id (path) — Identificador único da assinatura retornado pela Cakto.

​
Erros

StatusDescrição
404Assinatura não encontrada ou não pertence ao contexto do token.
O id deve ser o identificador da assinatura, não do pedido de origem.

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.

Path Parameters

​
id
string<uuid>
required

Id da assinatura.

Response

Dados completos da assinatura.

​
id
string
required

Identificador único da assinatura

Maximum string length: 255
​
status
enum<string>
required

Status atual da assinatura

Available options:
active,
inactive,
canceled,
expired,
paused,
trial
​
amount
string<decimal>
required

Valor da assinatura

​
parent_order
object
required

Pedido de origem da assinatura

​
paymentMethod
object
required

Método de pagamento usado na assinatura

​
customer
object
required

Cliente associado à assinatura

​
product
object
required

Produto associado à assinatura

​
offer
object
required

Oferta associada à assinatura

​
createdAt
string<date-time>
required
read-only

Data de criação

​
updatedAt
string<date-time>
required
read-only

Data da última atualização

​
current_period
integer

Período atual da assinatura

​
recurrence_period
integer

Quantidade de dias entre cada cobrança

​
quantity_recurrences
integer

Quantidade total de recorrências configuradas

​
trial_days
integer

Dias de teste configurados na assinatura

​
max_retries
integer

Número máximo de tentativas de cobrança

​
retry_interval
integer

Intervalo entre tentativas de cobrança

​
paid_payments_quantity
integer

Quantidade de pagamentos já efetuados

​
retention
string

Tempo em que a assinatura permaneceu ativa

​
orders
object[]

Pedidos vinculados à assinatura

​
next_payment_date
string<date-time> | null

Data estimada do próximo pagamento

​
canceledAt
string<date-time> | null

Data de cancelamento