Credits

List resellers' credits

GET/credits/accounts/

read Read: looks, changes nothing. Scopes

The resellers you can see, with their balance, spending this month and cheapest package price, a page at a time.

Query parameters

  • lowboolean

    Only resellers whose balance is below their cheapest package price (and not unlimited).

  • 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: only the resellers below you, the ones you can give credits to.

    One of: "subtree"

  • searchstring

    Matches the username.

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
    • idstring (uuid)required
    • usernamestringrequired
    • groupstringrequiredcan be null
    • parentobjectrequiredread-onlycan be null
      • idstring (uuid)required
      • usernamestringrequired
    • balancestring (decimal)required
    • unlimitedbooleanrequired
    • spent_this_monthstring (decimal)required
    • last_entry_atstring (date-time)requiredcan be null
    • cheapest_pricestring (decimal)requiredcan be null
    • lowbooleanrequiredread-only
    • is_activebooleanrequired

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