Skip to main content
Cria um produto associado a uma sub-organização filha. A organização autenticada deve ser a organização pai da orgId informada. Além dos dados do produto, é necessário informar a taxa de comissão (fee_percent) que será aplicada nas vendas deste produto. Retorna o objeto do produto criado com status HTTP 201 Created. Ver também: Listar produtos da sub-organização e Atualizar produto da sub-organização para manter o catálogo depois da criação.

​
Autenticação

Requer Organization Access Token (OAT) da organização pai via header Authorization: Bearer. A organização autenticada deve ser a organização pai da orgId informada.

​
Parâmetros de Path

​
orgId
string
required
Identificador único da sub-organização filha para a qual o produto será criado.

​
Corpo da Requisição

​
fee_percent
number
required
Percentual de comissão a ser aplicado nas vendas deste produto. Valores aceitos: 0 a 50.
​
name
string
required
Nome do produto.
​
description
string
Descrição detalhada do produto.
​
price
integer
Preço do produto em centavos.
​
recurring
boolean
Indica se o produto é recorrente (assinatura). Padrão: false.
​
recurring_interval
string
Intervalo de recorrência. Valores aceitos: month, year. Obrigatório quando recurring for true.

​
Resposta

Retorna o objeto do produto criado com status 201 Created.
​
id
string
Identificador único do produto criado.
​
name
string
Nome do produto.
​
description
string
Descrição do produto.
​
price
integer
Preço do produto em centavos.
​
fee_percent
number
Percentual de comissão configurado para este produto.
​
organization_id
string
Identificador da organização à qual o produto pertence.
​
created_at
string
Data e hora de criação do produto no formato ISO 8601.

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/sdk/organizations/org_01j9abc333/products" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Plano Mensal",
    "description": "Acesso completo ao plano mensal",
    "price": 9900,
    "fee_percent": 10,
    "recurring": true,
    "recurring_interval": "month"
  }'

​
Resposta de Exemplo

{
  "id": "prod_01j9xyz999",
  "name": "Plano Mensal",
  "description": "Acesso completo ao plano mensal",
  "price": 9900,
  "fee_percent": 10,
  "organization_id": "org_01j9abc333",
  "created_at": "2024-11-01T10:30:00Z"
}