Cadastrar assinante

POST

/api/partner/v1/subscription-plans/{token}/enroll

Enrola um assinante em um plano programaticamente, sem necessidade de
redirecionamento para o checkout.

Segurança: o plano deve pertencer ao seller autenticado. Planos de outros
sellers retornam 404 — nunca 403 — para não vazar a existência do recurso.

Resultado por billing_method:

qr_code — retorna pix_code e qr_code para exibição imediata ao assinante.
A assinatura vai para active após a confirmação do pagamento (via webhook
assinatura_ativada).

pix_automatico — retorna dados do mandato. O assinante precisa escanear o
QR Code no app bancário para autorizar o débito automático. Acompanhe o
mandate_status até ACTIVE.

Sobre accepted_terms: no fluxo via API o seller assume contratualmente
a responsabilidade pela aceitação dos termos pelo comprador final.
O campo não é necessário neste endpoint.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201

application/json

Assinante enrolado com sucesso.

Bodyapplication/json

🟠404

🟠422

Request Example

Shell

JavaScript

Java

Swift

cURL

Enroll em plano QR CodeEnroll em plano Pix Automático

curl --location '/api/partner/v1/subscription-plans//enroll' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "João Silva",
    "email": "joao@email.com",
    "document": "12345678900",
    "phone": "11999999999"
}'

Response Example

201 - Resposta para plano QR Code

{
    "subscription_token": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": "pending_first_payment",
    "billing_method": "qr_code",
    "payment": {
        "pix_code": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
        "qr_code": null,
        "identifier": "sub_charge_abc123",
        "expires_at": "2026-07-07T09:00:00-03:00"
    }
}

Modificado em 2026-08-04 18:02:25