Criar Assinatura

Visão geral

Use este endpoint para criar uma assinatura recorrente vinculada a um cliente e a um produto. A Avantti Finance gerencia automaticamente a cobrança periódica, gerando transações a cada novo ciclo de cobrança.

Endpoint

curl -X POST https://api.avanttifinance.com/v1/subscriptions \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cus_8f72a1b3c4d5",
    "product_id": "prod_8f72a1b3c4d5",
    "billing_interval": "monthly",
    "payment_method": "card"
  }'

const response = await fetch("https://api.avanttifinance.com/v1/subscriptions", {
  method: "POST",
  headers: {
    "Authorization": \`Bearer \${accessToken}\`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    customer_id: "cus_8f72a1b3c4d5",
    product_id: "prod_8f72a1b3c4d5",
    billing_interval: "monthly",
    payment_method: "card"
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.avanttifinance.com/v1/subscriptions"
headers = {
    "Authorization": f"Bearer {access_token}",
    "Content-Type": "application/json"
}
payload = {
    "customer_id": "cus_8f72a1b3c4d5",
    "product_id": "prod_8f72a1b3c4d5",
    "billing_interval": "monthly",
    "payment_method": "card"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Parâmetros do corpo

string

required

Identificador do cliente que será cobrado pela assinatura.

string

required

Identificador do produto vinculado à assinatura, que define o valor cobrado a cada ciclo.

string

required

Intervalo de cobrança da assinatura. Valores aceitos: weekly, monthly, quarterly, yearly.

string

required

Método de pagamento utilizado nas cobranças recorrentes. Valores aceitos: card, pix, boleto.

integer

Número de dias de teste gratuito antes da primeira cobrança. Padrão: 0.

object

Conjunto de pares chave-valor para armazenar informações adicionais sobre a assinatura.

Resposta

string

Identificador único da assinatura, no formato sub_xxxxxxxxxxxx.

string

Identificador do cliente vinculado à assinatura.

string

Identificador do produto vinculado à assinatura.

string

Status atual da assinatura. Valores possíveis: trialing, active, past_due, canceled.

string

Intervalo de cobrança da assinatura.

string

Data e hora em que o ciclo de cobrança atual termina, no formato ISO 8601.

string

Data e hora de criação da assinatura, no formato ISO 8601.

Exemplo de resposta

{
  "id": "sub_8f72a1b3c4d5",
  "customer_id": "cus_8f72a1b3c4d5",
  "product_id": "prod_8f72a1b3c4d5",
  "status": "active",
  "billing_interval": "monthly",
  "current_period_end": "2025-02-15T10:30:00Z",
  "created_at": "2025-01-15T10:30:00Z"
}

Configure um endpoint de webhook para o evento subscription.charge_failed para ser notificado quando uma cobrança recorrente falhar.

Erros comuns

Código HTTP	Significado
400	Dados inválidos ou campos obrigatórios ausentes
401	Token de autenticação inválido ou ausente
404	Cliente ou produto não encontrado
422	Método de pagamento incompatível com o intervalo de cobrança

Comece Aqui

Autenticação

Pix In

Cartão de Crédito

Boleto

Pix Out

Link de Pagamento

Transações e Reembolsos

Assinaturas

Gestão de Conta

Webhooks

Desenvolvedores

Visão geral

Endpoint

Parâmetros do corpo

Resposta

Exemplo de resposta

Erros comuns

Próximos passos

Listar assinaturas

Cancelar assinatura

​Visão geral

​Endpoint

​Parâmetros do corpo

​Resposta

​Exemplo de resposta

​Erros comuns

​Próximos passos

Listar assinaturas

Cancelar assinatura

Visão geral

Endpoint

Parâmetros do corpo

Resposta

Exemplo de resposta

Erros comuns

Próximos passos