---
title: "Editar plano"
method: PUT
path: "/plans/{plan_id}"
---

# Editar plano

`PUT /plans/{plan_id}`

Com o verbo HTTP PUT, através do identificador do plano (`plan_id`)  é possível atualizar os dados do plano.

## Path parameters

- `plan_id` string, required

## Request body

- object
  - `name` string, required — Nome do plano. Max: 64 caracteres.
  - `description` string — Descrição do plano. Max: 256 caracteres
  - `currency` string, required — Moeda. Valores possíveis: **BRL**, **ARS**, **BOB**, **CLP**, **COP **, **MXN**, **PYG**, **USD **, **UYU** e **EUR**.
  - `interval` string, required — Intervalo 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. <br>Ex.: plano mensal = **interval_count** (1) e **interval** (month) <br> plano trimestral = **interval_count** (3) e **interval** (month) <br> plano semestral = **interval_count** (6) e** interval** (month)
  - `billing_type` string, required — Tipo de cobrança. Valores possíveis: **prepaid**, **postpaid **ou **exact_day**
  - `billing_days` integer[] — Dias disponíveis para cobrança. **Obrigatório**, caso o **billing_type** seja igual a **exact_day**.
  - `installments` integer[] — Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.<br>Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista.
  - `statement_descriptor` string — Texto exibido na fatura do cartão. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. Max: 22 caracteres.
  - `minimum_price` integer — Valor mínimo em centavos do plano.
  - `status` string, required — Status do plano. Valores possíveis: **active**, **inactive** ou **deleted**
  - `shippable` boolean — Indica se o produto oferecido pelo plano é entregável. Por exemplo, planos relacionados a serviços não possuem dados para entrega.
  - `payment_methods` string[], required — Meios de pagamento disponíveis para assinaturas criadas a partir do plano. <br>Valores possíveis: **credit_card**, **boleto** ou **debit_card**.
  - `trial_period_days` integer — Dias de teste. A assinatura será iniciada após o término deste período.
  - `metadata` object — Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata)

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `description` string
  - `url` string
  - `currency` string
  - `interval` string
  - `interval_count` integer
  - `billing_type` string
  - `installments` integer
  - `statement_descriptor` string
  - `status` string
  - `created_at` string
  - `updated_at` string
  - `minimum_price` integer
  - `items` object[]
    - `id` string
    - `name` string
    - `status` string
    - `created_at` string
    - `updated_at` string
    - `pricing_scheme` object
      - `price` integer
      - `scheme_type` string
  - `metadata` object
    - `id` string

## Other responses

- `404` — 404

---

[API](https://skmtc.net/mundipagg/apis/mundipagg-api.md) · [All operations](https://skmtc.net/mundipagg/apis/mundipagg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mundipagg/mundipagg-api/versions/1ddb9f03a82d/schema)