Sign in

v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Criar um produto

Permite que você crie um novo produto que pode ser usado em cobranças. Produtos podem ser avulsos (pagamento único) ou de assinatura; use o campo opcional cycle para definir a recorrência (WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY). Quando cycle é omitido ou null, o produto é avulso.

Alternativa: Você também pode criar e gerenciar seus produtos pelo Dashboard da AbacatePay.

post/products/create

Request body

externalIdstring required

Identificador único do produto no seu sistema.

namestring required

Nome do produto.

pricenumber required

Preço do produto em centavos.

currencystring required

Moeda do produto.

descriptionstring

Descrição opcional do produto.

imageUrlstring uri nullable

URL da imagem do produto. Opcional.

fileUrlstring uri

URL pública de um PDF a ser vinculado ao produto. Opcional. O arquivo é baixado e armazenado pela AbacatePay — máximo 20 MB. Após o pagamento, o comprador recebe acesso ao download do arquivo.

cycle'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUALLY' | 'ANNUALLY' nullable

Opcional. Indica se o produto é uma assinatura. Quando omitido ou null, o produto é avulso (pagamento único). Valores possíveis: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY.

Example request

{
  "externalId": "prod-123",
  "name": "Produto Exemplo",
  "price": 10000,
  "currency": "BRL"
}

Response

Produto criado com sucesso.

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "externalId": "prod-123",
    "name": "Produto Exemplo",
    "description": "Descrição do produto",
    "price": 10000,
    "currency": "BRL",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "status": "ACTIVE",
    "id": "prod_abc123xyz"
  },
  "success": true
}