Saltar al contenido principal
GET
/
plans
List plans
curl --request GET \
  --url https://billing-api.sandbox.z2pay.com/plans \
  --header 'x-api-key: <api-key>'

Autorizaciones

​
x-api-key
string
header
requerido

API Key da Credential (gerada no Backoffice)

Parámetros de consulta

​
page
integer
predeterminado:1
Rango requerido: x >= 1
​
limit
integer
predeterminado:20
Rango requerido: 1 <= x <= 100
​
status
string
requerido
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
Rango requerido: x >= 0
​
priceMax
integer
Rango requerido: x >= 0
​
createdFrom
​
createdTo
​
sortBy
enum<string>
Opciones disponibles:
createdAt,
name
​
sortDir
enum<string>
Opciones disponibles:
asc,
desc
​
idsIn
string[]

Respuesta

Paginated list of plans