Assinaturas
Criar Assinatura
Crie uma nova assinatura recorrente através da API de vendas do LegacyPay Gateway
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:Sua chave pública da API
Sua chave privada da API
Parâmetros do Body
Além dos parâmetros padrão de criação de transação, inclua o blocosubscription:
Parâmetros de Assinatura
Configuração da assinatura recorrente
Define se a venda deve criar uma assinatura. Use
true para criar assinatura.Ciclo de cobrança. Valores possíveis:
WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, YEARLYNúmero de dias de período de teste gratuito (0-90). Padrão:
0Parâmetros Padrão da Transação
Valor da assinatura em centavos (ex: 5000 = R$ 50,00)
Método de pagamento. Valores possíveis:
CREDIT_CARD, PIXDados do cliente assinante
Nome completo do cliente
Email do cliente
Documento do cliente (CPF ou CNPJ)
Tipo do documento:
cpf ou cnpjNúmero do documento
Telefone do cliente no formato 11999999999 (sem caracteres especiais)
Lista de itens da assinatura
Nome do produto/plano
Preço unitário em centavos
Quantidade do item
Se o item é físico (
true) ou digital (false)Informações do cartão (obrigatório para
CREDIT_CARD)URL para receber notificações de mudança de status
Fluxo de Status da Assinatura
Após criar uma transação com assinatura:- Assinatura criada com status
PENDING- Aguardando primeiro pagamento - Pagamento confirmado - Status muda para:
ACTIVEse não houver período de trialTRIALINGse houver período de trial configurado
- 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
| Código | Descrição |
|---|---|
201 | Venda e assinatura criadas com sucesso |
400 | Dados inválidos ou campos obrigatórios faltando |
401 | Não autorizado - Chaves de API inválidas |
422 | Erro de validação |
500 | Erro interno do servidor |
Diferença entre Venda Normal e Assinatura
A única diferença entre criar uma venda normal e uma assinatura é a inclusão do blocosubscription:
| Aspecto | Venda Normal | Assinatura |
|---|---|---|
Bloco subscription | Não incluir | Incluir com enabled: true |
| Cobrança | Única | Recorrente automática |
| Status inicial | PENDENTE | PENDING (assinatura) |
| Próximas cobranças | Manual | Automática |

