Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

Produtos são itens do seu catálogo usados nas cobranças: nome, preço, descrição e opcionalmente ciclo de assinatura. Avulso = pagamento único (cycle omitido ou null). Assinatura = cycle: WEEKLY, MONTHLY, SEMIANNUALLY ou ANNUALLY.

​
Criar produto

Use /products/create. Moeda é sempre BRL.

Campos obrigatórios

Obrigatórios: externalId (único no seu sistema), name, price, currency. Opcionais: description, imageUrl, cycle (null/omitido = avulso).
Exemplo (produto avulso): 
POST /products/create
{
  "externalId": "prod-123",              // obrigatório - identificador único do produto no seu sistema
  "name": "Produto Exemplo",             // obrigatório - nome do produto
  "price": 10000,                        // obrigatório - preço em centavos
  "currency": "BRL",                     // obrigatório - moeda (sempre BRL)
  "description": "Descrição do produto", // opcional - descrição
  "imageUrl": null                       // opcional - URL da imagem (string | null)
}
Exemplo (produto de assinatura): 
POST /products/create
{
  "externalId": "prod-assinatura-1",
  "name": "Plano Mensal",
  "price": 4990,
  "currency": "BRL",
  "cycle": "MONTHLY"                     // opcional - WEEKLY | MONTHLY | SEMIANNUALLY | ANNUALLY; omitir ou null = avulso
}
Resposta (modelo Product): 
{
  "data": {
    "externalId": "prod-123",
    "name": "Produto Exemplo",
    "description": "Descrição do produto",
    "imageUrl": null,
    "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",
    "cycle": null
  },
  "success": true,
  "error": null
}
O data retornado segue o modelo Product: id, externalId, name, description, imageUrl, price, currency, status, cycle, createdAt, updatedAt, etc.