v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar item

Com o verbo HTTP PUT, através dos identificadores do item (plan_item_id) e do plano (plan_id) associado é possível atualizar os dados do item do plano.

put/plans/{plan_id}/items/{item_id}

Path parameters

plan_idstring required

Código do plano. <br>Formato: plan_XXXXXXXXXXXXXXXX.

plan_item_idstring required

Código do item do plano. <br>Formato: pi_XXXXXXXXXXXXXXXX

Request body

namestring required

Nome do item. Máx.: 64 caracteres

descriptionstring

Descrição do item. Máx.: 256 caracteres

quantityinteger required

Quantidade de itens.

cyclesstring

Número de ciclos durante o qual o item será cobrado. Ex: Um item com cycles = 1 representa que um item será cobrado apenas uma vez. Caso não seja informado, o item será cobrado até que seja desativado.

statusstring required

Valores possíveis: active ou inactive

pricing_schemeobject required

Esquema de precificação. Saiba mais sobre precificação.

Response

200

idstring

namestring

descriptionstring

cyclesinteger

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "pi_eBTaVnXD8Zhb8glr",
  "name": "Avaliação física",
  "description": "Avaliação + Exame médico",
  "cycles": 1,
  "status": "active",
  "created_at": "2016-07-12T18:25:40Z",
  "updated_at": "2016-07-12T18:25:40Z",
  "pricing_scheme": {
    "price": 9990,
    "scheme_type": "unit"
  },
  "plan": {
    "id": "plan_21r4CTG0ux77Qv13",
    "name": "Plano Gold",
    "url": "/plan_21r4CTG0ux77Qv13/academia/plano-gold",
    "currency": "BRL",
    "interval": "month",
    "interval_count": 3,
    "billing_type": "prepaid",
    "installments": 3,
    "status": "active",
    "created_at": "2016-07-12T17:25:40Z",
    "updated_at": "2016-07-12T17:25:40Z",
    "metadata": {
      "id": "my_plan_id"
    }
  }
}