Criar plano

POST

/api/partner/v1/subscription-plans

Cria um plano de assinatura.

O campo billing_method é obrigatório e define o motor de cobrança do
plano. É imutável após a criação — não pode ser alterado via PATCH.

O checkout_url retornado é o link para compartilhar com os assinantes.

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 Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201

application/json

Plano criado com sucesso.

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

cURL

Criação básica de plano mensalCriação com split de 20% para um parceiro

curl --location '/api/partner/v1/subscription-plans' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Plano Mensal",
    "description": "Acesso completo à plataforma por 30 dias",
    "amount": "50.00",
    "periodicity_days": 30,
    "billing_method": "qr_code",
    "billing_advance_days": 3,
    "grace_period_days": 5,
    "max_retry_attempts": 3
}'

Response Example

201 - Sucesso

{
    "data": {
        "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Plano Mensal",
        "description": "Acesso completo à plataforma por 30 dias",
        "amount": "50.00",
        "periodicity_days": 30,
        "billing_advance_days": 3,
        "grace_period_days": 5,
        "max_retry_attempts": 3,
        "billing_method": "qr_code",
        "status": "active",
        "checkout_url": "https://app.syncpayments.com.br/subscription/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

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