minimusdocs
Help center

Credits

Get your credit balance

GET/credits/me/

read Read: looks, changes nothing. Scopes

Your balance and what you may do with credits: spending this month, what the resellers below you hold, your cheapest package price and your trial lines. Reseller-only figures are null for a panel operator.

Response

200 OK

  • balancestring (decimal)required
  • unlimitedbooleanrequired

    Lines cost this account nothing, whatever its balance.

  • is_resellerbooleanrequired

    The account pays for its lines with credits.

  • can_adjustbooleanrequired

    May add or remove resellers' credits.

  • can_givebooleanrequired

    May give credits to the resellers below it.

  • can_view_allbooleanrequired

    Sees every reseller's credits.

  • can_manage_pricesbooleanrequired

    May set resellers' own package prices.

  • spent_this_monthstring (decimal)required

    Spent on lines this calendar month, net of refunds.

  • held_by_subresellersstring (decimal)requiredcan be null

    What the resellers below it hold. Null for an operator.

  • cheapest_pricestring (decimal)requiredcan be null

    The lowest price it pays for a package it sells. Null when none.

  • lowbooleanrequired

    The balance is below the cheapest price.

  • trialsobjectrequiredcan be null

    Trial lines; null for an operator.

    • limitintegerrequiredcan be null

      Trial lines allowed per period; null: no limit.

    • periodstringrequired
      • day - day
      • week - week
      • month - month

      One of: "day" "week" "month"

    • usedintegerrequired

      Trial lines made in the current period.

    • leftintegerrequiredcan be null

      Null: no limit.

    • enabledbooleanrequired

      Whether this account may make trial lines at all.

    • min_balancestring (decimal)required

      The balance a trial line needs.

    • blockedstringrequiredcan be null

      Why the next trial line would be refused: none left, or the balance is too low. Null: it would not.

      • limit - limit
      • min_balance - min_balance
    • next_atstring (date-time)requiredcan be null

      When the next trial line opens, once none are left.

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