Interface: CreditProjection

What a queued Charge would redeem in credits if it processed now, in the Charge's presentment currency.

Properties

blocked_by_exclusion: Record<ExcludableCreditAccountType, BlockedByExclusion>

How much each credit type lost to the store's product exclusions.

capped_by_redemption_limit: boolean

Whether the max redemption limit would hold back non-gift credit if the customer opted in. Goes with total_to_apply_if_opted_in.

currency_code: string

The code of the currency of the projected amounts, such as USD.

gift_to_apply: string

Gift credit the Charge will redeem.

non_gift_to_apply: string

Non-gift credit the Charge will redeem.

total_to_apply: string

Total credit the Charge will redeem if nothing changes.

total_to_apply_if_opted_in: string

Like total_to_apply, but as if the customer applied credit to their next recurring charge.