Skip to main content
GET
/
products
/
get
Buscar um produto
curl --request GET \
  --url https://api.abacatepay.com/v2/products/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "externalId": "prod-123",
    "name": "Produto Exemplo",
    "description": "Descrição do produto",
    "price": 10000,
    "devMode": false,
    "currency": "BRL",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "status": "ACTIVE",
    "id": "prod_abc123xyz",
    "imageUrl": null,
    "cycle": null
  },
  "error": null,
  "success": true
}

Requer a permissão PRODUCT:READ.

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"

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