Criar plano

POST/recurrence/plan

Atualizado em 21 de março de 2025 · 3 min de leitura

Cria um plano de recorrência para ser utilizado em assinaturas.

Cria um plano de recorrência que poderá ser utilizado futuramente na criação de assinaturas. Um plano define as configurações padrão de cobrança (valor, frequência, método de pagamento) que serão aplicadas às assinaturas vinculadas.

POSThttps://{apiUrl}/recurrence/plan

URL base da API

Token de autenticação

Body Params

namestringrequired

Nome do plano

amountintegerrequired

Valor em centavos (ex: 9990 para R$ 99,90)

frequencystringrequired

Frequência: monthly, weekly, yearly

payment_methodstringrequired

Método: credit_card, boleto, pix

descriptionstringoptional

Descrição do plano

installmentsintegeroptional

Número de parcelas (para crédito)

trial_daysintegeroptional

Dias de trial gratuito

curl --request POST \
  --url "https://{apiUrl}/recurrence/plan" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Parâmetros

Headers

Parâmetro	Tipo	Obrigatório	Descrição
`Authorization`	string	Sim	Chave privada no formato `Bearer {token}`

Body

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do plano
`description`	string	Não	Descrição do plano
`amount`	integer	Sim	Valor em centavos (ex: `9990` para R$ 99,90)
`frequency`	string	Sim	Frequência: `monthly`, `weekly`, `yearly`
`payment_method`	string	Sim	Método: `credit_card`, `boleto`, `pix`
`installments`	integer	Não	Número de parcelas (para crédito)
`trial_days`	integer	Não	Dias de trial gratuito

Exemplo de requisição

bash

curl --request POST \
  --url https://{apiUrl}/recurrence/plan \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Plano Mensal",
    "description": "Cobrança mensal recorrente",
    "amount": 9990,
    "frequency": "monthly",
    "payment_method": "credit_card",
    "installments": 1,
    "trial_days": 7
  }'

Responses

Esta página foi útil?