Descrição das propriedades do response do endpoint Criar Assinatura — POST v1/subscriptions
| Propriedade | Descrição |
|---|---|
id | Identificador único da assinatura. |
suspended | Indica se a assinatura está suspensa (true ou false). |
plan_identifier | Identificador do plano. |
price_cents | Preço da assinatura em centavos (ex: 1000 representa R$ 10,00). |
currency | Moeda da assinatura (ex: "BRL"). |
features | Características do plano. |
customer_name | Nome do cliente. |
customer_email | E-mail do cliente. |
cycled_at | Data do último ciclo da assinatura. |
credits_min | Créditos mínimos disponíveis. |
credits_cycle | Créditos por ciclo. |
payable_with | Métodos de pagamento aceitos (ex: "credit_card", "bank_slip", "pix"). |
ignore_due_email | Ignorar e-mail de vencimento. |
max_cycles | Número máximo de ciclos. |
cycles_count | Contagem de ciclos. |
recent_invoices | Faturas recentes associadas à assinatura. |
subitems | Subitens associados à assinatura. |
logs | Logs de atividades relacionadas à assinatura. |
custom_variables | Variáveis personalizadas associadas à assinatura. |
expires_at | Data de expiração da assinatura. |
created_at | Data e hora em que a assinatura foi criada. |
updated_at | Data e hora da última atualização/edição da assinatura. |
customer_id | Identificador único do cliente. |
plan_name | Nome do plano. |
customer_ref | Nome do cliente. Mesmo valor de customer_name. |
plan_ref | Nome do plano. Mesmo valor de plan_identifier. |
active | Indica se a assinatura está ativa ou não. |
two_step | Indica se a assinatura requer autenticação em dois passos (true ou false). |
suspend_on_invoice_expired | Indica se a assinatura é suspensa ao expirar a fatura. |
in_trial | Indica se a assinatura está em período de teste . |
credits | Créditos disponíveis. |
credits_based | Indica se a assinatura é baseada em créditos. |
Propriedade recent_invoices
recent_invoices| Subpropriedade | Descrição |
|---|---|
id | Identificador único da fatura. |
due_date | Data de vencimento da fatura. |
status | Status da fatura (ex: "pending"). |
total | Valor total da fatura formatado de acordo com a localidade (ex: "R$ 10,00"). |
secure_url | URL segura para acessar a fatura (checkout). |
Propriedade logs
logs| Subpropriedade | Descrição |
|---|---|
id | Identificador único do log. |
description | Descrição do log. |
notes | Notas do log. |
subscription_changes | Mudanças na assinatura descritas em JSON. |
created_at | Data e hora de criação do log. |