Retrieve Payment Levels Rebate
Returns the part of its account’s monthly Whop Levels rebate a card payment earned: the processing fee above its level’s rate, once the month its fee posted in has closed. The rebate is paid to the account as one sum each month, so the payment’s own amounts and fees never change.
Autorisaties
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Respons
rebate retrieved
How much of the payment the month's spend covered, from 0 to 1: 1 for every rebated payment but the month's last, which can be covered in part, so its rebate is that share of the fee above the level's rate. null unless status is rebated.
1
Estimate of the payment's part of its account's monthly rebate, as if its month closed now. It uses the account's level so far and the share of the payment that its spend so far covers. Both can change until the month closes. null unless status is pending with the processing fee posted, and when estimates are unavailable.
Why the payment can't earn a rebate: not_card_payment, before_levels (made before Whop Levels started), not_in_levels (its account wasn't in Whop Levels that month), fee_not_posted, fee_at_level_rate (its fee was already at or below the level's rate) or no_level_rate (its fee matched no level rate). null unless status is ineligible.
not_card_payment, before_levels, not_in_levels, fee_not_posted, fee_at_level_rate, no_level_rate, null "not_card_payment"
rebated when the payment earned part of its account's monthly Whop Levels rebate. pending until the month its processing fee posted in has closed. not_covered when the account's spend that month ran out before this payment. ineligible when it can't earn one; ineligible_reason says why.
rebated, pending, not_covered, ineligible "rebated"

