v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB

product_items

Cadastra um novo item em uma assinatura existente.

Novos itens serão aplicados apenas em novas faturas. Se desejar incluir o novo item em uma fatura existente você deverá cancelar a fatura em questão e efetuar a reemissão.

Precificação

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

post/v1/product_items

Request body

bodystring

JSON com atributos do novo item.

product_idinteger required

ID do produto associado

subscription_idinteger required

ID da assinatura existente

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 cadastrado 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