Skip to main content
GET
Buscar um produto
Retorna um produto pelo id, pelo externalId ou pelo name. Informe ao menos um desses filtros.
Requer a permissão PRODUCT:READ.

Entenda os produtos

Status, ciclo, período de teste e os demais campos do produto.
Produtos excluídos não aparecem na busca.

Erros

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

id
string

Identificador único público do produto

Example:

"prod_abc123xyz"

externalId
string

Identificador único do produto no seu sistema

Example:

"prod-123"

name
string

Nome do produto

Response

Produto encontrado com sucesso.

data
object

Os dados do seu produto. O campo cycle indica se o produto é uma assinatura (subscription). Quando null, o produto é avulso (pagamento único). Valores possíveis definem a recorrência da assinatura. A moeda (currency) é sempre BRL.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true