---
title: "Editar metadados de um plano"
method: PATCH
path: "/recurrence/plans/{plan_id}/metadata"
tags: ["Planos"]
---

# Editar metadados de um plano

`PATCH /recurrence/plans/{plan_id}/metadata`

## Path parameters

- `plan_id` string, required

## Request body

- object

## Response `200`

Successful Response

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