Sign in

v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Incluir item

Através do identificador do plano (plan_id) é possível incluir itens ao plano associado.

post/plans/{plan_id}/items

Path parameters

plan_idstring required

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

Request body

namestring required

Nome do item. <br>Max.: 64 caracteres.

descriptionstring

Descrição do item. <br>Max.: 256 caracteres.

quantityinteger

Quantidade de itens. <br>Obrigatório, caso o pricing_scheme.type for igual a unit.

cyclesinteger

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.<br>Caso não seja informado, o item será cobrado até que seja desativado.

pricing_schemeobject required

Esquema de precificação. <br>Saiba mais sobre precificação.

Response

200

idstring
namestring
cyclesinteger
statusstring
created_atstring
updated_atstring

Example response

{
  "id": "pi_eBTaVnXD8Zhb8glr",
  "name": "Avaliação física",
  "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"
    }
  }
}