Pular para o conteúdo principal
PATCH
Atualizar item do catálogo de preços

Supported products

Parâmetros de caminho

priceBookId
integer<int64>
obrigatório

O identificador exclusivo do catálogo de preços que contém o item a ser atualizado.

priceBookItemId
integer<int64>
obrigatório

O identificador exclusivo do item dentro do catálogo de preços a ser atualizado.

Parâmetros de consulta

archived
boolean

Se apenas os resultados que foram arquivados devem ser retornados.

Corpo

application/json
billingFrequency
object
obrigatório

Um objeto que especifica a frequência com que a cobrança ocorre para o item do catálogo de preços.

billingPeriod
object
obrigatório

Um objeto que especifica o período em que a cobrança ocorre para o item do catálogo de preços.

customProperties
object
obrigatório

Um mapa de nomes de propriedades personalizadas para seus valores, permitindo personalização adicional do item do catálogo de preços.

status
object
obrigatório

Um objeto que indica o status atual do item do catálogo de preços.

archived
boolean

Um booleano que indica se o item do catálogo de preços está arquivado.

pricing
object

Resposta

successful operation

customProperties
object
obrigatório

Um mapa de nomes de propriedades personalizadas para seus valores para o item do catálogo de preços.

id
string
obrigatório

O identificador exclusivo do item do catálogo de preços.

productId
string
obrigatório

O identificador exclusivo do produto associado ao item do catálogo de preços.

archived
boolean

Um booleano que indica se o item do catálogo de preços está arquivado.

archivedAt
string<date-time>

A data e a hora em que o item do catálogo de preços foi arquivado, no formato ISO 8601.

billingFrequency
enum<string>

A frequência com que a cobrança ocorre para o item do catálogo de preços. Os valores válidos incluem "annually", "biweekly", "monthly", "one_time", "per_five_years", "per_four_years", "per_six_months", "per_three_years", "per_two_years", "quarterly" e "weekly".

Opções disponíveis:
ANNUALLY,
BIWEEKLY,
MONTHLY,
PER_FIVE_YEARS,
PER_FOUR_YEARS,
PER_SIX_MONTHS,
PER_THREE_YEARS,
PER_TWO_YEARS,
QUARTERLY,
WEEKLY
billingPeriod
string

O período de cobrança do item do catálogo de preços.

costOfGoodsSold
string

O custo dos produtos vendidos para o item do catálogo de preços.

createdAt
string<date-time>

A data e a hora em que o item do catálogo de preços foi criado, no formato ISO 8601.

description
string

Uma descrição do item do catálogo de preços.

images
string

Uma string que representa as imagens associadas ao item do catálogo de preços.

name
string

Nome do item do catálogo de preços.

priceBookId
string

O identificador exclusivo do catálogo de preços que contém este item.

pricing
object
productClassification
enum<string>

A classificação do produto. Os valores válidos incluem "BUNDLE", "STANDALONE" e "VARIANT".

Opções disponíveis:
BUNDLE,
STANDALONE,
VARIANT
productType
enum<string>

O tipo de produto. Os valores válidos incluem "INVENTORY", "NON_INVENTORY" e "SERVICE".

Opções disponíveis:
INVENTORY,
NON_INVENTORY,
SERVICE
recurringBillingTerms
enum<string>

Os termos de cobrança recorrente para o item do catálogo de preços. Os valores válidos incluem "AUTOMATICALLY_RENEW" e "FIXED".

Opções disponíveis:
AUTOMATICALLY_RENEW,
FIXED
sku
string

A unidade de manutenção de estoque (SKU) do item do catálogo de preços.

status
enum<string>

O status atual do item do catálogo de preços. Os valores válidos incluem "active" e "inactive".

Opções disponíveis:
active,
inactive
taxCategory
string

A categoria fiscal do item do catálogo de preços.

updatedAt
string<date-time>

A data e a hora da última atualização do item do catálogo de preços, no formato ISO 8601.

url
string

Um URL associado ao item do catálogo de preços.

Última modificação em 6 de outubro de 2026