Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
product_items

Atualiza um item existente.

É possível atualizar um item em uma assinatura existente, porém isso não causará nenhum reflexo imediato nas faturas já emitidas. Alterações em um item serão aplicadas apenas na próxima fatura gerada, porém de qualquer forma é possível cancelar e reemitir uma fatura já gerada.

Precificação

Informe o parâmetro pricing_schema apenas se quiser alterar a precificação atual do item. Consulte este artigo para mais informações sobre o cálculo da precificação.

put/v1/product_items/{id}

Path parameters

idinteger required

ID do item que deverá ser atualizado.

Request body

bodystring

JSON com novos atributos do item.

status'active' | 'inactive' | 'deleted' required

Status do item

cyclesinteger

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantityinteger

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

Response

Item atualizado com sucesso.

idinteger required

ID do item

status'active' | 'inactive' | 'deleted' required

Status do item

usesinteger

Número de ciclos de recorrência que utilizaram o produto.

cyclesinteger

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantityinteger

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

created_atstring required

Data e hora da criação do item

updated_atstring required

Data e hora da última atualização do item