Credits

List credit history

GET/credits/entries/

read Read: looks, changes nothing. Scopes

Every change to the balances you can see, newest first, a page at a time: lines bought, extended and refunded, credits given, added and removed.

Query parameters

  • accountstring (uuid)

    Only this account's rows (a reseller you can see).

  • actorstring (uuid)

    Only what this account did.

  • date_fromstring

    A date (2026-11-01, the whole day) or a date-time.

  • date_tostring

    A date (the whole day included) or a date-time.

  • kindstring

    Comma-separated kinds: adjust, line_new, line_extend, line_trial, refund, transfer_out, transfer_in, returned, written_off, import.

  • linestring (uuid)

    Only rows about this line.

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • scopestring

    subtree: your rows and those of every reseller below you. Default: yours only (everyone's for an account that sees all credits).

    One of: "subtree"

  • searchstring

    Matches names, the package, the reason and the reference.

  • typestring

    Why an operator added or removed credits.

    One of: "correction" "other" "payment" "promo" "refund"

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idintegerrequiredread-only
    • created_atstring (date-time)requiredread-only
    • accountobjectrequiredread-onlycan be null
      • idstring (uuid)required
      • usernamestringrequired
    • account_namestringrequiredread-only
    • amountstring (decimal)requiredread-only
    • balance_afterstring (decimal)requiredread-only
    • kindstringrequiredread-only
    • kind_labelstringrequiredread-only
    • typestringrequiredread-only
    • type_labelstringrequiredread-only
    • descriptionstringrequiredread-only
    • actor_namestringrequiredread-only
    • by_mebooleanrequiredread-onlycan be null
    • counterparty_namestringrequiredread-only
    • lineobjectrequiredread-onlycan be null
      • idstring (uuid)required
      • usernamestringrequired
    • line_namestringrequiredread-only
    • package_namestringrequiredread-only
    • durationstringrequiredread-only
    • expires_atstring (date-time)requiredread-onlycan be null
    • reasonstringrequiredread-only
    • referencestringrequiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means