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 todos os produtos da organização com suporte a filtros e paginação. Cada item inclui o array prices[] e o default_price_id.

​
Autenticação

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

​
Query

ParâmetroTipoDefaultDescrição
organization_idstring—FK da organização (requerido quando token é multi-org)
pageinteger1Número da página
limitinteger10 (máx 100)Itens por página
is_archivedboolean—Filtra por status arquivado. Omitido = ambos
querystring—Busca por nome (case-insensitive, parcial)
idstring | string[]—Um ou vários IDs
sortingstring-created_atOrdem. Prefixo - = decrescente

​
Resposta

CampoTipoDescrição
itemsProduct[]Lista (cada item no shape completo — ver Obter Produto)
pagination.total_countintegerTotal de produtos
pagination.max_pageintegerÚltima página possível dado o limit

​
Exemplos

curl -X GET "https://api.chargefy.io/api/v1/products/?limit=20&is_archived=false" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​
Resposta de exemplo

{
  "items": [
    {
      "id": "prod_abc123",
      "organization_id": "org_abc",
      "name": "Plano Pro",
      "description": "Acesso completo",
      "metadata": {},
      "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"
    }
  ],
  "pagination": {
    "total_count": 8,
    "max_page": 1
  }
}