Criar assinatura

Esse endpoint permite incluir uma assinatura a um plano existente.

ℹ️

Antes de usar este endpoint, recomendamos fortemente que você leia a documentação completa da recorrência.

Ela explica em detalhes como funcionam os modelos de plano (fixo e personalizado), configurações de cobrança imediata, comportamento por meio de pagamento, regras de desconto e cancelamento de assinaturas.

Compreender esses conceitos evita falhas na integração e garante que sua solução utilize o sistema de assinaturas de forma eficiente, segura e aderente às boas práticas da plataforma.


🚧

Limitações

  • Esse mecanismo não possui ambiente de Sandbox.
  • Esse mecanismo não permite clientes com endereço no exterior.

Exemplos de requisição

{
    "PaymentMethod": "1",
    "Customer": {
        "Name": "TECIDOS FARIA DUARTE",
        "Identity": "74910037000193",
        "Phone": "51999999999",
        "Email": "[email protected]",
        "Address": {
            "Street": "Logradouro",
            "Number": "123",
            "Complement": "Casa",
            "District": "Higienopolis",
            "ZipCode": "90670090",
            "City": {
                "CodeIBGE": "4323002"
            }
        }
    },
    "Emails": [ // endereço que receberá as cobranças
        "[email protected]"
    ]
}
{
    "PaymentMethod": "2",
    "Customer": {
        "Name": "TECIDOS FARIA DUARTE",
        "Identity": "74910037000193",
        "Phone": "51999999999",
        "Email": "[email protected]",
        "Address": {
            "Street": "Logradouro",
            "Number": "123",
            "Complement": "Casa",
            "District": "Higienopolis",
            "ZipCode": "90670090",
            "City": {
                "CodeIBGE": "4323002"
            }
        }
    },
    "Emails": [ // endereço que receberá as cobranças
        "[email protected]"
    ],
    "Token": "953f8e23287d407caba589bc9cc6221c"
}

Path Params
string
required

Código identificador do plano.

Body Params
string
required
Defaults to 2

Código do método de pagamento. Ex: "1" (Boleto Bancário), "2" (Cartão de Crédito)

Customer
object
required

Grupo de dados com informação do cliente.

Emails
array of strings
required

Esses e-mails receberão o link para tokenização do cartão no momento da assinatura ou o boleto de cobrança. Se a assinatura for via cartão de crédito e o cartão já está tokenizado, não realizamos envio de e-mail.

Emails*
string

Token de identificação do cartão de crédito. Ex: 23e2dfdc6ea14c3aaeca924d1397e2c20 (Caso o cartão ainda não esteja tokenizado. Use esse endpoint para tokenizar antes de realizar a assinatura)

string

Nome do vendedor que será vinculado a essa assinatura e as respectivas cobranças. Ex: João da Silva

Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!