Skip to main content
Retorna todos os produtos da organização com suporte a filtros e paginação.

Autenticação

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

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
pageintegerNãoNúmero da página (default: 1)
limitintegerNãoItens por página (default: 10, máx: 100)
typestringNãoFiltrar por tipo (one_time, recurring)
isArchivedbooleanNãoFiltrar por status de arquivamento
sortingstringNãoOrdenação (ex: -created_at)

Campos da Resposta

CampoTipoDescrição
itemsarrayLista de produtos
items[].idstringID do produto
items[].namestringNome do produto
items[].descriptionstringDescrição
items[].isArchivedbooleanSe está arquivado
items[].pricesarrayLista de preços
items[].createdAtdatetimeData de criação
paginationobjectInformações de paginação

Exemplo de Requisição

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

Exemplo de Resposta

{
  "items": [
    {
      "id": "prod_abc123",
      "name": "Plano Pro",
      "description": "Acesso completo à plataforma",
      "isArchived": false,
      "prices": [
        {
          "id": "price_def456",
          "type": "recurring",
          "amount": 9990,
          "currency": "brl",
          "interval": "month"
        }
      ],
      "createdAt": "2026-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "total_count": 8,
    "max_page": 1
  }
}