Skip to main content
GET
Listar produtos

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de consulta

page
integer
padrão:1

Número da página.

Intervalo necessário: x >= 1
per_page
integer
padrão:50

Registros por página. Máximo: 50.

Intervalo necessário: 1 <= x <= 50
order_by
enum<string>
padrão:created_at

Campo de ordenação.

Opções disponíveis:
created_at,
name
order
enum<string>
padrão:desc

Direção da ordenação.

Opções disponíveis:
asc,
desc
name
string

Filtrar por nome do produto (contém, sem distinção de maiúsculas).

is_active
enum<string>

Filtrar por status de ativo.

Opções disponíveis:
true,
false
currency
string

Filtrar por código ISO 4217 da moeda (ex: BRL, USD).

Pattern: ^[A-Z]{3}$
billing_cycle
enum<string>

Filtrar por ciclo de cobrança.

Opções disponíveis:
monthly,
yearly,
weekly,
daily,
one_time

Resposta

Produtos retornados com sucesso.

data
object[]
meta
object