How much the payment is for after fees Example: 6.9
The application fee charged on this payment. The application fee amount. Example: 6.9
The amount of the application fee that has been captured. Example: 6.9
The amount of the application fee that has been refunded. Example: 6.9
created_at
string<date-time>
required
The datetime the application fee was created. Example: 2023-12-01T05:00:00.401Z
The currency of the application fee. 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, xau
The unique identifier for the application fee. Example: apfee_xxxxxxxxxxxx
Whether this payment was auto refunded or not
The address of the user who made the payment. The country of the address.
The line 1 of the address.
The line 2 of the address.
The name of the customer.
The postal code of the address.
The state of the address.
billing_reason
BillingReasons | null
required
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, subscription
card_brand
CardBrands | null
required
Card 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, aura, unknown
The last four digits of the card used to make this payment. Null if the payment was not made with a card. Example: 4242
checkout_configuration_id
The 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 unique identifier for the company. Example: biz_xxxxxxxxxxxxxx
The slug/route of the company on the Whop site.
The written name of the company.
created_at
string<date-time>
required
The datetime the payment was created. Example: 2023-12-01T05:00:00.401Z
The 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, xau
dispute_alerted_at
string<date-time> | null
required
When an alert came in that this transaction will be disputed Example: 2023-12-01T05:00:00.401Z
disputes
array<object> | null
required
The disputes attached to this payment. Null if the actor in context does not have the payment:dispute:read permission. The disputed amount in the specified currency, formatted as a decimal. Example: 6.9
The three-letter ISO currency code for the disputed amount. 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, xau
Whether the dispute evidence can still be edited and submitted.
The unique identifier for the dispute. Example: dspt_xxxxxxxxxxxxx
needs_response_by
string<date-time> | null
required
The deadline by which dispute evidence must be submitted. Null if no response deadline is set. Example: 2023-12-01T05:00:00.401Z
Additional freeform notes submitted by the company as part of the dispute evidence. Example: Customer used the product for 3 months before disputing.
A human-readable reason for the dispute. Example: Product Not Received
The current status of the dispute lifecycle, such as needs_response, under_review, won, or lost. Available options: warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, lost, closed, other
If the payment failed, the reason for the failure.
financing_installments_count
The number of financing installments for the payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.). Example: 42
The financing transactions attached to this payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.). The amount of the payment transaction. Example: 6.9
created_at
string<date-time>
required
The date and time the payment transaction was created. Example: 2023-12-01T05:00:00.401Z
The unique identifier for the payment transaction. Example: ptx_xxxxxxxxxxxxxx
status
PaymentTransactionStatuses
required
The status of the payment transaction. Available options: succeeded, declined, error, pending, created, expired, won, rejected, lost, prevented, canceled
transaction_type
PaymentTransactionTypes
required
The type of the payment transaction. Available options: purchase, authorize, capture, refund, canceled, verify, chargeback, pre_chargeback, three_d_secure, fraud_screening, authorization, installment
The unique identifier for the payment. Example: pay_xxxxxxxxxxxxxx
last_payment_attempt
string<date-time> | null
required
The time of the last payment attempt. Example: 2023-12-01T05:00:00.401Z
The member attached to this payment. The unique identifier for the company member.
The phone number for the member, if available.
The membership attached to this payment. The unique identifier for the membership. Example: mem_xxxxxxxxxxxxxx
The phone number associated with this membership.
The state of the membership. Available options: trialing, active, past_due, completed, canceled, expired, unresolved, drafted, canceling
The custom metadata stored on this payment. This will be copied over to the
checkout configuration for which this payment was made
next_payment_attempt
string<date-time> | null
required
The time of the next schedule payment retry. Example: 2023-12-01T05:00:00.401Z
paid_at
string<date-time> | null
required
The 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.401Z
The tokenized payment method reference used for this payment. Null if no token was used. The card data associated with the payment method, if its a debit or credit card. brand
CardBrands | null
required
The card network (e.g., visa, mastercard, amex). Null if the brand could not be determined. 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, aura, unknown
The two-digit expiration month of the card (1-12). Null if not available. Example: 42
The two-digit expiration year of the card (e.g., 27 for 2027). Null if not available. Example: 42
The last four digits of the card number. Null if not available. Example: 4242
created_at
string<date-time>
required
The datetime the payment token was created. Example: 2023-12-01T05:00:00.401Z
The unique identifier for the payment token. Example: payt_xxxxxxxxxxxxx
payment_method_type
PaymentMethodTypes
required
The payment method type of the payment method 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, unknown
payment_method_type
PaymentMethodTypes | null
required
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, unknown
The number of failed payment attempts for the payment. Example: 42
The plan attached to this payment. The unique identifier for the plan. Example: plan_xxxxxxxxxxxxx
A personal description or notes section for the business.
Custom key-value pairs stored on the plan. Included in webhook payloads for payment and membership events. Max 50 keys, 100 chars per key, 500 chars per string value.
The product this payment was made for The unique identifier for the product. Example: prod_xxxxxxxxxxxxx
Custom key-value pairs stored on the product and included in payment and
membership webhook payloads. Max 50 keys, 100 characters per key, 500
characters per string value.
URL slug in the product’s public link, e.g. pickaxe-analytics in whop.com/company/pickaxe-analytics. Example: pickaxe-analytics
The display name of the product shown to customers on the product page and in search results. Example: Pickaxe Analytics
The promo code used for this payment. The discount amount. Interpretation depends on promo_type: if ‘percentage’, this is the percentage (e.g., 20 means 20% off); if ‘flat_amount’, this is dollars off (e.g., 10.00 means $10.00 off). Example: 6.9
The monetary currency of the promo code. 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, xau
The specific code used to apply the promo at checkout.
The unique identifier for the promo code. Example: promo_xxxxxxxxxxxx
The number of months the promo is applied for. Example: 42
The type (% or flat amount) of the promo. Available options: percentage, flat_amount
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.9
refunded_at
string<date-time> | null
required
When the payment was refunded (if applicable). Example: 2023-12-01T05:00:00.401Z
The refunds issued against this payment, newest first, including failed and canceled refund attempts. Limited to the 100 most recent. The refunded amount as a decimal in the specified currency, such as 10.43 for $10.43 USD. Example: 6.9
created_at
string<date-time>
required
The datetime the refund was created. Example: 2023-12-01T05:00:00.401Z
The three-letter ISO currency code for the refunded amount. 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, xau
The unique identifier for the refund. Example: rf_xxxxxxxxxxxxxxx
The current processing status of the refund, such as pending, succeeded, or failed. Available options: pending, requires_action, succeeded, failed, canceled
resolutions
array<object> | null
required
The 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. Whether the customer has filed an appeal after the initial resolution
decision.
customer_response_actions
array<ResolutionCenterCaseCustomerResponses>
required
The list of actions currently available to the customer. Available options: respond, appeal, withdraw
due_date
string<date-time> | null
required
The deadline by which the next response is required. Null if no deadline is currently active. As a Unix timestamp. Example: 2023-12-01T05:00:00.401Z
The unique identifier for the resolution. Example: reso_xxxxxxxxxxxxx
issue
ResolutionCenterCaseIssueTypes
required
The category of the dispute. Available options: forgot_to_cancel, item_not_received, significantly_not_as_described, unauthorized_transaction, product_unacceptable
Whether the merchant has filed an appeal after the initial resolution
decision.
merchant_response_actions
array<ResolutionCenterCaseMerchantResponses>
required
The list of actions currently available to the merchant. Available options: accept, deny, request_more_info, appeal, respond
platform_response_actions
array<ResolutionCenterCasePlatformResponses>
required
The list of actions currently available to the Whop platform for moderating this resolution. Available options: request_buyer_info, request_merchant_info, merchant_wins, merchant_refund
status
ResolutionCenterCaseStatuses
required
The current status of the resolution case, indicating which party needs to respond or if the case is closed. Available options: merchant_response_needed, customer_response_needed, merchant_info_needed, customer_info_needed, under_platform_review, customer_won, merchant_won, customer_withdrew
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.
Whop’s in-house fraud risk score for this payment, from 0 (lowest risk) to 100 (highest risk). Null when the payment has not been scored or scoring has not yet completed. Example: 42
A curated set of factors behind the risk score, grouped by category (business
transaction history, buyer, device). Each entry has a key, human-readable
label, category, and value. Null when there is no risk assessment for this
payment.
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.9
The 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, xau
Deprecated. Always returns null. Example: 6.9
The shipping address provided by the customer for physical goods. Null if no shipping address was collected. The country of the address.
The line 1 of the address.
The line 2 of the address.
The name of the customer.
The postal code of the address.
The state of the address.
status
ReceiptStatus | null
required
The current lifecycle state of this payment (e.g., ‘draft’, ‘open’, ‘paid’, ‘void’). Available options: draft, open, paid, pending, uncollectible, unresolved, void
substatus
FriendlyReceiptStatus
required
The 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_resolution
The subtotal to show to the creator (excluding buyer fees). Example: 6.9
The calculated amount of the sales/VAT tax (if applicable). Example: 6.9
tax_behavior
ReceiptTaxBehaviors | null
required
The 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_collect
The amount of tax that has been refunded (if applicable). Example: 6.9
Whether 3D Secure authentication was completed for this payment.
The total to show to the creator (excluding buyer fees). Example: 6.9
updated_at
string<date-time>
required
The datetime the payment was last updated. Example: 2023-12-01T05:00:00.401Z
The total in USD to show to the creator (excluding buyer fees). Example: 6.9
The user that made this payment. The user’s email address. Requires the member:email:read permission to access. Null if not authorized. Example: john.doe@example.com
The unique identifier for the user. Example: user_xxxxxxxxxxxxx
The user’s display name shown on their public profile. Example: John Doe
The user’s unique username shown on their public profile. Example: johndoe42
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.
