Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

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

Retorna um produto pelo ID, incluindo default_price_id, prices[] completos e metadata.

​
Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

​
Path

ParâmetroTipoObrigatórioDescrição
idstringSimID do produto

​
Resposta

Shape completo do produto:
CampoTipoDescrição
idstringID
organization_idstringOrganização dona
namestringNome
descriptionstring | nullDescrição
metadataobjectMetadata livre
is_archivedbooleanArquivado
is_tax_applicablebooleanTributável
default_price_idstring | nullFK pro preço default
pricesPrice[]Array de preços do produto
created_atdatetimeISO 8601
modified_atdatetime | nullISO 8601

​
Price object

CampoTipoDescrição
idstringID
product_idstringFK
type'one_time' | 'recurring'Tipo
currencystringISO 4217 em minúsculas
unit_amountintegerValor em minor units
interval'day' | 'week' | 'month' | 'year' | nullCadência
interval_countinteger | nullQuantidade de intervalos (default 1 em recurring)
tax_behaviorstring | nullunspecified, inclusive, exclusive
activebooleanAtivo pra novas vendas
metadataobjectMetadata do preço
zoop_recurrence_plan_idstring | nullPlano de recorrência atrelado (populado automaticamente)

​
Exemplos

curl -X GET "https://api.chargefy.io/api/v1/products/prod_abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​
Resposta de exemplo

{
  "id": "prod_abc123",
  "organization_id": "org_abc",
  "name": "Plano Pro",
  "description": "Acesso completo à plataforma",
  "metadata": { "tier": "pro" },
  "is_archived": false,
  "is_tax_applicable": true,
  "default_price_id": "price_def456",
  "prices": [
    {
      "id": "price_def456",
      "product_id": "prod_abc123",
      "type": "recurring",
      "currency": "brl",
      "unit_amount": 9990,
      "interval": "month",
      "interval_count": 1,
      "tax_behavior": "unspecified",
      "active": true,
      "metadata": {},
      "zoop_recurrence_plan_id": "zpp_abc"
    }
  ],
  "created_at": "2026-01-10T08:00:00Z",
  "modified_at": null
}