List Period charges for a User (keyset/cursor)

get

https://api.revenium.ai/profitstream/v2/api/users/{id}/period-charges

Lists the charges already on an invoice or awaiting invoicing that a user owns, created between start and end, newest first, one page at a time. Items are in _embedded.periodChargeResourceList. The response also has 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. The window from start to end may be at most 366 days.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the user to retrieve period charges for. This is the Revenium-generated hashid returned when the user was created, visible in the user list endpoint, and used in all user-related API operations. Format: URL-safe encoded string.

Query Params

productId

string

The product id

start

string

required

Sent as the query parameter start. Required. The earliest charge creation time to include, in UTC, in the exact form yyyy-MM-ddTHH:mm:ss.SSSZ with milliseconds, for example 2025-10-01T00:00:00.000Z. Other forms are rejected.

end

string

required

Sent as the query parameter end. Required. The latest charge creation time to include, in UTC, in the exact form yyyy-MM-ddTHH:mm:ss.SSSZ with milliseconds, for example 2025-10-31T23:59:59.999Z. Must not be before start, and at most 366 days after 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 parameters (e.g. malformed cursor)

401Unauthorized - Authentication required

403Forbidden - user is not authorized to view the organization's users

404User or product not found

409Conflict

422Unprocessable entity - Validation failed

429Too Many Requests

500Internal server error

504Gateway Timeout