---
title: "Criar um novo plano"
method: POST
path: "/recurrence/plans/"
tags: ["Planos"]
---

# Criar um novo plano

`POST /recurrence/plans/`

## Request body

- PlanCreationDTO
  - `interval` string, required — Frequência da recorrência. Valores possíveis: day, week, month ou year.
  - `interval_count` integer, required — Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1) e interval (month) plano trimestral = interval_count (3) e interval (month) plano semestral = interval_count (6) e interval (month)
  - `name` string, required — Nome do plano.
  - `description` string — Descrição do plano.
  - `billing_type` string, required — Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.
  - `payment_methods` PlanPaymentMethodDTOInput[], required — Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
    - `payment_method` string, required — Meio de pagamento. Valores possíveis: credit_card, boleto e debit_card.
    - `installments_options` PlanInstallmentsDTOInput[] — Plano de Parcelamento.
      - `installments` integer, required — Quantidade de parcelas.
      - `transaction_fee` union — Tarifa de transação da parcela.
        - number
        - string
      - `installment_amount` union — Valor da parcela sem adição de tarifas.
        - number
        - string
      - `total_amount` union — Valor total da parcela.
        - number
        - string
    - `transaction_fee` union — Tarifa de transação.
      - number
      - string
  - `accepted_payment_methods` string[], required — Métodos de pagamento aceito.
  - `items` PlanItemDTOInput[], required — Itens do plano.
    - `product_id` string, required — Id do produto.
    - `amount` union, required — Valor unitário do produto
      - number
      - string
    - `description` string — Descrição do produto
    - `type` string — Tipo do produto
    - `status` string — Status do item
    - `metadata` object — Dados adicionais do produto
  - `installments` integer — Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
  - `cancellation_grace_period_days` integer — Número de dias em que a assinatura pode permanecer inativa antes de ser cancelada.
  - `metadata` object, nullable — Dados adicionais do plano.

## Response `200`

Plano criado com sucesso

- PlanCreatedDTO
  - `plan_id` string, required — Id do plano criado
  - `interval` string, required — Frequência da recorrência.
  - `interval_count` integer, required — Número do intervalo definido
  - `name` string, required — Nome do plano criado.
  - `status` string — Status do plano criado
  - `billing_type` string, required — Tipo de cobrança criada.
  - `installments` integer — Opções de parcelamento definidas para assinaturas criadas a partir do plano.
  - `payment_methods` PlanPaymentMethodDTOOutput[], required — Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
    - `payment_method` string, required — Meio de pagamento. Valores possíveis: credit_card, boleto e debit_card.
    - `installments_options` PlanInstallmentsDTOOutput[] — Plano de Parcelamento.
      - `installments` integer, required — Quantidade de parcelas.
      - `transaction_fee` string — Tarifa de transação da parcela.
      - `installment_amount` string — Valor da parcela sem adição de tarifas.
      - `total_amount` string — Valor total da parcela.
    - `transaction_fee` string — Tarifa de transação.
  - `accepted_payment_methods` string[], required — Meios de pagamento definidos para assinaturas criadas a partir do plano.
  - `items` PlanItemCreatedDTO[], required — Itens do plano.
    - `product_id` string, required — Id do produto criado.
    - `amount` string, required — Valor unitário do produto criado
    - `description` string — Descrição do produto criado
    - `type` string — Tipo do produto criado
    - `status` string — Status do item criado
    - `metadata` object — Dados adicionais do produto criado
  - `metadata` object, nullable — Dados adicionais do plano.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/versions/50c96157fff4/schema)