v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Incluir item

Através do identificador da assinatura (subscription_id) é possível incluir itens na assinatura do cliente.

post/subscriptions/{subscription_id}/items

Path parameters

subscription_idstring required

Código da assinatura.<br>Formato: sub_XXXXXXXXXXXXXXXX.

Request body

plan_item_idstring

Código do item do plano.<br>Max: 36 caracteres.

descriptionstring required

Descrição do item.<br>Max: 256 caracteres.<br>Obrigatório caso o plan_item_id não seja informado.

cyclesinteger

Indica quantas vezes o item será cobrado. <br>Caso não seja informado, o item será cobrado até que seja excluído o desativado.

pricing_schemeobject

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

quantityinteger required

Quantidade de itens.<br>Obrigatório caso pricing_scheme.scheme_type seja unit

namestring

Nome do item da assinatura.

Response

200

idstring
descriptionstring
cyclesinteger
quantityinteger
statusstring
created_atstring
updated_atstring

Example response

{
  "id": "si_WQEmvEEfGigkL0Zx",
  "description": "Celular",
  "cycles": 1,
  "quantity": 1,
  "status": "active",
  "created_at": "2017-07-28T21:00:26Z",
  "updated_at": "2017-07-28T21:00:26Z",
  "pricing_scheme": {
    "price": 99,
    "scheme_type": "unit"
  },
  "subscription": {
    "id": "sub_z4ogwpZfdKCnGj9m",
    "code": "3670A7IQWL",
    "start_at": "2017-07-28T00:00:00Z",
    "interval": "month",
    "interval_count": 3,
    "billing_type": "prepaid",
    "next_billing_at": "2017-10-28T00:00:00Z",
    "payment_method": "credit_card",
    "currency": "BRL",
    "installments": 3,
    "status": "active",
    "created_at": "2017-07-28T20:59:18Z",
    "updated_at": "2017-07-28T20:59:18Z",
    "metadata": {
      "id": "my_subscription_id"
    }
  }
}