Skip to main content
GET
/
plans
List plans
curl --request GET \
  --url https://billing-api.sandbox.z2pay.com/plans \
  --header 'x-api-key: <api-key>'

Authorizations

​
x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
status
string
required
Maximum string length: 100
​
search
string
Maximum string length: 100
​
code
string
Maximum string length: 100
​
name
string
Maximum string length: 255
​
item
string
Maximum string length: 255
​
priceMin
integer
Required range: x >= 0
​
priceMax
integer
Required range: x >= 0
​
createdFrom
​
createdTo
​
sortBy
enum<string>
Available options:
createdAt,
name
​
sortDir
enum<string>
Available options:
asc,
desc
​
idsIn
string[]

Response

Paginated list of plans