Skip to main content
GET
List products

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
per_page
integer
default:50

Number of records per page. Maximum: 50.

Required range: 1 <= x <= 50
order_by
enum<string>
default:created_at

Field to sort by.

Available options:
created_at,
name
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
name
string

Filter by product name (case-insensitive contains).

is_active
enum<string>

Filter by active status.

Available options:
true,
false
currency
string

Filter by ISO 4217 currency code (e.g. BRL, USD).

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

Filter by billing cycle.

Available options:
monthly,
yearly,
weekly,
daily,
one_time

Response

Products returned successfully.

data
object[]
meta
object