---
title: "Criar plano"
method: POST
path: "/recurrence/v1/plans/"
---

# Criar plano

`POST /recurrence/v1/plans/`

## Request

- Base URL: `https://services.safe2pay.com.br`
- URL: `https://services.safe2pay.com.br/recurrence/v1/plans/`
- Auth: API key in header `X-API-KEY`

## Request body

- object
  - `PlanOption` integer, required: Consulte os modelos disponíveis [clique aqui](https://developers.safe2pay.com.br/reference/tipos-e-enums-da-recorrencia#/)
  - `PlanFrequence` integer, required: Consulte as frequências disponíveis [clique aqui](https://developers.safe2pay.com.br/reference/tipos-e-enums-da-recorrencia#/)
  - `Name` string, required: Nome do plano.
  - `Amount` number, double, required: Valor do plano que será cobrado de cada assinante.
  - `ChargeDay` integer: Para Cartão de crédito, esse será o dia em que a cobrança será efetuada. Para Boleto Bancário, esse será o dia do vencimento do boleto. Ex: 30
  - `DayOfWeek` integer: Consulte os dias da semana [clique aqui](https://developers.safe2pay.com.br/reference/tipos-e-enums-da-recorrencia#/)
  - `Description` string: Descrição do plano.
  - `SubscriptionTax` number, double: Taxa de assinatura.
  - `SubscriptionLimit` integer: Limite de assinaturas que serão permitidas no plano. Caso não seja informado, o plano não terá limite de assinaturas.
  - `IsImmediateCharge` boolean: Se a cobrança deve ser realizada em até 01 hora, após a assinatura ser realizada Ex: true Esse campo deve ser true caso o Plano for do tipo Fixo.
  - `IsProRata` boolean: Se o plano deve cobrar um valor proporcional ao uso na primeira cobrança.
  - `DaysBeforeChargeDateExpiration` integer: Dias que antecedem o vencimento para envio do boleto (aplicável apenas para boleto). Ex: 5
  - `BillingCycle` integer: Quantidade de ciclos para o plano ser encerrado. Caso não seja informado, será considerado ciclo infinito.
  - `CallbackUrl` string: URL de notificações de mudança de status do plano.
  - `DaysDue` integer: Dia do vencimento do boleto (aplicável apenas para boleto) Ex: 10
  - `Instruction` string: Instrução que deve ser enviada no boleto (aplicável apenas para boleto) Ex: "Pagável até o vencimento"
  - `PenaltyAmount` number, double: Multa que deve ser aplicada após o vencimento (aplicável apenas para boleto) Ex: 2.00
  - `InterestAmount` number, double: Juros que deve ser aplicado após o vencimento (aplicável apenas para boleto) Ex: 2.00
  - `DiscountType` integer: Tipo de desconto a ser aplicado (aplicável apenas para boleto) 1 = valor 2 = Percentual Ex: 1 Informe esse campo apenas se o tipo do plano for personalizado
  - `DiscountDue` string, date: Quantidade de dias de limite para o desconto (aplicável apenas para boleto). Ex: "30/05/2021"
  - `DiscountAmount` number, double: Valor do desconto (aplicável apenas para boleto). Informar apenas se houver desconto para o boleto. Valor será adicionado em campo separado no registro Ex: 2.00
  - `IsRetryCharge` boolean: Se a cobrança vai permitir retentativas. Ex: true Verifique os detalhes de retentativa [aqui](https://developers.safe2pay.com.br/docs/recorrencia-overview#tabela-de-frequ%C3%AAncia-da-retentativa)

## Response `201`

Created

## Other responses

- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/safe2pay/apis/services.md) - [All operations](https://skmtc.dev/safe2pay/apis/services/llms.txt) - [OpenAPI document](https://skmtc.dev/safe2pay/apis/services/revisions/133a27b98247?raw)