How much the payment is for after feesExample:
6.9The application fee charged on this payment.
Whether this payment was auto refunded or not
The address of the user who made the payment.
The machine-readable reason this charge was created, such as initial subscription purchase, renewal cycle, or one-time payment.Available options:
subscription_create, subscription_cycle, subscription_update, one_time, manual, subscriptionCard network reported by the processor (e.g., ‘visa’, ‘mastercard’, ‘amex’). Present only when the payment method type is ‘card’.Available options:
mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, tarjeta_naranja, cirrus, nspk_mir, verve, ebt, private_label, local_brand, uatp, wexcard, uzcard, meeza, hrg_store_card, girocard, fuel_card, dankort, carnet, atm_card, china_union_payuzcard, codensa, cabal, hipercard, jcblankapay, cmi, unknownThe last four digits of the card used to make this payment. Null if the payment was not made with a card.Example:
4242The ID of the checkout session/configuration that produced this payment, if
any. Use this to map payments back to the checkout configuration that created
them.
The company for the payment.
The datetime the payment was created.Example:
2023-12-01T05:00:00.401ZThe three-letter ISO currency code for this payment (e.g., ‘usd’, ‘eur’).Available options:
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xauWhen an alert came in that this transaction will be disputedExample:
2023-12-01T05:00:00.401ZThe disputes attached to this payment. Null if the actor in context does not have the payment:dispute:read permission.
If the payment failed, the reason for the failure.
The number of financing installments for the payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).Example:
42The financing transactions attached to this payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).
The unique identifier for the payment.Example:
pay_xxxxxxxxxxxxxxThe time of the last payment attempt.Example:
2023-12-01T05:00:00.401ZThe member attached to this payment.
The membership attached to this payment.
The custom metadata stored on this payment. This will be copied over to the
checkout configuration for which this payment was made
The time of the next schedule payment retry.Example:
2023-12-01T05:00:00.401ZThe time at which this payment was successfully collected. Null if the payment has not yet succeeded. As a Unix timestamp.Example:
2023-12-01T05:00:00.401ZThe tokenized payment method reference used for this payment. Null if no token was used.
The type of payment instrument used for this payment (e.g., card, Cash App, iDEAL, Klarna, crypto). Null when the processor does not supply a type.Available options:
acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple, apple_pay, au_bank_transfer, au_becs_debit, bacs_debit, bancolombia, bancontact, billie, bizum, blik, boleto, bre_b, ca_bank_transfer, capchase_pay, card, card_installments_three, card_installments_six, card_installments_twelve, cashapp, claritypay, coinbase, crypto, custom, customer_balance, demo_pay, efecty, eps, eu_bank_transfer, fpx, gb_bank_transfer, giropay, google_pay, gopay, grabpay, id_bank_transfer, ideal, interac, kakao_pay, klarna, klarna_pay_now, konbini, kr_card, kr_market, kriya, kueski, link, mb_way, m_pesa, mercado_pago, mobilepay, mondu, multibanco, naver_pay, nequi, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nz_bank_account, oxxo, p24, pago_efectivo, pse, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, platform_balance, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sencillito, sepa_debit, sequra, servipag, sezzle, shop_pay, shopeepay, sofort, south_korea_market, spei, splitit, sunbit, swish, tamara, twint, upi, us_bank_account, us_bank_transfer, venmo, vipps, webpay, wechat_pay, yape, zip, coinflow, unknownThe number of failed payment attempts for the payment.Example:
42The plan attached to this payment.
The product this payment was made for
The promo code used for this payment.
True only for payments that are
paid, have not been fully refunded, and were
processed by a payment processor that allows refunds.The payment refund amount(if applicable).Example:
6.9When the payment was refunded (if applicable).Example:
2023-12-01T05:00:00.401ZThe resolution center cases opened by the customer on this payment. Null if the actor in context does not have the payment:resolution_center_case:read permission.
True when the payment status is
open and its membership is in one of the
retry-eligible states (active, trialing, completed, or past_due);
otherwise false. Used to decide if Whop can attempt the charge again.The total amount charged to the customer for this payment, including taxes and after any discounts. In the currency specified by the currency field.Example:
6.9The three-letter ISO currency code for this payment (e.g., ‘usd’, ‘eur’).Available options:
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xauDeprecated. Always returns null.Example:
6.9The current lifecycle state of this payment (e.g., ‘draft’, ‘open’, ‘paid’, ‘void’).Available options:
draft, open, paid, pending, uncollectible, unresolved, voidThe friendly status of the payment.Available options:
succeeded, pending, failed, past_due, canceled, price_too_low, uncollectible, refunded, auto_refunded, partially_refunded, dispute_warning, dispute_needs_response, dispute_warning_needs_response, resolution_needs_response, dispute_under_review, dispute_warning_under_review, resolution_under_review, dispute_won, dispute_warning_closed, resolution_won, dispute_lost, dispute_closed, resolution_lost, drafted, incomplete, unresolved, open_dispute, open_resolutionThe subtotal to show to the creator (excluding buyer fees).Example:
6.9The calculated amount of the sales/VAT tax (if applicable).Example:
6.9The type of tax inclusivity applied to the payment, for determining whether the tax is included in the final price, or paid on top.Available options:
exclusive, inclusive, unspecified, unable_to_collectThe amount of tax that has been refunded (if applicable).Example:
6.9The total to show to the creator (excluding buyer fees).Example:
6.9The datetime the payment was last updated.Example:
2023-12-01T05:00:00.401ZThe total in USD to show to the creator (excluding buyer fees).Example:
6.9The user that made this payment.
True when the payment is tied to a membership in
past_due, the payment
status is open, and the processor allows voiding payments; otherwise false.