credits

List credit ledger entries

The raw immutable ledger (detailed retention window only), newest first by default.

get/credits/ledger/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/credits/ledger/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

entry_kind'grant' | 'expiry' | 'pack_purchase' | 'charge' | 'refund' | 'referral' | 'adjustment'

The kind of a credit ledger entry.

entry_kind__inCreditEntryKind[] nullable

Only entries of any of these kinds. Repeat the parameter for each kind. Use this rather than several requests when a surface shows a mix ('where did my credits come from', say, which wants every kind except usage charges).

start_timestring date-time nullable
end_timestring date-time nullable
limitinteger

The number of items to return.

order_by'id' | 'occurred_at' | 'created_at' | 'updated_at'
order_direction'asc' | 'desc'
cursorstring nullable

Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

Response

Successful Response

next_page_cursorstring nullable

The cursor to the next page. If there are no more pages, this is None.

previous_page_cursorstring nullable

The cursor to the previous page. If there are no previous pages, this is None.

Changes

No recorded changes to this operation across all 1 revision of this API.