Consulta um item

GET/v1/subscriptions/{subscriptionId}/items/{itemId}

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

subscriptionIdstringobrigatório
Identificador público (subs_/sub_…)
itemIdstringobrigatório
Identificador público (sit_/item_…)

Respostas

200Sucesso

idstringobrigatório
Identificador público (sit_/item_…)
namestringobrigatório
Nome do item, vindo da variante.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
imagesum de[]obrigatóriopode ser nulo
Imagens da variante; null quando não há.
enabledbooleanobrigatório
Se o item é cobrado nos próximos ciclos.
currencystringobrigatório
Moeda (ISO 4217).
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
metadataobjectobrigatóriopode ser nulo
Os seus metadados chave-valor do item; null quando não há.
quantityintegerobrigatório
Quantidade.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
unitPriceintegerobrigatório
Preço unitário congelado da variante, em centavos.
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
descriptionstringobrigatóriopode ser nulo
A sua nota sobre o item.
pricingSchemastringobrigatório
Esquema de preço da variante: unit, tiered ou package.
externalReferencestringobrigatóriopode ser nulo
O seu próprio identificador do item; null quando não há.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorAdiciona um limiar de cobrança PróximaAtualiza a quantidade de um item