Retrieve paginated list of billing periods

get

https://api.pixop.com/api/v1/billing-periods

Retrieves a paginated list of billing periods associated with the provided API key.

Query Params

pageNumber

int32

≥ 0

Defaults to 0

Specifies the current page number, starting at 0.

pageSize

int32

1 to 100

Defaults to 10

Specifies the number of items per page.

sortDirection

string

enum

Defaults to ASC

Specifies the sort direction for the results:

ASC: ascending order.
DESC: descending order.

Allowed:

sortBy

string

enum

Defaults to createdAt

Specifies the field to sort the results by.

Allowed:

teamId

uuid

Filters results by the specified team ID.

fromDate

date

Filters results by creation date. Includes only items created at or after the specified date. Defaults to the creation date of the team.

toDate

date

Filters results by creation date. Includes only items created at or before the specified date. Defaults to the current date.

endedMode

string

enum

Defaults to INCLUDE

Filters results based on the ended mode:

INCLUDE: Includes ended billing periods in the result.
EXCLUDE: Excludes ended billing periods from the result.
ONLY: Only returns ended billing periods in the result.

Allowed:

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Successfully retrieved the paginated list of billing periods.

400Invalid request. Inspect the details of the error for more information.

401Authentication failed. Missing or invalid X-API-Key or basic authentication credentials.

403Access denied. You do not have the necessary permissions to access this resource.

404The requested resource could not be found.

429Too Many Requests. The rate limit for this resource has been exceeded.

500An unexpected error occurred on the server.