List Period Charges (keyset/cursor)

get

https://api.revenium.ai/profitstream/v2/api/period-charges

Canonical keyset-paginated list of period charges for an organization. Returns up to size items in _embedded.periodChargeResourceList plus an opaque cursor (top-level, null on the last page) and a hasMore flag — no totalElements, no totalPages. Pass the previous response's cursor back as the cursor query param to fetch the next page. Replaces the prior offset/PagedModel contract and the deprecated /period-charges/cursor sibling. Optional invoiceId scopes to a single invoice; optional startDate/endDate filter on the created timestamp.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

required

Unique identifier of the team (organization) to list period charges for. Format: Revenium hashid (URL-safe encoded string).

invoiceId

string

Optional invoice identifier to filter period charges. Format: Revenium hashid (URL-safe encoded string).

startDate

string

Inclusive lower bound for the created timestamp in ISO 8601 format. Must be paired with endDate.

endDate

string

Inclusive upper bound for the created timestamp in ISO 8601 format. Must be paired with startDate.

cursor

string

Opaque cursor from the previous response's top-level cursor. Omit for the first page.

size

int32

Defaults to 50

Page size. Clamped to [1, 200].

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

application/hal+json

*/*

200Returns a cursor-paginated list of period charge objects.

400Invalid request (e.g. malformed cursor, mismatched date params, invalid date format)

401Unauthorized

403Forbidden - user is not authorized to view the organization

404Organization or invoice not found

409Conflict

422Unprocessable Content

429Too Many Requests