---
title: "Editar plano"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/editar-plano-1"
---
> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md
# Editar plano
`PUT` `/plans/{plan_id}`
Operation ID: `editar-plano-1`
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) - Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.
## Request body
Content types: `application/json`
## Responses
- `200` - 200
- `422` - 422
## OpenAPI definition
```yaml
openapi: 3.1.0
info:
title: Pagar.me v5 API (Legado)
version: 5.0.0
servers:
- url: https://api.stone.com.br/core/v5
paths:
/plans/{plan_id}:
put:
summary: Editar plano
description: Com o verbo HTTP PUT, através do identificador do plano
(`plan_id`) é possível atualizar os dados do plano.
operationId: editar-plano-1
parameters:
- name: plan_id
in: path
description: "Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`."
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
required:
- name
- status
- currency
- interval
- interval_count
properties:
name:
type: string
description: "Nome do plano. Max: 64 caracteres."
status:
type: string
description: "Status do plano. Valores possíveis: **active** ou **inactive**"
description:
type: string
description: Descrição do plano.
shippable:
type: boolean
description: Indica se o plano oferece entrega.
payment_methods:
type: array
description: "Meios de pagamento disponíveis para assinaturas criadas a partir
do plano.
Valores possíveis: **credit_card**, **boleto**
ou **debit_card**. Caso nenhum seja informado, o único meio
de pagamento disponível por padrão será **credit_card**"
items:
type: string
installments:
type: array
description: Opções de parcelamento disponíveis para assinaturas criadas a
partir do plano.
Caso não seja informado, o plano irá
disponibilizar apenas assinaturas com pagamentos à vista.
items:
type: integer
format: int32
minimum_price:
type: integer
description: Valor mínimo em centavos da fatura.
format: int32
statement_descriptor:
type: string
description: Texto exibido na fatura do cartão.
Será aplicado para
assinaturas de cartão de crédito criadas a partir do plano.
currency:
type: string
description: "Moeda. Valores possíveis:
**BRL**, **ARS**, **BOB**, **CLP**, **COP
**, **MXN**, **PYG**, **USD **, **UYU** e **EUR**."
interval:
type: string
description: "Frequência da recorrência. Valores possíveis: **day**,**week**,
**month** ou **year**."
default: month
interval_count:
type: integer
description: "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)"
default: 1
format: int32
trial_period_days:
type: integer
description: Dias de teste. A assinatura será iniciada após o término deste
período.
format: int32
billing_type:
type: string
description: "Tipo de cobrança. Valores possíveis: **prepaid**, **postpaid **ou
**exact_day**."
billing_days:
type: array
description: Dias disponíveis para cobrança das assinaturas criadas a partir do
plano. Deve ser maior ou igual a 1 e menor ou igual a 28.
**Obrigatório**, caso o **billing_type** seja igual a
**exact_day**.
items:
type: integer
format: int32
items:
type: array
description: Itens do plano. [Saiba mais sobre um itens do
plano](https://docs.pagar.me/reference/item-do-plano-1)
metadata:
type: string
description: Objeto chave/valor utilizado para armazenar informações adicionais
sobre o plano.
[Saiba mais sobre
metadata](https://docs.pagar.me/reference/metadata-1)
examples:
Request Example:
value:
name: Plano Silver
description: Esse plano oferece acesso aos programas de musculação e todos os
equipamentos e atividades coletivas terrestres.
currency: BRL
interval: month
interval_count: 3
billing_type: prepaid
statement_descriptor: SILVER
minimum_price: 10000
status: active
payment_methods:
- credit_card
responses:
"200":
description: "200"
content:
application/json:
examples:
Result:
value: >-
{
"id": "plan_21r4CTG0ux77Qv13",
"name": "Plano Gold",
"description": "Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.",
"url": "/plan_21r4CTG0ux77Qv13/academia/plano-silver",
"currency": "BRL",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"installments": 3,
"statement_descriptor": "SILVER",
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"minimum_price": 10000,
"items": [
{
"id": "pi_3j1EG9ousipHjcUL",
"name": "Musculação",
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"pricing_scheme": {
"price": 18990,
"scheme_type": "unit"
}
},
{
"id": "pi_6ggvuaJNS2LVq1i6",
"name": "Matrícula",
"cycles": 1,
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"pricing_scheme": {
"price": 5990,
"scheme_type": "unit"
}
}
],
"metadata": {
"id": "my_plan_id"
}
}
schema:
type: object
properties:
id:
type: string
example: plan_21r4CTG0ux77Qv13
name:
type: string
example: Plano Gold
description:
type: string
example: Esse plano oferece acesso aos programas de musculação e todos os
equipamentos e atividades coletivas terrestres.
url:
type: string
example: /plan_21r4CTG0ux77Qv13/academia/plano-silver
currency:
type: string
example: BRL
interval:
type: string
example: month
interval_count:
type: integer
example: 3
default: 0
billing_type:
type: string
example: prepaid
installments:
type: integer
example: 3
default: 0
statement_descriptor:
type: string
example: SILVER
status:
type: string
example: active
created_at:
type: string
example: 2016-07-12T18:25:40Z
updated_at:
type: string
example: 2016-07-12T18:25:40Z
minimum_price:
type: integer
example: 10000
default: 0
items:
type: array
items:
type: object
properties:
id:
type: string
example: pi_3j1EG9ousipHjcUL
name:
type: string
example: Musculação
status:
type: string
example: active
created_at:
type: string
example: 2016-07-12T18:25:40Z
updated_at:
type: string
example: 2016-07-12T18:25:40Z
pricing_scheme:
type: object
properties:
price:
type: integer
example: 18990
default: 0
scheme_type:
type: string
example: unit
metadata:
type: object
properties:
id:
type: string
example: my_plan_id
"422":
description: "422"
content:
application/json:
examples:
Result:
value: |-
{
"message": "The request is invalid.",
"errors": {
"plan.name": [
"The name field is required."
]
},
"request": {
"payment_methods": [
"credit_card"
],
"installments": [
3
],
"minimum_price": 10000,
"currency": "BRL",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"items": [
{
"name": "Musculação",
"quantity": 1,
"pricing_scheme": {
"price": 18990,
"scheme_type": "unit"
}
},
{
"name": "Matrícula",
"quantity": 1,
"cycles": 1,
"pricing_scheme": {
"price": 5990,
"scheme_type": "unit"
}
}
],
"metadata": {
"id": "my_plan_id"
}
}
}
schema:
type: object
properties:
message:
type: string
example: The request is invalid.
errors:
type: object
properties:
plan.name:
type: array
items:
type: string
example: The name field is required.
request:
type: object
properties:
payment_methods:
type: array
items:
type: string
example: credit_card
installments:
type: array
items:
type: integer
example: 3
default: 0
minimum_price:
type: integer
example: 10000
default: 0
currency:
type: string
example: BRL
interval:
type: string
example: month
interval_count:
type: integer
example: 3
default: 0
billing_type:
type: string
example: prepaid
items:
type: array
items:
type: object
properties:
name:
type: string
example: Musculação
quantity:
type: integer
example: 1
default: 0
pricing_scheme:
type: object
properties:
price:
type: integer
example: 18990
default: 0
scheme_type:
type: string
example: unit
metadata:
type: object
properties:
id:
type: string
example: my_plan_id
deprecated: false
security:
- sec0: []
components:
securitySchemes:
sec0:
type: http
scheme: basic
```