POST /api/v1/sdk/organizations/:orgId/products

Cria um produto em nome de uma sub-organização filha, gerenciado pela organização pai autenticada.

Cria um produto associado a uma sub-organização filha. A organização autenticada deve ser a organização pai da orgId informada. Retorna o objeto do produto criado com status HTTP 201 Created.

Taxas de split: o percentual de comissão cobrado pela organização pai é configurado uma vez na relação pai/filha (via hosted onboarding sessions ou link-as-parent) e aplicado automaticamente em todas as vendas da filha. Não há mais override por produto.

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

name · string · required

Nome do produto.

description · string

Descrição detalhada do produto.

metadata · object

Metadados livres (chave/valor) associados ao produto.

is_tax_applicable · boolean

Indica se o produto é tributável. Padrão: true.

prices · array · required

Lista com pelo menos 1 price inline. O primeiro vira default_price_id do produto (a menos que default_price_index seja passado).

Show Price

currency · string · required

Código ISO de 3 letras em minúsculas (ex: brl).

unit_amount · integer · required

Valor unitário em minor units (centavos). 0 é válido para preço gratuito one-time.

type · string

one_time (padrão) ou recurring.

interval · string

Obrigatório quando type=recurring. Valores: day, week, month, year.

interval_count · integer

Quantidade de intervalos entre cobranças (padrão 1). Só tem efeito em prices recurring.

tax_behavior · string

unspecified (padrão), inclusive ou exclusive.

metadata · object

Metadados livres por price.

active · boolean

Padrão: true.

default_price_index · integer

Índice (base 0) do price dentro de prices[] que vira o default_price_id. Padrão: 0.

Resposta

Retorna o objeto do produto criado com status 201 Created, incluindo default_price_id e prices[] completo.

id · string

Identificador único do produto criado.

name · string

Nome do produto.

description · string

Descrição do produto.

default_price_id · string

ID da price padrão — usada em checkouts quando o caller não especifica product_price_id.

prices · array

Lista de prices criadas (shape Stripe-like: id, type, currency, unit_amount, interval, interval_count, tax_behavior, metadata, active, zoop_recurrence_plan_id).

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

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",
    "prices": [
      {
        "currency": "brl",
        "unit_amount": 9900,
        "type": "recurring",
        "interval": "month",
        "interval_count": 1
      }
    ]
  }'

Resposta de Exemplo

{
  "id": "prod_01j9xyz999",
  "name": "Plano Mensal",
  "description": "Acesso completo ao plano mensal",
  "default_price_id": "price_01j9xyz998",
  "prices": [
    {
      "id": "price_01j9xyz998",
      "type": "recurring",
      "currency": "brl",
      "unit_amount": 9900,
      "interval": "month",
      "interval_count": 1,
      "tax_behavior": "unspecified",
      "metadata": {},
      "active": true,
      "zoop_recurrence_plan_id": null
    }
  ],
  "organization_id": "org_01j9abc333",
  "created_at": "2024-11-01T10:30:00Z"
}