---
title: "POST /recurrence/v1/subscriptions/simulate"
method: POST
path: "/recurrence/v1/subscriptions/simulate"
---

# POST /recurrence/v1/subscriptions/simulate

`POST /recurrence/v1/subscriptions/simulate`

## Request

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

## Request body

- object
  - `Plan` object, required: Objeto do plano
    - `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.
    - `Description` string: Descrição do plano.
    - `Amount` number, double, required: Valor cobrado a cada renovação do ciclo do plano.
    - `SubscriptionTax` number, double: Taxa de assinatura, cobrada na primeiro ciclo do plano.
    - `IsImmediateCharge` boolean: Se a cobrança deve ser realizada em até 01 hora, após a assinatura ser realizada
    - `DayOfWeek` integer: Dia da semana. Consulte os dias disponíveis [clique aqui](https://developers.safe2pay.com.br/reference/tipos-e-enums-da-recorrencia#/)
    - `PlanOption` integer, required: Modelos de plano. Consulte os modelos disponíveis [clique aqui](https://developers.safe2pay.com.br/reference/tipos-e-enums-da-recorrencia#/)
    - `DaysBeforeChargeDateExpiration` integer: Dias que antecedem o vencimento para envio do boleto. Esse número será subtraído do dia de vencimento da cobrança, para realizar o envio do boleto. (Configuração específica para boleto bancário)
    - `IsProRata` boolean: Se o plano deve cobrar um valor proporcional ao uso na primeira cobrança. caso esse campo seja true, o sistema irá gerar a primeira cobrança com um valor proporcional ao uso.
    - `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. Esse campo é obrigatório se o Plano for Personalizado e a frequência for Mensal. Caso o Plano for Fixo, esse campo não deve ser informado.
  - `SubscriptionDate` string, date, required: Data de criação da assinatura. Ex: 2025-07-25
  - `PaymentMethod` integer, required: Código do método de pagamento. Ex: 1 (Boleto bancário), 2 (Cartão de crédito)

## Response `200`

## 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)
