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, 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
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
The unique identifier for the payment. Example: pay_xxxxxxxxxxxxxx
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 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
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
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 plan attached to this payment. The unique identifier for the plan. Example: plan_xxxxxxxxxxxxx
Custom key-value pairs stored on the plan. Included in webhook payloads for payment and membership events.
The product this payment was made for The unique identifier for the product. Example: prod_xxxxxxxxxxxxx
Custom key-value pairs stored on the product. Included in webhook payloads for payment and membership events.
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
The total to show to the creator (excluding buyer fees). Example: 6.9
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
