Get Billing Period Transactions

Retrieves transactions for a line of credit account within a specified billing period.

Credit transactions, such as a rewards redemption, include a creditCategory.

To return only transactions with earned or redeemed reward points, set rewardType to earned or redeemed. When you filter by rewardType, the reward fields count only the earned or redeemed points, without reversals, so they can differ from the net values returned for the same transaction without the filter. A filtered page can contain fewer transactions than pageSize, so keep requesting pages until nextPageToken is empty.

Path parameters

  • account_id (string): The unique identifier (UUID) of the account.

Query parameters

  • fromDate (string, optional): The start date of the billing period, in YYYY-MM-DD format.
  • toDate (string, optional): The end date of the billing period, in YYYY-MM-DD format.
  • pageSize (integer, optional): The number of results to return per page.
  • pageToken (string, optional): The cursor token for the next page of results, returned in the previous response.
  • statuses (array, optional): Filters results by transaction status. Accepted values: active, reversed, dispute, settled, pending. To filter by more than one status, repeat the parameter, for example ?statuses=active&statuses=settled.
  • rewardType (string, optional): Filters results by reward points. Accepted values: all (default), earned, redeemed.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Early Access

Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.


Path Params
string
required

Unique Thredd account identifier.

Query Params
string | null

Start date of the requested range (YYYY-MM-DD).

string | null

End date of the requested range (YYYY-MM-DD).

integer
≥ 1
Defaults to 50

Number of records to return per page.

string | null

Cursor token used to retrieve the next page of results.

statuses
array of objects
Defaults to []

Filter transactions by status. Repeat the parameter to filter by multiple statuses.

Statuses
Allowed:
string
enum
Defaults to all

Returns only transactions with earned (earned) or redeemed (redeemed) reward points. Defaults to all, which returns every transaction.

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json