Credits

Read current available and reserved credits

get/credits/balance

Request

  • Base URL: https://api.flashdata.dev/v2
  • URL: https://api.flashdata.dev/v2/credits/balance
  • Auth: API key in cookie __Host-fd_session

Response

Credit balance

balanceCreditsnumber required

Signed settled balance after grants, usage, refunds and provider reversals.

reservedCreditsnumber required
availableCreditsnumber required

max(balanceCredits, 0).

lifetimeGrantedCreditsnumber required
lifetimeUsedCreditsnumber required
lifetimeRefundedCreditsnumber required

Credits returned to the account after failed usage.

lifetimePaymentReversedCreditsnumber required

Absolute Credits removed after verified provider refunds or chargebacks.

updatedAtstring date-time required

Changes

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