Pular para o conteúdo principal
GET
/
plans
List plans
curl --request GET \
  --url https://billing-api.sandbox.z2pay.com/plans \
  --header 'x-api-key: <api-key>'

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Parâmetros de consulta

​
page
integer
padrão:1
Intervalo obrigatório: x >= 1
​
limit
integer
padrão:20
Intervalo obrigatório: 1 <= x <= 100
​
status
string
obrigatório
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
Intervalo obrigatório: x >= 0
​
priceMax
integer
Intervalo obrigatório: x >= 0
​
createdFrom
​
createdTo
​
sortBy
enum<string>
Opções disponíveis:
createdAt,
name
​
sortDir
enum<string>
Opções disponíveis:
asc,
desc
​
idsIn
string[]

Resposta

Paginated list of plans