Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

As Assinaturas permitem criar cobranças recorrentes automáticas para seus clientes. A plataforma gerencia automaticamente a geração de faturas e as tentativas de cobrança.

​
Métodos de Pagamento Suportados

MétodoDescrição
CreditCardCobrança automática no cartão
PIXQR Code gerado a cada ciclo de cobrança

​
Parâmetros principais da assinatura

CampoTipoReq.Descrição
subscription.intervalintegerSimCiclo de cobrança em dias (1–365)
subscription.codestringNãoCódigo identificador (definido pelo integrador)
subscription.descriptionstringNãoDescrição da assinatura
subscription.installmentsintegerCCParcelas por cobrança (1–12, obrigatório para cartão)
subscription.max_invoicesintegerNãoMáximo de faturas a gerar (sem limite se omitido)
subscription.minimum_priceintegerNãoPreço mínimo em centavos
subscription.start_datedatetimeNãoInício da cobrança (Y-m-d H:i:s, após amanhã)
subscription.billing_typestringNãoprepaid
subscription.billing_dayinteger*Dia do mês para cobrança (1–31, obrigatório p/ exact_day)
subscription.discountsobjectNãoDesconto por ciclos (percentage ou flat)
subscription.incrementsobjectNãoAcréscimo por ciclos (percentage ou flat)
subscription.metadataobjectNãoMetadados em formato livre

​
Ciclos de desconto e acréscimo

{
  "subscription": {
    "discounts": {
      "cycles": 3,
      "value": 15.0,
      "type": "percentage"
    },
    "increments": {
      "cycles": 1,
      "value": 5.00,
      "type": "flat"
    }
  }
}

​
Status de uma Assinatura

StatusDescrição
RecurringAssinatura ativa, cobranças em andamento
RecurringCanceledAssinatura cancelada
RecurringOverdueAssinatura com fatura em atraso
NewAssinatura recém-criada
InProgressAssinatura em processamento
CanceledCancelada (compra avulsa)
ConcludedConcluída (compra avulsa)

​
Exemplo completo

Criar assinatura mensal com cartão
{
  "client": {
    "name": "Carlos Ferreira",
    "email": "carlos@exemplo.com.br",
    "phone": { "ddi": 55, "ddd": 11, "number": "977776666" },
    "document": { "type": "CPF", "number": "111.222.333-44" }
  },
  "subscription": {
    "interval": 30,
    "description": "Plano Mensal Premium",
    "installments": 1,
    "max_invoices": 12
  },
  "payment": {
    "type": "CreditCard",
    "card": {
      "number": "4111111111111111",
      "name": "CARLOS FERREIRA",
      "month": "08",
      "year": "28",
      "security_code": "456"
    }
  },
  "items": [
    { "id": "plano_premium", "description": "Acesso Premium", "amount": 99.90, "quantity": 1 }
  ]
}
O campo subscription.code é o identificador externo da assinatura. Use o código do plano do seu sistema para facilitar a reconciliação.
A criação de assinaturas também passa pelas verificações de fraude e bloqueio de clientes, assim como as cobranças avulsas.