GET /api/v1/products/:id - Chargefy

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âmetro	Tipo	Obrigatório	Descrição
`id`	`string`	Sim	ID do produto

Resposta

Shape completo do produto:

Campo	Tipo	Descrição
`id`	`string`	ID
`organization_id`	`string`	Organização dona
`name`	`string`	Nome
`description`	`string \| null`	Descrição
`metadata`	`object`	Metadata livre
`is_archived`	`boolean`	Arquivado
`is_tax_applicable`	`boolean`	Tributável
`default_price_id`	`string \| null`	FK pro preço default
`prices`	`Price[]`	Array de preços do produto
`created_at`	`datetime`	ISO 8601
`modified_at`	`datetime \| null`	ISO 8601

Price object

Campo	Tipo	Descrição
`id`	`string`	ID
`product_id`	`string`	FK
`type`	`'one_time' \| 'recurring'`	Tipo
`currency`	`string`	ISO 4217 em minúsculas
`unit_amount`	`integer`	Valor em minor units
`interval`	`'day' \| 'week' \| 'month' \| 'year' \| null`	Cadência
`interval_count`	`integer \| null`	Quantidade de intervalos (default 1 em recurring)
`tax_behavior`	`string \| null`	`unspecified`, `inclusive`, `exclusive`
`active`	`boolean`	Ativo pra novas vendas
`metadata`	`object`	Metadata do preço
`zoop_recurrence_plan_id`	`string \| null`	Plano Zoop atrelado (populado automaticamente)

Exemplos

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

import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const product = await chargefy.products.get('prod_abc123');

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
}