Skip to main content
GET
/
v1
/
subscription
Buscar assinaturas
curl --request GET \
  --url https://sandbox.api.veepag.com/v1/subscription \
  --header 'apiKey: <api-key>'
{
  "items": [],
  "has_more": false,
  "limit": 20,
  "total_pages": 1,
  "page": 1,
  "total": 0,
  "query_count": 0
}

Authorizations

​
apiKey
string
header
required

API key no formato keyId.secret.

Query Parameters

​
page
number

Número da página (min 1, default 1)

​
limit
number

Quantidade por página (1-100, default 20)

​
sort.order
enum<string>
Available options:
asc,
desc
​
sort.property
enum<string>
Available options:
createdAt,
lastUpdate
​
rangeTime.end
string

Filtro de data final conforme sort.property

​
rangeTime.start
string

Filtro de data inicial conforme sort.property

​
status
enum<string>[]
Available options:
ACTIVE,
ERROR_PAYMENT,
NO_PAYMENT_ROUTE,
CREATED,
PENDING_PAYMENT,
RECOVERED,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA,
BLOCKED,
CANCELED_MANUAL,
IMPORTED,
STANDBY,
OVERDUE
​
clientId
string
​
id
string

Response

Assinaturas paginadas.

​
items
object[]
​
has_more
boolean
Example:

false

​
limit
integer
Example:

20

​
total_pages
integer
Example:

1

​
page
integer
Example:

1

​
total
integer
Example:

0

​
query_count
integer
Example:

0