Intempt Docs

Stripe event taxonomy

Every attribute on every Stripe event collection, with its type, an example value and what it means.

Overview

Synced from a connected Stripe account.

One section per event collection, one row per attribute. Types are the wire types the platform stores, and examples come from the schema itself. An attribute marked (hidden) arrives on the event but is not offered in the console attribute pickers. A very long example value is shortened with an ellipsis.

stripe_cash_balance

AttributeTypeExampleDescription
settings.reconciliationModeStringautomaticHow incoming bank transfers are reconciled against open invoices: 'automatic' or 'manual'.
settings.usingMerchantDefaultBooleantrueTrue when this customer inherits the merchant-level reconciliation setting.
attribute.user.customerIdStringcus_NffrFeUfNV2HibCustomer that owns this cash balance.
attribute.user.cashBalanceString[{"currency": "USD", "amount": 5000}]Per-currency balances available to this customer in the smallest currency unit.

stripe_charges

AttributeTypeExampleDescription
chargeIdStringch_3NxxxxUnique Stripe charge identifier.
paymentIntentIdStringpi_3NxxxxLinked PaymentIntent. Use as the join key to dedupe revenue against payment_intent.succeeded.
invoiceIdStringin_1NxxxxLinked invoice if this charge paid a recurring invoice.
disputeIdStringdp_1NxxxxLinked dispute record if this charge has been disputed.
statusStringsucceededCharge status: 'succeeded', 'pending', or 'failed'.
amountInteger5000Total charge amount in the smallest currency unit (e.g. cents).
amountCapturedInteger5000Amount actually captured from the authorized amount.
amountRefundedInteger1000Total refunded so far (sum of all refunds against this charge).
currencyStringUSDThree-letter ISO currency code.
paidBooleantrueTrue when the charge succeeded or was authorized for a later capture.
capturedBooleantrueTrue when the charge has been captured.
refundedBooleanfalseTrue when the full charge has been refunded.
disputedBooleanfalseTrue when a dispute has been opened on this charge.
createdString2024-07-05T22:10:00ZTime the charge was created.
descriptionStringMonthly subscriptionFree-text description of the charge. Visible to the customer on receipts.
statementDescriptorStringACME * SUBSCRIPTIONText appearing on the customer's bank/card statement.
receiptUrlStringhttps://pay.stripe.com/receipts/...Hosted Stripe URL for the receipt. Use in email templates.
receiptNumberString1234-5678Stripe-generated human-readable receipt number.
failureCodeStringcard_declinedMachine-readable failure code (e.g. card_declined, expired_card). Used for recovery journey personalization.
failureMessageStringYour card was declined.Human-readable failure message.
paymentMethodStringpm_1NxxxxID of the Payment Method used for this charge.
paymentMethodDetails.typeStringcardThe type of payment method used (e.g. card, sepa_debit, us_bank_account).
paymentMethodDetails.cardBrandStringvisaCard brand: 'visa', 'mastercard', 'amex', 'discover', etc.
paymentMethodDetails.cardLast4String4242Last four digits of the card.
paymentMethodDetails.cardCountryStringUSTwo-letter ISO country code where the card was issued.
paymentMethodDetails.cardFundingStringcreditCard funding type: 'credit', 'debit', 'prepaid', or 'unknown'.
paymentMethodDetails.cardExpMonthInteger12Two-digit card expiration month (1-12).
paymentMethodDetails.cardExpYearInteger2027Four-digit card expiration year.
paymentMethodDetails.cardNetworkStringvisaCard network used for processing (visa, mastercard, etc.).
paymentMethodDetails.cardWalletStringapple_payWallet type if the card was tokenized through one (apple_pay, google_pay, etc.).
outcome.networkStatusStringapproved_by_networkCard network's response status: 'approved_by_network', 'declined_by_network', etc.
outcome.reasonStringelevated_risk_levelReason code returned by Stripe Radar.
outcome.riskLevelStringnormalStripe Radar risk classification: 'normal', 'elevated', 'highest', 'not_assessed', or 'unknown'.
outcome.riskScoreInteger12Numeric Stripe Radar risk score (0-100). Higher means riskier.
outcome.sellerMessageStringPayment complete.Human-readable explanation of the outcome for the seller.
outcome.typeStringauthorizedOutcome type: 'authorized', 'manual_review', 'issuer_declined', 'blocked', or 'invalid'.
outcome.ruleStringblock_if_risk_level_above_75Stripe Radar rule that triggered this outcome (if any).
fraudDetails.stripeReportStringfraudulentStripe's classification of this charge as fraudulent: 'fraudulent' or empty.
fraudDetails.userReportStringsafeMerchant's classification of this charge: 'fraudulent', 'safe', or empty.
metadataString{"order_id": "ord_123"}Merchant-defined key-value pairs on the charge.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer this charge belongs to.
attribute.user.receiptEmailStringbuyer@example.comEmail address the receipt was sent to (may differ from customer email).
attribute.user.billingNameStringJane DoeName on the billing details captured at charge time.
attribute.user.billingEmailStringjane.doe@example.comEmail on the billing details captured at charge time.
attribute.user.billingPhoneString+15555550123Phone on the billing details captured at charge time.
attribute.user.billingAddressLine1String123 Apple St.Line 1 of the billing address at charge time.
attribute.user.billingAddressLine2StringSuite 200Line 2 of the billing address at charge time.
attribute.user.billingAddressCityStringNew YorkBilling address city.
attribute.user.billingAddressStateStringNYBilling address state.
attribute.user.billingAddressPostalCodeString10001Billing address postal code.
attribute.user.billingAddressCountryStringUSBilling address two-letter country code.

stripe_checkout_sessions

AttributeTypeExampleDescription
checkoutSessionIdStringcs_test_a1xxxxUnique Stripe Checkout Session identifier.
paymentIntentIdStringpi_3NxxxxPaymentIntent created by this checkout session.
subscriptionIdStringsub_1NxxxxSubscription created by this checkout session (mode = subscription).
invoiceIdStringin_1NxxxxInvoice created by this checkout session.
paymentLinkIdStringplink_1NxxxxStripe Payment Link this checkout session was opened from (if any).
recoveredFromIdStringcs_test_b2yyyyIf this session was created to recover an expired session, the ID of the original session.
clientReferenceIdStringintempt_user_42Merchant-supplied attribution ID. Commonly the Intempt user ID or session ID.
modeStringsubscriptionCheckout mode: 'payment', 'setup', or 'subscription'.
statusStringcompleteSession state: 'open', 'complete', or 'expired'.
paymentStatusStringpaid'paid', 'unpaid', or 'no_payment_required'. Async methods can be complete-but-unpaid.
currencyStringUSDThree-letter ISO currency code.
amountTotalInteger5000Total amount in the smallest currency unit, including tax and shipping.
amountSubtotalInteger4500Subtotal amount before tax, discounts, and shipping.
urlStringhttps://checkout.stripe.com/c/pay/cs_test_a1xxxxHosted Stripe Checkout URL.
successUrlStringhttps://example.com/success?session_id={CHECKOUT_SESSION_ID}URL the customer is redirected to after successful payment.
cancelUrlStringhttps://example.com/cancelURL the customer is redirected to if they cancel checkout.
createdString2024-07-05T22:10:00ZTime the session was created.
expiresAtString2024-07-06T22:10:00ZTime after which an unpaid session expires (for abandoned-checkout journeys).
paymentMethodTypesString["card", "klarna"]Payment method types offered in this checkout session.
paymentMethodCollectionStringalwaysHow payment methods are collected: 'always' or 'if_required'.
totalDetails.amountDiscountInteger500Total discount applied across the session.
totalDetails.amountShippingInteger1000Total shipping amount.
totalDetails.amountTaxInteger400Total tax amount.
shippingCost.amountTotalInteger1000Total shipping cost in the smallest currency unit.
shippingCost.amountSubtotalInteger900Shipping cost before tax.
shippingCost.amountTaxInteger100Tax portion of the shipping cost.
consent.promotionsStringopt_inCustomer's marketing consent: 'opt_in' or 'opt_out'. Important for journey eligibility.
consent.termsOfServiceStringacceptedCustomer's acceptance of terms of service: 'accepted' or null.
metadataString{"utm_source": "google", "utm_campaign": "spring_sale"}Merchant-defined key-value pairs. Common location for UTM and campaign data.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer for this session. May be null for guest checkouts (fall back to customerEmail).
attribute.user.customerEmailStringguest@example.comEmail captured at checkout (used for guest checkouts).
attribute.user.customerNameStringJane DoeName captured at checkout.
attribute.user.customerPhoneString+15555550123Phone number captured at checkout.
attribute.user.customerBusinessNameStringAcme CorpBusiness name captured at checkout.
attribute.user.customerTaxExemptStringnoneTax exemption captured at checkout: 'none', 'exempt', or 'reverse'.
attribute.user.customerAddressLine1String123 Apple St.Billing address line 1 captured at checkout.
attribute.user.customerAddressLine2StringSuite 200Billing address line 2 captured at checkout.
attribute.user.customerAddressCityStringNew YorkBilling city captured at checkout.
attribute.user.customerAddressStateStringNYBilling state captured at checkout.
attribute.user.customerAddressPostalCodeString10001Billing postal code captured at checkout.
attribute.user.customerAddressCountryStringUSBilling country captured at checkout.
attribute.user.localeStringenCustomer's preferred language captured at checkout.
attribute.user.shippingNameStringJane DoeShipping recipient name captured at checkout.
attribute.user.shippingPhoneString+15555550123Shipping phone captured at checkout.
attribute.user.shippingAddressLine1String456 Banana Ave.Shipping line 1 captured at checkout.
attribute.user.shippingAddressLine2StringApt 3BShipping line 2 captured at checkout.
attribute.user.shippingAddressCityStringBrooklynShipping city captured at checkout.
attribute.user.shippingAddressStateStringNYShipping state captured at checkout.
attribute.user.shippingAddressPostalCodeString11201Shipping postal code captured at checkout.
attribute.user.shippingAddressCountryStringUSShipping country captured at checkout.

stripe_customer_cash_balance_transactions

AttributeTypeExampleDescription
transactionIdStringccsbtxn_1NxxxxUnique cash balance transaction identifier.
appliedToPaymentIdStringpi_3NxxxxPayment this transaction was applied to (when the type is 'applied_to_payment').
appliedToInvoiceIdStringin_1NxxxxInvoice this transaction was applied to.
refundedFromPaymentIdStringpi_3NxxxxPayment this transaction was refunded from.
typeStringfundedTransaction type: 'funded', 'applied_to_payment', 'refunded_from_payment', 'unapplied_from_payment', 'adjusted_for_overdraft', etc.
netAmountInteger5000Net amount of this transaction in the smallest currency unit (positive deposit, negative outflow).
endingBalanceInteger5000Cash balance after this transaction was applied.
currencyStringUSDThree-letter ISO currency code.
createdString2024-07-05T22:10:00ZTime the transaction posted to the cash balance.
funded.referenceStringINV-1024Free-text reference the customer included with the bank transfer.
funded.fundingTypeStringbank_transferHow the funds were sent: 'bank_transfer', 'wire', 'ach_credit', 'sepa_credit', or 'multibanco'.
funded.bankNameStringChaseBank that originated the transfer.
funded.bankCountryStringUSTwo-letter ISO country code of the originating bank.
funded.last4String6789Last 4 digits of the originating bank account.
funded.senderNameStringAcme CorpName of the sender on the bank transfer.
attribute.user.customerIdStringcus_NffrFeUfNV2HibCustomer this cash balance transaction belongs to.

stripe_customer_tax_ids

AttributeTypeExampleDescription
taxIdIdStringtxi_1NxxxxStripe Tax ID object identifier (e.g. txi_xxx). Used to dedupe and address an individual tax record on update/delete.
createdString2024-07-05T22:10:00ZTime at which the tax ID record was added to the customer.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer this tax ID belongs to.
attribute.user.taxIdStringDE123456789The actual tax identifier value (VAT number, EIN, GST, etc.).
attribute.user.taxIdTypeStringeu_vatTax identifier type (e.g. eu_vat, us_ein, gb_vat). See Stripe Tax ID types.
attribute.user.taxIdCountryStringDETwo-letter ISO country code the tax ID is registered in.
attribute.user.taxIdVerificationStatusStringverifiedStripe verification status: 'pending', 'verified', 'unverified', or 'unavailable'.
attribute.user.taxIdVerifiedNameStringAcme GmbHLegal name returned by the tax authority's verification.
attribute.user.taxIdVerifiedAddressStringHauptstrasse 1, BerlinAddress returned by the tax authority's verification.

stripe_customers

AttributeTypeExampleDescription
attribute.user.customerIdStringcus_NffrFeUfNV2HibUnique Stripe customer identifier (e.g. cus_Nxxxx). Primary join key across Stripe objects.
attribute.user.emailStringjane.doe@example.comThe customer's email address. Primary contact for email journeys.
attribute.user.nameStringJane DoeThe customer's full name or business name. Used for personalization in journeys.
attribute.user.phoneString+15555550123The customer's phone number. Used for SMS journeys.
attribute.user.descriptionStringAcme Corp — enterprise planFree-text note. Useful for B2B account identification.
attribute.user.createdString2024-07-05T22:10:00ZTime at which the customer was created. Used for cohort analysis and tenure segmentation.
attribute.user.currencyStringUSDThree-letter ISO code for the currency the customer is billed in.
attribute.user.balanceInteger-500Customer's account credit balance in the smallest currency unit (e.g. cents). Can influence churn-risk scoring.
attribute.user.delinquentBooleanfalseTrue when the customer has past-due invoices. Strong churn signal.
attribute.user.taxExemptStringnoneTax exemption status: 'none', 'exempt', or 'reverse'. Useful for B2B segmentation.
attribute.user.preferredLocalesString["en-US", "es-MX"]Customer's preferred languages, ordered by preference. Used for localized email/SMS content.
attribute.user.defaultSourceStringcard_1NxxxxReference to the customer's default payment source (legacy).
attribute.user.defaultPaymentMethodStringpm_1NxxxxReference to the customer's default Payment Method.
attribute.user.livemodeBooleantrueTrue when the customer record is in Stripe live mode (vs test mode).
attribute.user.deletedBooleanfalseTrue when the customer has been deleted in Stripe. Used for GDPR suppression.
attribute.user.addressLine1String123 Apple St.Billing address line 1 (street, PO Box, or company name).
attribute.user.addressLine2StringSuite 200Billing address line 2 (apartment, suite, unit, or building).
attribute.user.cityStringNew YorkBilling address city, district, suburb, town, or village.
attribute.user.stateStringNYBilling address state, county, province, or region.
attribute.user.postalCodeString10001Billing address ZIP or postal code.
attribute.user.countryStringUSBilling address two-letter country code (ISO 3166-1 alpha-2).
attribute.user.shipping.nameStringJane DoeName on the shipping address.
attribute.user.shipping.phoneString+15555550123Phone number on the shipping address.
attribute.user.shipping.address.line1String456 Banana Ave.Shipping address line 1.
attribute.user.shipping.address.line2StringApt 3BShipping address line 2.
attribute.user.shipping.address.cityStringBrooklynShipping address city.
attribute.user.shipping.address.stateStringNYShipping address state.
attribute.user.shipping.address.postalCodeString11201Shipping address postal code.
attribute.user.shipping.address.countryStringUSShipping address two-letter country code.
attribute.user.metadataString{"utm_source": "google", "plan_tier": "enterprise"}Merchant-defined key-value pairs on the customer (utm_source, campaign_id, intempt_user_id, etc.).

stripe_discounts

AttributeTypeExampleDescription
discountIdStringdi_1NxxxxUnique Stripe discount identifier.
subscriptionIdStringsub_1NxxxxSubscription this discount is applied to (if any).
invoiceIdStringin_1NxxxxInvoice this discount is applied to (if any).
promotionCodeIdStringpromo_1NxxxxPromotion code that was redeemed (if any).
startString2024-07-05T22:10:00ZTime the discount became active.
endString2024-10-05T22:10:00ZTime the discount expires (null if forever).
coupon.couponIdStringWELCOME20Identifier of the coupon backing this discount.
coupon.nameStringWelcome 20% offHuman-readable coupon name.
coupon.amountOffInteger500Fixed-amount discount in the smallest currency unit.
coupon.percentOffDecimal20.0Percentage discount.
coupon.currencyStringUSDCurrency for fixed-amount discounts.
coupon.durationStringrepeatingHow long the coupon applies: 'once', 'forever', or 'repeating'.
coupon.durationInMonthsInteger3For 'repeating' coupons, the number of months the discount lasts.
coupon.maxRedemptionsInteger1000Maximum number of times the coupon can be redeemed.
coupon.timesRedeemedInteger42Number of times the coupon has been redeemed so far.
coupon.redeemByString2024-12-31T23:59:59ZLatest time the coupon can be redeemed.
coupon.validBooleantrueTrue when the coupon can still be applied (within window and under max redemptions).
coupon.createdString2024-01-01T00:00:00ZTime the coupon was created.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer this discount applies to.

stripe_disputes

AttributeTypeExampleDescription
disputeIdStringdp_1NxxxxUnique Stripe dispute identifier.
chargeIdStringch_3NxxxxCharge being disputed.
paymentIntentIdStringpi_3NxxxxPaymentIntent associated with the disputed charge.
amountInteger5000Disputed amount in the smallest currency unit.
currencyStringUSDThree-letter ISO currency code.
statusStringneeds_responseDispute status: 'warning_needs_response', 'warning_under_review', 'warning_closed', 'needs_response', 'under_review', 'won', or 'lost'.
reasonStringfraudulentReason for the dispute (fraudulent, product_not_received, duplicate, etc.).
isChargeRefundableBooleanfalseTrue if the charge can still be refunded.
createdString2024-07-10T12:00:00ZTime the dispute was opened.
evidenceDueByString2024-07-25T23:59:59ZDeadline for submitting evidence to contest the dispute.
networkReasonCodeString10.4Card network's reason code for the dispute.
metadataString{"support_ticket": "sup_456"}Merchant-defined key-value pairs on the dispute.

stripe_early_fraud_warnings

AttributeTypeExampleDescription
earlyFraudWarningIdStringissfr_1NxxxxUnique Stripe Radar Early Fraud Warning identifier.
chargeIdStringch_3NxxxxCharge that received the fraud warning.
paymentIntentIdStringpi_3NxxxxPaymentIntent for the flagged charge.
fraudTypeStringmade_with_stolen_cardType of fraud the card network reported (made_with_stolen_card, misc, etc.).
actionableBooleantrueTrue when the warning is actionable (you can refund to avoid a chargeback).
createdString2024-07-10T12:00:00ZTime the warning was issued.

stripe_invoices

AttributeTypeExampleDescription
invoiceIdStringin_1NxxxxUnique Stripe invoice identifier.
subscriptionIdStringsub_1NxxxxSubscription this invoice belongs to (null for one-off invoices).
paymentIntentIdStringpi_3NxxxxPaymentIntent created to pay this invoice.
chargeIdStringch_3NxxxxCharge that paid this invoice (legacy / direct-charge flows).
defaultPaymentMethodIdStringpm_1NxxxxPayment method to be used for this invoice.
defaultSourceIdStringcard_1NxxxxLegacy source to be used for this invoice.
numberStringINV-1024Human-readable invoice number for customer-facing comms.
receiptNumberString1234-5678Stripe-generated receipt number once paid.
statusStringpaidInvoice status: 'draft', 'open', 'paid', 'uncollectible', or 'void'. Drives the dunning state machine.
billingReasonStringsubscription_cycleWhy the invoice was created: 'subscription_cycle', 'subscription_create', 'subscription_update', 'manual', 'upcoming', etc.
collectionMethodStringcharge_automatically'charge_automatically' or 'send_invoice'.
currencyStringUSDThree-letter ISO currency code.
totalInteger5500Final invoice total in the smallest currency unit, including tax and shipping.
subtotalInteger5000Subtotal before tax, discounts, and shipping.
taxInteger500Total tax amount.
amountDueInteger0Amount the customer still owes.
amountPaidInteger5500Amount the customer has paid so far.
amountRemainingInteger0Amount remaining to be paid.
amountShippingInteger1000Total shipping amount on the invoice.
amountOverpaidInteger0Amount paid in excess of the amount due.
paidBooleantrueTrue when the invoice is fully paid.
paidOutOfBandBooleanfalseTrue when the invoice was marked paid externally (not via Stripe).
attemptedBooleantrueTrue when Stripe has attempted to collect on this invoice.
attemptCountInteger1Number of payment attempts. Drives recovery journey timing.
nextPaymentAttemptString2024-07-08T22:10:00ZScheduled time of the next automatic retry.
createdString2024-07-05T22:10:00ZTime the invoice was created.
finalizedAtString2024-07-05T22:11:00ZTime the invoice was finalized.
dueDateString2024-07-15T22:10:00ZWhen the invoice is due to be paid.
effectiveAtString2024-07-05T22:10:00ZEffective date for the invoice.
periodStartString2024-07-05T22:10:00ZStart of the service period this invoice covers. Essential for revenue recognition.
periodEndString2024-08-05T22:10:00ZEnd of the service period this invoice covers.
hostedInvoiceUrlStringhttps://invoice.stripe.com/i/acct_xxx/test_xxxStripe-hosted page where the customer can view and pay the invoice. Use in email/SMS templates.
invoicePdfStringhttps://pay.stripe.com/invoice/.../pdfURL to a PDF version of the invoice.
discount.discountIdStringdi_1NxxxxActive discount on this invoice.
discount.couponIdStringWELCOME20Coupon backing the active discount.
discount.couponNameStringWelcome 20% offHuman-readable coupon name.
discount.amountOffInteger500Fixed-amount discount.
discount.percentOffDecimal20.0Percentage discount.
discount.durationStringonce'once', 'forever', or 'repeating'.
discount.currencyStringUSDCurrency for fixed-amount discounts.
lastFinalizationError.codeStringinvoice_no_payment_method_typesStripe error code from invoice finalization failure.
lastFinalizationError.messageStringNo payment method types are configured.Human-readable finalization error message.
lastFinalizationError.typeStringinvalid_request_errorError type returned by Stripe (e.g. invalid_request_error).
lastPaymentError.codeStringcard_declinedStripe error code from the most recent payment attempt failure.
lastPaymentError.declineCodeStringinsufficient_fundsCard-network decline code (e.g. insufficient_funds).
lastPaymentError.messageStringYour card was declined.Human-readable failure message. Use for dunning journey personalization.
lastPaymentError.paymentMethodTypeStringcardType of payment method that failed.
lastPaymentError.cardBrandStringvisaCard brand that was declined (visa, mastercard, etc.).
lastPaymentError.cardLast4String4242Last 4 digits of the declined card.
metadataString{"order_id": "ord_123"}Merchant-defined key-value pairs on the invoice.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer billed on this invoice.
attribute.user.customerEmailStringjane.doe@example.comCustomer email captured at invoice time. Preserved for historical accuracy.
attribute.user.customerNameStringJane DoeCustomer name at invoice time.
attribute.user.customerPhoneString+15555550123Customer phone at invoice time.
attribute.user.customerAddressLine1String123 Apple St.Customer address line 1 at invoice time.
attribute.user.customerAddressLine2StringSuite 200Customer address line 2 at invoice time.
attribute.user.customerAddressCityStringNew YorkCustomer city at invoice time.
attribute.user.customerAddressStateStringNYCustomer state at invoice time.
attribute.user.customerAddressPostalCodeString10001Customer postal code at invoice time.
attribute.user.customerAddressCountryStringUSCustomer country at invoice time.

stripe_payment_intents

AttributeTypeExampleDescription
paymentIntentIdStringpi_3NxxxxUnique Stripe PaymentIntent identifier.
invoiceIdStringin_1NxxxxLinked invoice if this PaymentIntent was created for an invoice.
latestChargeIdStringch_3NxxxxCharge that represents the completed payment for this PaymentIntent. Use for revenue dedup against charges.
paymentMethodIdStringpm_1NxxxxPayment Method used for this PaymentIntent.
statusStringsucceededPaymentIntent status: 'requires_payment_method', 'requires_confirmation', 'requires_action', 'processing', 'requires_capture', 'canceled', or 'succeeded'.
amountInteger5000Authorized amount in the smallest currency unit.
amountReceivedInteger5000Amount actually received after capture.
amountCapturableInteger0Amount remaining that can still be captured (for two-step authorize/capture).
currencyStringUSDThree-letter ISO currency code.
createdString2024-07-05T22:10:00ZTime the PaymentIntent was created.
canceledAtString2024-07-05T22:15:00ZTime the PaymentIntent was canceled.
cancellationReasonStringrequested_by_customerReason for cancellation: 'duplicate', 'fraudulent', 'requested_by_customer', 'abandoned', 'failed_invoice', 'void_invoice', or 'automatic'.
descriptionStringOrder #1234Free-text description of the PaymentIntent.
statementDescriptorStringACME * ORDERText appearing on the customer's bank/card statement.
statementDescriptorSuffixStringORDER1234Suffix appended to the merchant's default statement descriptor.
setupFutureUsageStringoff_sessionIndicates whether the payment method can be saved for future charges: 'on_session' or 'off_session'.
paymentMethodTypesString["card", "sepa_debit"]Payment method types this PaymentIntent accepts.
lastPaymentError.codeStringcard_declinedStripe error code from the most recent failed payment attempt.
lastPaymentError.declineCodeStringinsufficient_fundsCard network decline code from the most recent failed attempt.
lastPaymentError.messageStringYour card was declined.Human-readable error message. Use for recovery journey personalization.
lastPaymentError.paymentMethodTypeStringcardPayment method type that failed.
metadataString{"order_id": "ord_123", "utm_source": "google"}Merchant-defined key-value pairs on the PaymentIntent.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer this PaymentIntent belongs to.
attribute.user.receiptEmailStringbuyer@example.comEmail address the receipt is sent to.
attribute.user.shippingNameStringJane DoeRecipient name on the shipping address.
attribute.user.shippingPhoneString+15555550123Phone number on the shipping address.
attribute.user.shippingCarrierStringUPSShipping carrier name.
attribute.user.shippingTrackingNumberString1Z999AA10123456784Tracking number for the shipment.
attribute.user.shippingAddressLine1String456 Banana Ave.Line 1 of the shipping address.
attribute.user.shippingAddressLine2StringApt 3BLine 2 of the shipping address.
attribute.user.shippingAddressCityStringBrooklynShipping address city.
attribute.user.shippingAddressStateStringNYShipping address state.
attribute.user.shippingAddressPostalCodeString11201Shipping address postal code.
attribute.user.shippingAddressCountryStringUSShipping address two-letter country code.

stripe_payment_methods

AttributeTypeExampleDescription
paymentMethodIdStringpm_1NxxxxUnique Stripe Payment Method identifier.
typeStringcardPayment method type: 'card', 'sepa_debit', 'us_bank_account', 'apple_pay', etc.
createdString2024-07-05T22:10:00ZTime the payment method was attached.
card.brandStringvisaCard brand: 'visa', 'mastercard', 'amex', 'discover', etc.
card.last4String4242Last four digits of the card. Used in 'your Visa ending 4242' templates.
card.expMonthInteger12Two-digit card expiration month (1-12). Used to derive expiring-card journeys.
card.expYearInteger2027Four-digit card expiration year.
card.countryStringUSTwo-letter ISO country code where the card was issued.
card.fundingStringcredit'credit', 'debit', 'prepaid', or 'unknown'.
card.walletStringapple_payWallet type if tokenized through one (apple_pay, google_pay, etc.).
card.networkStringvisaCard network used for processing.
sepaDebit.last4String3000Last 4 digits of the SEPA bank account.
sepaDebit.countryStringDETwo-letter ISO country code of the SEPA bank.
sepaDebit.bankCodeString37040044Bank code of the SEPA debit account.
sepaDebit.branchCodeString0000Branch code of the SEPA debit account.
usBankAccount.last4String6789Last 4 digits of the US bank account.
usBankAccount.bankNameStringChaseBank name for the US bank account.
usBankAccount.accountTypeStringchecking'checking' or 'savings'.
usBankAccount.accountHolderTypeStringindividual'individual' or 'company'.
metadataString{"primary": "true"}Merchant-defined key-value pairs on the payment method.
attribute.user.customerIdStringcus_NffrFeUfNV2HibCustomer this payment method is attached to.
attribute.user.billingNameStringJane DoeName on the payment method's billing details.
attribute.user.billingEmailStringjane.doe@example.comEmail on the payment method's billing details.
attribute.user.billingPhoneString+15555550123Phone on the payment method's billing details.
attribute.user.billingAddressLine1String123 Apple St.Line 1 of the billing address.
attribute.user.billingAddressLine2StringSuite 200Line 2 of the billing address.
attribute.user.billingAddressCityStringNew YorkBilling city.
attribute.user.billingAddressStateStringNYBilling state.
attribute.user.billingAddressPostalCodeString10001Billing postal code.
attribute.user.billingAddressCountryStringUSBilling two-letter country code.

stripe_products

AttributeTypeExampleDescription
productIdStringprod_NxxxxUnique Stripe product identifier.
defaultPriceIdStringprice_1NxxxxConvenience pointer to the canonical price for this product.
nameStringPro PlanHuman-readable product name.
descriptionStringUnlimited seats with priority support.Marketing copy for the product. Useful in journey templates.
activeBooleantrueSoft-delete flag. Filter inactive products from catalog views.
typeStringservice'service' or 'good'. Distinguishes physical vs digital products.
taxCodeStringtxcd_10000000Stripe Tax classification code.
urlStringhttps://example.com/pro-planMarketing page URL for the product. Useful in journey CTAs.
imagesString["https://files.stripe.com/products/prod_xxx_1.png"]URLs of product images. Use in rich emails and journey templates.
createdString2024-01-01T00:00:00ZTime the product was created.
updatedString2024-07-05T22:10:00ZTime the product was last updated.
metadataString{"category": "saas", "tier": "pro"}Merchant-defined tags (category, tier, SKU, etc.).

stripe_refunds

AttributeTypeExampleDescription
refundIdStringre_3NxxxxUnique Stripe refund identifier.
chargeIdStringch_3NxxxxCharge that was refunded.
paymentIntentIdStringpi_3NxxxxPaymentIntent associated with the refunded charge.
balanceTransactionIdStringtxn_1NxxxxStripe balance transaction representing the refund's impact on your Stripe balance.
amountInteger1000Refund amount in the smallest currency unit. Negative revenue signal.
currencyStringUSDThree-letter ISO currency code.
statusStringsucceededRefund status: 'pending', 'requires_action', 'succeeded', 'failed', or 'canceled'.
reasonStringrequested_by_customerReason for the refund: 'duplicate', 'fraudulent', or 'requested_by_customer'.
failureReasonStringexpired_or_canceled_cardIf the refund failed, the reason it failed (lost_or_stolen_card, expired_or_canceled_card, etc.).
receiptNumberString1234-5678Stripe-generated receipt number for the refund.
descriptionStringCustomer requested refund — order #1234Free-text description of the refund.
createdString2024-07-10T12:00:00ZTime the refund was created.
metadataString{"support_ticket": "sup_456"}Merchant-defined key-value pairs on the refund.

stripe_reviews

AttributeTypeExampleDescription
reviewIdStringprv_1NxxxxUnique Stripe Radar review identifier.
chargeIdStringch_3NxxxxCharge under review.
paymentIntentIdStringpi_3NxxxxPaymentIntent for the reviewed charge.
reasonStringruleWhy the review was opened (rule, manual, etc.).
openedReasonStringruleReason the review was originally opened.
closedReasonStringapprovedHow the review was closed: 'approved', 'refunded', 'refunded_as_fraud', 'disputed', or 'redacted'.
openBooleantrueTrue while the review is still open.
createdString2024-07-10T12:00:00ZTime the review was opened.

stripe_subscription_schedule

AttributeTypeExampleDescription
scheduleIdStringsub_sched_1NxxxxUnique Stripe Subscription Schedule identifier.
subscriptionIdStringsub_1NxxxxSubscription currently driven by this schedule.
releasedSubscriptionIdStringsub_1NxxxxSubscription that was detached when the schedule was released.
statusStringactiveSchedule status: 'not_started', 'active', 'completed', 'released', or 'canceled'.
endBehaviorStringreleaseWhat happens when the schedule ends: 'release', 'cancel', or 'none'.
createdString2024-07-05T22:10:00ZTime the schedule was created.
canceledAtString2024-07-10T12:00:00ZTime the schedule was canceled.
completedAtString2025-07-05T22:10:00ZTime all phases finished executing.
releasedAtString2024-12-01T00:00:00ZTime the schedule was released (subscription detached).
expiresAtString2025-07-05T22:10:00ZTime the schedule will expire.
currentPhase.startDateString2024-07-05T22:10:00ZStart of the currently active phase.
currentPhase.endDateString2024-10-05T22:10:00ZEnd of the currently active phase.
defaultSettings.collectionMethodStringcharge_automaticallyDefault 'charge_automatically' or 'send_invoice' for the schedule.
defaultSettings.billingCycleAnchorStringautomaticWhen the billing cycle anchors: 'automatic', 'phase_start', etc.
defaultSettings.defaultPaymentMethodIdStringpm_1NxxxxDefault payment method for invoices created from this schedule.
defaultSettings.onBehalfOfStringacct_1NxxxxConnected account on behalf of which charges will be made.
defaultSettings.descriptionStringAnnual contract — Q3 2024Default description for invoices.
metadataString{"contract_id": "ctr_456"}Merchant-defined key-value pairs on the schedule.
attribute.user.customerIdStringcus_NffrFeUfNV2HibCustomer this schedule belongs to.

stripe_subscriptions

AttributeTypeExampleDescription
subscriptionIdStringsub_1NxxxxUnique Stripe subscription identifier.
latestInvoiceIdStringin_1NxxxxMost recent invoice for this subscription.
scheduleIdStringsub_sched_1NxxxxStripe Subscription Schedule driving this subscription (if any).
defaultPaymentMethodIdStringpm_1NxxxxPayment method used for this subscription's invoices (overrides customer-level default).
statusStringactiveSubscription status: 'active', 'trialing', 'past_due', 'canceled', 'unpaid', 'incomplete', 'incomplete_expired', or 'paused'.
collectionMethodStringcharge_automatically'charge_automatically' or 'send_invoice'. Distinguishes self-serve from sales-led billing.
currencyStringUSDThree-letter ISO currency code.
amountInteger5000Total amount charged per billing period in the smallest currency unit. Sum of items[].amount.
mrrInteger5000Monthly recurring revenue in the smallest currency unit, normalized regardless of billing interval.
arrInteger60000Annual recurring revenue in the smallest currency unit (mrr * 12).
createdString2024-07-05T22:10:00ZTime the subscription was created.
currentPeriodStartString2024-07-05T22:10:00ZStart of the current billing period.
currentPeriodEndString2024-08-05T22:10:00ZEnd of the current billing period. Subscription renews immediately after this.
trialStartString2024-07-05T22:10:00ZStart of the trial period.
trialEndString2024-07-19T22:10:00ZEnd of the trial period. Drives 'Trial Ending Soon' logic.
cancelAtString2024-08-05T22:10:00ZScheduled cancellation time (set when cancelling at period end).
canceledAtString2024-08-05T22:10:00ZTime the subscription was actually canceled.
endedAtString2024-08-05T22:10:00ZTime the subscription fully ended (after any cancel-at-period-end window).
cancelAtPeriodEndBooleanfalseTrue if the subscription will cancel at the end of the current billing period. Pre-cancellation churn signal.
cancellationDetails.reasonStringcancellation_requestedCancellation classification: 'cancellation_requested', 'payment_disputed', or 'payment_failed'.
cancellationDetails.feedbackStringtoo_expensiveCustomer's structured feedback (too_expensive, missing_features, switched_service, etc.).
cancellationDetails.commentStringFound a cheaper alternative.Free-text comment provided by the customer when canceling.
previousAttributes.previousStatusStringtrialingStatus before the most recent update. Used to derive trial-to-paid conversions.
previousAttributes.previousQuantityInteger5Quantity before the most recent update. Used to detect seat expansions/contractions.
previousAttributes.previousPriceIdStringprice_1NxxxxPrice ID before the most recent update. Used to derive plan upgrades/downgrades.
previousAttributes.previousProductIdStringprod_NxxxxProduct ID before the most recent update.
previousAttributes.previousUnitAmountInteger1000Per-unit price before the most recent update.
previousAttributes.previousCurrencyStringUSDCurrency before the most recent update.
previousAttributes.previousIntervalStringmonthBilling interval before the most recent update (month, year, etc.).
previousAttributes.previousCancelAtPeriodEndBooleantrueCancel-at-period-end flag value before the most recent update.
previousAttributes.previousTrialEndString2024-07-19T22:10:00ZTrial end before the most recent update.
discount.discountIdStringdi_1NxxxxActive discount applied to the subscription.
discount.couponIdStringWELCOME20Coupon backing the active discount.
discount.couponNameStringWelcome 20% offHuman-readable coupon name.
discount.amountOffInteger500Fixed amount discount in the smallest currency unit.
discount.percentOffDecimal20.0Percentage discount.
discount.durationStringrepeatingHow long the discount applies: 'once', 'forever', or 'repeating'.
discount.currencyStringUSDCurrency for fixed-amount discounts.
metadataString{"plan_tier": "enterprise"}Merchant-defined key-value pairs on the subscription.
attribute.user.customerIdStringcus_NffrFeUfNV2HibStripe customer this subscription belongs to.
attribute.user.subscriptionStatusStringactiveMirrored subscription status on the user profile for real-time segmentation.
attribute.user.currentPriceIdStringprice_1NxxxxActive price ID on the user profile.
attribute.user.currentProductIdStringprod_NxxxxActive product ID on the user profile.
attribute.user.mrrInteger5000Customer's monthly recurring revenue in the smallest currency unit.
attribute.user.arrInteger60000Customer's annual recurring revenue in the smallest currency unit.

On this page