PApagar

Editar item

Changed on

Com o verbo HTTP PUT, através dos identificadores do item (subscription_item_id) e da assinatura (subscription_id) associada é possível atualizar os dados do item da assinatura.

put/subscriptions/{subscription_id}/items/{item_id}

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/subscriptions/{subscription_id}/items/{item_id}
  • Auth
    HTTP basic

Path parameters

subscription_idstring required

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

item_idstring required

Código do item da assinatura.<br>Formato: si_XXXXXXXXXXXXXXXX.

Request body

namestring

Nome do item da assinatura.

descriptionstring

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

cycleinteger

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

pageinteger

Página atual

sizeinteger

Quantidade de itens por página.

quantityinteger required

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

Response

200

idstring
descriptionstring
cyclesinteger
quantityinteger
statusstring
created_atstring
updated_atstring

Example response

{
  "id": "si_mARl1OvTYcA3pG49",
  "description": "Telefone",
  "cycles": 3,
  "quantity": 1,
  "status": "active",
  "created_at": "2017-04-04T18:56:44Z",
  "updated_at": "2017-04-04T18:57:48Z",
  "pricing_scheme": {
    "price": 99,
    "scheme_type": "unit"
  },
  "subscription": {
    "id": "sub_o0Jw4WYCMuPNqzGr",
    "code": "09NFPLBZY0",
    "start_at": "2017-04-04T00:00:00Z",
    "interval": "month",
    "interval_count": 1,
    "billing_type": "postpaid",
    "next_billing_at": "2017-05-04T00:00:00Z",
    "payment_method": "credit_card",
    "currency": "BRL",
    "statement_descriptor": "Spotify",
    "installments": 1,
    "status": "active",
    "created_at": "2017-04-04T18:21:17",
    "updated_at": "2017-04-04T18:21:17"
  }
}

Changes