Skip to main content
GET
List usage lines of a month

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: providerName, voucherSetName, quantity, netAmount. Default providerName. The server appends id as a tie-breaker.

Example:

"providerName"

Case-insensitive search (at most 255 characters) over providerName, voucherSetName.

Maximum string length: 255
filter[serviceMonth]
string

Service month (required) (equals).

Pattern: ^\d{4}-\d{2}$
filter[providerPartnerId]
integer

Provider id (equals).

Required range: x >= 0
filter[providerPartnerId][in]
string

Provider id (one of (comma-separated)). Comma-separated values.

filter[voucherSetId]
integer

Voucher set id (equals).

Required range: x >= 0
filter[voucherSetId][in]
string

Voucher set id (one of (comma-separated)). Comma-separated values.

filter[priced]
boolean

Priced (equals).

Response

OK

Page envelope of BillingUsageLine items.

data
object
required

The page.