v1
latestOpenAPI 3.1.02026-07-241040774.6 KBEditar item
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/{subscription_item_id}
Path parameters
subscription_idstring required
Código da assinatura.<br>Formato: sub_XXXXXXXXXXXXXXXX.
subscription_item_idstring required
Código do item da assinatura.<br>Formato: si_XXXXXXXXXXXXXXXX.
Query parameters
descriptionstring
Descrição do item da assinatura.<br>Max: 256 caracteres.
statusstring
Status do item da assinatura.<br>Valores possíveis: active ou inactive.
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.
quantityinteger required
Quantidade de itens.<br>Obrigatório caso pricing_scheme.scheme_type seja unit.
pricing_schemeobject
Esquema de precificação.<br>Saiba mais sobre precificação
namestring
Nome do item da assinatura.
Request body
{"stackTrail":"paths:/subscriptions/{subscription_id}/items/{subscription_item_id}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}
Response
200
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"
}
}