RUrunbear

Retrieve credit usage for the current billing period

Retrieve the organization's credit position for the current billing period: the credits included in the plan, the overage allowance and the overage consumed, and usage to date. The same numbers the Runbear billing page shows, for pulling into your own tracking.

get/v1/credits/usage

Request

  • Base URL
    https://api.runbear.io
  • Auth
    HTTP bearer

Response

Default Response

planIncludedCreditsnumber nullable required

Credits the plan includes each billing period, with an enterprise contract override taking precedence. null means unlimited.

complimentaryCreditsnumber required

Unexpired one-off credit grants on top of the plan. 0 when there are none.

includedCreditsnumber nullable required

planIncludedCredits + complimentaryCredits — the base overage is measured from. null means unlimited.

currentUsageCreditsnumber required

Chargeable credits consumed so far in the current billing period.

overageCreditsUsednumber required

Chargeable credits consumed beyond includedCredits — usage past the included allowance, not the invoiced amount (the two can differ). Always 0 on an unlimited plan.

overageLimitCreditsnumber nullable required

The overage allowance enabled for the organization. null when overage is off, which caps usage at includedCredits.

periodStartstring required

Start of the billing period the usage figures cover (ISO 8601).

periodEndstring required

End of that period (ISO 8601), exclusive.

Changes

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