List Period Charges (keyset/cursor)

get

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

Lists the charges already on an invoice or awaiting invoicing for a team, one page at a time. Returns up to size items in _embedded.periodChargeResourceList, plus hasMore and a top-level cursor, which is null on the last page. To get the next page, send that cursor back as the cursor query parameter. The response has no total count. Use invoiceId to list the charges on one invoice, and startDate with endDate to limit results by the time each charge was created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

required

The ID of the team to list period charges for, a short string ID such as jR2kmLs.

invoiceId

string

Optional. The ID of an invoice, to list only the charges on that invoice.

startDate

string

Include charges created at or after this time. ISO 8601 in UTC with a trailing Z, for example 2025-10-01T00:00:00Z. Send it together with endDate.

endDate

string

Include charges created at or before this time. ISO 8601 in UTC with a trailing Z, for example 2025-10-31T23:59:59Z. Send it together with startDate, and not before it.

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

504Gateway Timeout