Skip to main content
POST
Crie uma nova assinatura recorrente adicionando o bloco subscription na criação de uma transação. A assinatura será criada automaticamente após o processamento da venda.

Autenticação

Este endpoint requer autenticação via API Keys:
string
required
Sua chave pública da API
string
required
Sua chave privada da API

Parâmetros do Body

Além dos parâmetros padrão de criação de transação, inclua o bloco subscription:

Parâmetros de Assinatura

object
required
Configuração da assinatura recorrente
boolean
required
Define se a venda deve criar uma assinatura. Use true para criar assinatura.
string
required
Ciclo de cobrança. Valores possíveis: WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, YEARLY
integer
Número de dias de período de teste gratuito (0-90). Padrão: 0

Parâmetros Padrão da Transação

integer
required
Valor da assinatura em centavos (ex: 5000 = R$ 50,00)
string
required
Método de pagamento. Valores possíveis: CREDIT_CARD, PIX
object
required
Dados do cliente assinante
string
required
Nome completo do cliente
string
required
Email do cliente
object
Documento do cliente (CPF ou CNPJ)
string
Tipo do documento: cpf ou cnpj
string
Número do documento
string
Telefone do cliente no formato 11999999999 (sem caracteres especiais)
array
required
Lista de itens da assinatura
string
required
Nome do produto/plano
integer
required
Preço unitário em centavos
integer
required
Quantidade do item
boolean
required
Se o item é físico (true) ou digital (false)
object
Informações do cartão (obrigatório para CREDIT_CARD)
string
URL para receber notificações de mudança de status

Fluxo de Status da Assinatura

Após criar uma transação com assinatura:
  1. Assinatura criada com status PENDING - Aguardando primeiro pagamento
  2. Pagamento confirmado - Status muda para:
    • ACTIVE se não houver período de trial
    • TRIALING se houver período de trial configurado
  3. Cobranças recorrentes - Processadas automaticamente no ciclo definido
Nota: A assinatura só é ativada após a confirmação do primeiro pagamento. Para PIX, isso ocorre quando o cliente efetua o pagamento. Para cartão de crédito, ocorre imediatamente se aprovado.

Códigos de Erro

Status HTTP

Diferença entre Venda Normal e Assinatura

A única diferença entre criar uma venda normal e uma assinatura é a inclusão do bloco subscription: