Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MonthlyRewardSummary

Object describing the monthly rewards summary for the requested subscription ID.

Properties

Functions

Properties

Optional availableRewards

availableRewards: undefined | number

The number of rewards available for a specific usage period. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional earnedRewards

earnedRewards: undefined | number

The number of rewards earned for the specific usage period. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional eligibleUsageAmount

eligibleUsageAmount: undefined | number

The eligible usage amount for the usage period. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ineligibleUsageAmount

ineligibleUsageAmount: undefined | number

The ineligible usage amount for the usage period. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isManual

isManual: undefined | false | true

The boolean parameter to indicate whether or not the available rewards are manually posted.

Optional redeemedRewards

redeemedRewards: undefined | number

The number of rewards redeemed for a specific month. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeRewardsEarned

timeRewardsEarned: Date

The date and time when rewards accrue.

Optional timeRewardsExpired

timeRewardsExpired: Date

The date and time when rewards expire.

Optional timeUsageEnded

timeUsageEnded: Date

The end date and time for the usage period.

Optional timeUsageStarted

timeUsageStarted: Date

The start date and time for the usage period.

Optional usageAmount

usageAmount: undefined | number

The usage amount for the usage period. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional usagePeriodKey

usagePeriodKey: undefined | string

The usage period ID.

Functions

getDeserializedJsonObj

getJsonObj