Criar assinatura

ℹ️

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
Body Params
string
required
Defaults to 2
Customer
object
required
Emails
array of strings
required
Emails*
string
string
Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!