Pular para o conteúdo principal
GET
Consultar produto

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Parâmetros de caminho

productID
string
obrigatório

ID do produto.

Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

Resposta

O produto.

Um item do catálogo. O preço fica nas versões do produto.

id
string
obrigatório
Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

name
string
obrigatório
type
enum<string>
obrigatório

item (padrão) ou agent.

Opções disponíveis:
agent,
item
pricingModel
enum<string>
obrigatório

Como o produto é cobrado: subscription, one_time, usage ou prepaid.

Opções disponíveis:
subscription,
one_time,
usage,
prepaid
currency
string
obrigatório

Código ISO 4217 de 3 letras, como BRL.

Exemplo:

"BRL"

status
string
obrigatório

active ou archived.

Exemplo:

"active"

guaranteeDays
integer
obrigatório
Intervalo obrigatório: 7 <= x <= 30
accentColor
string | null
obrigatório
Pattern: ^#[0-9A-Fa-f]{6}$
media
object[]
obrigatório
faq
object[]
obrigatório
purchaseButtonText
string | null
obrigatório
postPurchaseRedirectUrl
string | null
obrigatório
draftSavedAt
string<date-time> | null
obrigatório
createdAt
string<date-time>
obrigatório
updatedAt
string<date-time>
obrigatório
key
string | null

Chave estável que você escolhe para o produto, única na sua conta. Permite criar o mesmo produto de novo sem duplicar.

description
string | null
imageUrl
string | null

Endereço público da foto do produto.