GET /api/v1/products/

Retorna uma lista paginada de produtos da organização

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âmetro	Tipo	Default	Descrição
organization_id	string	—	FK da organização (requerido quando token é multi-org)
page	integer	1	Número da página
limit	integer	10 (máx 100)	Itens por página
is_archived	boolean	—	Filtra por status arquivado. Omitido = ambos
query	string	—	Busca por nome (case-insensitive, parcial)
id	string | string[]	—	Um ou vários IDs
sorting	string	-created_at	Ordem. Prefixo - = decrescente

​

Resposta

Campo	Tipo	Descrição
items	Product[]	Lista (cada item no shape completo — ver Obter Produto)
pagination.total_count	integer	Total de produtos
pagination.max_page	integer	Última página possível dado o limit

​

Exemplos

cURL

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
  }
}