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

Criar um produto

cURL

curl --request POST \
  --url https://api.abacatepay.com/v2/products/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "prod-123",
  "name": "Produto Exemplo",
  "price": 10000,
  "currency": "BRL"
}
'

import requests

url = "https://api.abacatepay.com/v2/products/create"

payload = {
    "externalId": "prod-123",
    "name": "Produto Exemplo",
    "price": 10000,
    "currency": "BRL"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalId: 'prod-123', name: 'Produto Exemplo', price: 10000, currency: 'BRL'})
};

fetch('https://api.abacatepay.com/v2/products/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.abacatepay.com/v2/products/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => 'prod-123',
    'name' => 'Produto Exemplo',
    'price' => 10000,
    'currency' => 'BRL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.abacatepay.com/v2/products/create"

	payload := strings.NewReader("{\n  \"externalId\": \"prod-123\",\n  \"name\": \"Produto Exemplo\",\n  \"price\": 10000,\n  \"currency\": \"BRL\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.abacatepay.com/v2/products/create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"prod-123\",\n  \"name\": \"Produto Exemplo\",\n  \"price\": 10000,\n  \"currency\": \"BRL\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.abacatepay.com/v2/products/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"prod-123\",\n  \"name\": \"Produto Exemplo\",\n  \"price\": 10000,\n  \"currency\": \"BRL\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "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,
    "hasFile": false
  },
  "error": null,
  "success": true
}

{
  "error": "Token de autenticação inválido ou ausente."
}

Cria um produto no seu catálogo para usar em checkouts, assinaturas e links de pagamento.

Obrigatórios

externalId (único no seu sistema), name, price (em centavos) e currency (sempre "BRL").

Produto digital com arquivo para download (passe fileUrl com a URL pública de um PDF):

{
  "externalId": "ebook-001",
  "name": "E-book: Guia Completo",
  "price": 4990,
  "currency": "BRL",
  "fileUrl": "https://exemplo.com/guia-completo.pdf"
}

fileUrl deve apontar para um PDF público acessível. Tamanho máximo: 20 MB. O arquivo é armazenado pela AbacatePay e o comprador recebe acesso após o pagamento. O campo hasFile: true na resposta confirma o vínculo.

Produto avulso (pagamento único — omita cycle):

{
  "externalId": "prod-123",
  "name": "Camiseta Premium",
  "price": 8990,
  "currency": "BRL",
  "description": "Camiseta 100% algodão"
}

Produto de assinatura (defina cycle):

{
  "externalId": "plano-mensal",
  "name": "Plano Mensal",
  "price": 4990,
  "currency": "BRL",
  "cycle": "MONTHLY"
}

Produto de assinatura com período de teste gratuito (defina trialDays):

{
  "externalId": "plano-mensal-trial",
  "name": "Plano Mensal com 7 dias grátis",
  "price": 4990,
  "currency": "BRL",
  "cycle": "MONTHLY",
  "trialDays": 7
}

Valores de cycle: WEEKLY · MONTHLY · QUARTERLY · SEMIANNUALLY · ANNUALLY

trialDays exige cycle. Valor inteiro entre 1 e 90. O cliente não é cobrado durante o período de teste — a primeira cobrança ocorre ao final do trial.

Guarde o data.id retornado — é ele que você passa como items[].id ao criar checkouts e assinaturas.

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.

Body

application/json

Dados necessários para criar um produto.

externalId · string · required

Identificador único do produto no seu sistema.

Example:

"prod-123"

name · string · required

Nome do produto.

Example:

"Produto Exemplo"

price · number · required

Preço do produto em centavos.

Required range: x >= 1

Example:

10000

currency · string · default: BRL · required

Moeda do produto.

Example:

"BRL"

description · string

Descrição opcional do produto.

Example:

"Descrição do produto"

imageUrl · string<uri> | null

URL da imagem do produto. Opcional.

Example:

null

fileUrl · string<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.

Example:

"https://exemplo.com/meu-ebook.pdf"

cycle · enum<string> | null

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

Available options: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY

Example:

null

Response

200

application/json

Produto criado 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.

Show child attributes

error · string | null

Example:

null

success · boolean

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

Example:

true