cfw-autumn/packages/sdk/docs/models/balances-check-balance.md

BalancesCheckBalance

Example Usage

import { BalancesCheckBalance } from "@useautumn/sdk";

let value: BalancesCheckBalance = {
  featureId: "<id>",
  granted: 5805.07,
  remaining: 2547.08,
  usage: 3557.86,
  unlimited: false,
  overageAllowed: true,
  maxPurchase: 7196.64,
  nextResetAt: 709.93,
};

Fields

Field	Type	Required	Description
featureId	string	✔️	N/A
feature	models.BalancesCheckFeature	➖	N/A
granted	number	✔️	N/A
remaining	number	✔️	N/A
usage	number	✔️	N/A
unlimited	boolean	✔️	N/A
overageAllowed	boolean	✔️	N/A
maxPurchase	number	✔️	N/A
nextResetAt	number	✔️	N/A
breakdown	models.BalancesCheckBreakdown[]	➖	N/A
rollovers	models.BalancesCheckBalanceRollover[]	➖	N/A