List Period charges for a User

get

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

Retrieve a paginated list of period charges for a user.

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 timestamp

string

required

End timestamp

string

required

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 10

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Response

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

application/json

application/hal+json

200Returns a paginated list of Period Charge objects.

400Invalid request parameters

401Unauthorized - Authentication required

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

404User or product not found

409Conflict - Resource conflict

422Unprocessable entity - Validation failed

500Internal server error