Intempt Docs

Stripe record taxonomy

Every field on every Stripe record, nested ones included, with the type it carries and whether it is required.

Overview

The collections a connected Stripe account provisions, and the fields on each.

One section per record, one row per field. A record nested inside another is flattened into a dotted path, so data.targetText is the targetText field carried on that record's data. These schemas hold names and types only, so there are no example values here. A type in backticks names another record in this same source, which has its own section on this page.

cash_balance

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
data.changeTypeStringNo
data.livemodeBooleanNo
data.settings.reconciliationModeStringNo
data.settings.usingMerchantDefaultBooleanNo
userAttributes.customerIdStringNo
userAttributes.cashBalanceArray of StringNo

charges

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
chargeIdStringNo
paymentIntentIdStringNo
invoiceIdStringNo
disputeIdStringNo
data.changeTypeStringNo
data.chargeIdStringNo
data.paymentIntentIdStringNo
data.invoiceIdStringNo
data.disputeIdStringNo
data.statusStringNo
data.amountDecimalNo
data.amountCapturedDecimalNo
data.amountRefundedDecimalNo
data.currencyStringNo
data.paidBooleanNo
data.capturedBooleanNo
data.refundedBooleanNo
data.disputedBooleanNo
data.createdLong (timestamp-millis)No
data.descriptionStringNo
data.statementDescriptorStringNo
data.receiptUrlStringNo
data.receiptNumberStringNo
data.failureCodeStringNo
data.failureMessageStringNo
data.paymentMethodStringNo
data.paymentMethodDetails.typeStringNo
data.paymentMethodDetails.cardBrandStringNo
data.paymentMethodDetails.cardLast4StringNo
data.paymentMethodDetails.cardCountryStringNo
data.paymentMethodDetails.cardFundingStringNo
data.paymentMethodDetails.cardExpMonthIntegerNo
data.paymentMethodDetails.cardExpYearIntegerNo
data.paymentMethodDetails.cardNetworkStringNo
data.paymentMethodDetails.cardWalletStringNo
data.outcome.networkStatusStringNo
data.outcome.reasonStringNo
data.outcome.riskLevelStringNo
data.outcome.riskScoreIntegerNo
data.outcome.sellerMessageStringNo
data.outcome.typeStringNo
data.outcome.ruleStringNo
data.fraudDetails.stripeReportStringNo
data.fraudDetails.userReportStringNo
data.refundsArray of StringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.receiptEmailStringNo
userAttributes.billingNameStringNo
userAttributes.billingEmailStringNo
userAttributes.billingPhoneStringNo
userAttributes.billingAddressLine1StringNo
userAttributes.billingAddressLine2StringNo
userAttributes.billingAddressCityStringNo
userAttributes.billingAddressStateStringNo
userAttributes.billingAddressPostalCodeStringNo
userAttributes.billingAddressCountryStringNo

checkout_sessions

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
checkoutSessionIdStringNo
paymentIntentIdStringNo
subscriptionIdStringNo
invoiceIdStringNo
paymentLinkIdStringNo
recoveredFromIdStringNo
data.changeTypeStringNo
data.checkoutSessionIdStringNo
data.paymentIntentIdStringNo
data.subscriptionIdStringNo
data.invoiceIdStringNo
data.paymentLinkIdStringNo
data.recoveredFromIdStringNo
data.clientReferenceIdStringNo
data.modeStringNo
data.statusStringNo
data.paymentStatusStringNo
data.currencyStringNo
data.amountTotalDecimalNo
data.amountSubtotalDecimalNo
data.urlStringNo
data.successUrlStringNo
data.cancelUrlStringNo
data.createdLong (timestamp-millis)No
data.expiresAtLong (timestamp-millis)No
data.paymentMethodTypesArray of StringNo
data.paymentMethodCollectionStringNo
data.discountsArray of StringNo
data.totalDetails.amountDiscountDecimalNo
data.totalDetails.amountShippingDecimalNo
data.totalDetails.amountTaxDecimalNo
data.shippingCost.amountSubtotalDecimalNo
data.shippingCost.amountTaxDecimalNo
data.shippingCost.amountTotalDecimalNo
data.consent.promotionsStringNo
data.consent.termsOfServiceStringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.emailStringNo
userAttributes.nameStringNo
userAttributes.phoneStringNo
userAttributes.businessNameStringNo
userAttributes.taxExemptStringNo
userAttributes.addressLine1StringNo
userAttributes.addressLine2StringNo
userAttributes.cityStringNo
userAttributes.stateStringNo
userAttributes.postalCodeStringNo
userAttributes.countryStringNo
userAttributes.localeStringNo
userAttributes.customerTaxIdsArray of StringNo
userAttributes.shippingNameStringNo
userAttributes.shippingPhoneStringNo
userAttributes.shippingAddressLine1StringNo
userAttributes.shippingAddressLine2StringNo
userAttributes.shippingAddressCityStringNo
userAttributes.shippingAddressStateStringNo
userAttributes.shippingAddressPostalCodeStringNo
userAttributes.shippingAddressCountryStringNo

customer_cash_balance_transactions

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
transactionIdStringNo
appliedToPaymentIdStringNo
appliedToInvoiceIdStringNo
refundedFromPaymentIdStringNo
data.changeTypeStringNo
data.transactionIdStringNo
data.typeStringNo
data.netAmountDecimalNo
data.endingBalanceDecimalNo
data.currencyStringNo
data.createdLong (timestamp-millis)No
data.funded.referenceStringNo
data.funded.fundingTypeStringNo
data.funded.bankNameStringNo
data.funded.bankCountryStringNo
data.funded.last4StringNo
data.funded.senderNameStringNo
data.appliedToPaymentIdStringNo
data.appliedToInvoiceIdStringNo
data.refundedFromPaymentIdStringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo

customer_tax_ids

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
taxIdIdStringNo
data.changeTypeStringNo
data.taxIdIdStringNo
data.createdLong (timestamp-millis)No
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.taxIdStringNo
userAttributes.taxIdTypeStringNo
userAttributes.taxIdCountryStringNo
userAttributes.taxIdVerificationStatusStringNo
userAttributes.taxIdVerifiedNameStringNo
userAttributes.taxIdVerifiedAddressStringNo

customers

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
changeTypeStringNo
userAttributes.customerIdStringNo
userAttributes.emailStringNo
userAttributes.nameStringNo
userAttributes.phoneStringNo
userAttributes.descriptionStringNo
userAttributes.createdLong (timestamp-millis)No
userAttributes.currencyStringNo
userAttributes.balanceDecimalNo
userAttributes.delinquentBooleanNo
userAttributes.taxExemptStringNo
userAttributes.preferredLocalesArray of StringNo
userAttributes.defaultSourceStringNo
userAttributes.defaultPaymentMethodStringNo
userAttributes.livemodeBooleanNo
userAttributes.deletedBooleanNo
userAttributes.addressLine1StringNo
userAttributes.addressLine2StringNo
userAttributes.cityStringNo
userAttributes.stateStringNo
userAttributes.postalCodeStringNo
userAttributes.countryStringNo
userAttributes.shipping.nameStringNo
userAttributes.shipping.phoneStringNo
userAttributes.shipping.address.line1StringNo
userAttributes.shipping.address.line2StringNo
userAttributes.shipping.address.cityStringNo
userAttributes.shipping.address.stateStringNo
userAttributes.shipping.address.postalCodeStringNo
userAttributes.shipping.address.countryStringNo
userAttributes.discountStringNo
userAttributes.discountsArray of StringNo
userAttributes.metadataMap of StringNo

discounts

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
discountIdStringNo
subscriptionIdStringNo
invoiceIdStringNo
promotionCodeIdStringNo
data.changeTypeStringNo
data.discountIdStringNo
data.subscriptionIdStringNo
data.invoiceIdStringNo
data.promotionCodeIdStringNo
data.startLong (timestamp-millis)No
data.endLong (timestamp-millis)No
data.coupon.couponIdStringNo
data.coupon.nameStringNo
data.coupon.amountOffDecimalNo
data.coupon.percentOffDecimalNo
data.coupon.currencyStringNo
data.coupon.durationStringNo
data.coupon.durationInMonthsIntegerNo
data.coupon.maxRedemptionsIntegerNo
data.coupon.timesRedeemedIntegerNo
data.coupon.redeemByLong (timestamp-millis)No
data.coupon.validBooleanNo
data.coupon.createdLong (timestamp-millis)No
userAttributes.customerIdStringNo

disputes

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
disputeIdStringNo
chargeIdStringNo
paymentIntentIdStringNo
data.changeTypeStringNo
data.disputeIdStringNo
data.chargeIdStringNo
data.paymentIntentIdStringNo
data.amountDecimalNo
data.currencyStringNo
data.statusStringNo
data.reasonStringNo
data.isChargeRefundableBooleanNo
data.createdLong (timestamp-millis)No
data.evidenceDueByLong (timestamp-millis)No
data.networkReasonCodeStringNo
data.metadataMap of StringNo
data.livemodeBooleanNo

early_fraud_warnings

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
earlyFraudWarningIdStringNo
chargeIdStringNo
paymentIntentIdStringNo
data.changeTypeStringNo
data.earlyFraudWarningIdStringNo
data.chargeIdStringNo
data.paymentIntentIdStringNo
data.fraudTypeStringNo
data.actionableBooleanNo
data.createdLong (timestamp-millis)No
data.livemodeBooleanNo

invoices

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
invoiceIdStringNo
subscriptionIdStringNo
paymentIntentIdStringNo
chargeIdStringNo
defaultPaymentMethodIdStringNo
defaultSourceIdStringNo
data.changeTypeStringNo
data.invoiceIdStringNo
data.subscriptionIdStringNo
data.paymentIntentIdStringNo
data.chargeIdStringNo
data.defaultPaymentMethodIdStringNo
data.defaultSourceIdStringNo
data.numberStringNo
data.receiptNumberStringNo
data.statusStringNo
data.billingReasonStringNo
data.collectionMethodStringNo
data.currencyStringNo
data.totalDecimalNo
data.subtotalDecimalNo
data.taxDecimalNo
data.amountDueDecimalNo
data.amountPaidDecimalNo
data.amountRemainingDecimalNo
data.amountShippingDecimalNo
data.amountOverpaidDecimalNo
data.paidBooleanNo
data.paidOutOfBandBooleanNo
data.attemptedBooleanNo
data.attemptCountIntegerNo
data.nextPaymentAttemptLong (timestamp-millis)No
data.createdLong (timestamp-millis)No
data.finalizedAtLong (timestamp-millis)No
data.dueDateLong (timestamp-millis)No
data.effectiveAtLong (timestamp-millis)No
data.periodStartLong (timestamp-millis)No
data.periodEndLong (timestamp-millis)No
data.hostedInvoiceUrlStringNo
data.invoicePdfStringNo
data.discount.discountIdStringNo
data.discount.couponIdStringNo
data.discount.couponNameStringNo
data.discount.amountOffDecimalNo
data.discount.percentOffDecimalNo
data.discount.durationStringNo
data.discount.currencyStringNo
data.discountsArray of StringNo
data.totalDiscountAmountsArray of StringNo
data.lastFinalizationError.codeStringNo
data.lastFinalizationError.messageStringNo
data.lastFinalizationError.paramStringNo
data.lastFinalizationError.docUrlStringNo
data.lastFinalizationError.typeStringNo
data.lastPaymentError.codeStringNo
data.lastPaymentError.declineCodeStringNo
data.lastPaymentError.messageStringNo
data.lastPaymentError.paymentMethodTypeStringNo
data.lastPaymentError.cardBrandStringNo
data.lastPaymentError.cardLast4StringNo
data.linesArray of StringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.emailStringNo
userAttributes.nameStringNo
userAttributes.phoneStringNo
userAttributes.addressLine1StringNo
userAttributes.addressLine2StringNo
userAttributes.cityStringNo
userAttributes.stateStringNo
userAttributes.postalCodeStringNo
userAttributes.countryStringNo

payment_intents

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
paymentIntentIdStringNo
invoiceIdStringNo
latestChargeIdStringNo
paymentMethodIdStringNo
data.changeTypeStringNo
data.paymentIntentIdStringNo
data.invoiceIdStringNo
data.latestChargeIdStringNo
data.paymentMethodIdStringNo
data.statusStringNo
data.amountDecimalNo
data.amountReceivedDecimalNo
data.amountCapturableDecimalNo
data.currencyStringNo
data.createdLong (timestamp-millis)No
data.canceledAtLong (timestamp-millis)No
data.cancellationReasonStringNo
data.descriptionStringNo
data.statementDescriptorStringNo
data.statementDescriptorSuffixStringNo
data.setupFutureUsageStringNo
data.paymentMethodTypesArray of StringNo
data.lastPaymentError.codeStringNo
data.lastPaymentError.declineCodeStringNo
data.lastPaymentError.messageStringNo
data.lastPaymentError.paramStringNo
data.lastPaymentError.docUrlStringNo
data.lastPaymentError.chargeIdStringNo
data.lastPaymentError.paymentMethodIdStringNo
data.lastPaymentError.paymentMethodTypeStringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.receiptEmailStringNo
userAttributes.shippingNameStringNo
userAttributes.shippingPhoneStringNo
userAttributes.shippingCarrierStringNo
userAttributes.shippingTrackingNumberStringNo
userAttributes.shippingAddressLine1StringNo
userAttributes.shippingAddressLine2StringNo
userAttributes.shippingAddressCityStringNo
userAttributes.shippingAddressStateStringNo
userAttributes.shippingAddressPostalCodeStringNo
userAttributes.shippingAddressCountryStringNo

payment_methods

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
paymentMethodIdStringNo
data.changeTypeStringNo
data.paymentMethodIdStringNo
data.typeStringNo
data.createdLong (timestamp-millis)No
data.card.brandStringNo
data.card.last4StringNo
data.card.expMonthIntegerNo
data.card.expYearIntegerNo
data.card.countryStringNo
data.card.fundingStringNo
data.card.walletStringNo
data.card.networkStringNo
data.sepaDebit.last4StringNo
data.sepaDebit.countryStringNo
data.sepaDebit.bankCodeStringNo
data.sepaDebit.branchCodeStringNo
data.usBankAccount.last4StringNo
data.usBankAccount.bankNameStringNo
data.usBankAccount.accountTypeStringNo
data.usBankAccount.accountHolderTypeStringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.billingNameStringNo
userAttributes.billingEmailStringNo
userAttributes.billingPhoneStringNo
userAttributes.billingAddressLine1StringNo
userAttributes.billingAddressLine2StringNo
userAttributes.billingAddressCityStringNo
userAttributes.billingAddressStateStringNo
userAttributes.billingAddressPostalCodeStringNo
userAttributes.billingAddressCountryStringNo

products

AttributeTypeRequired
productIdStringYes
sourceIdLongNo
timestampLongYes
productAttributes.changeTypeStringNo
productAttributes.productIdStringNo
productAttributes.defaultPriceIdStringNo
productAttributes.nameStringNo
productAttributes.descriptionStringNo
productAttributes.activeBooleanNo
productAttributes.typeStringNo
productAttributes.taxCodeStringNo
productAttributes.urlStringNo
productAttributes.imagesArray of StringNo
productAttributes.createdLong (timestamp-millis)No
productAttributes.updatedLong (timestamp-millis)No
productAttributes.metadataMap of StringNo
productAttributes.livemodeBooleanNo

refunds

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
refundIdStringNo
chargeIdStringNo
paymentIntentIdStringNo
balanceTransactionIdStringNo
data.changeTypeStringNo
data.refundIdStringNo
data.chargeIdStringNo
data.paymentIntentIdStringNo
data.balanceTransactionIdStringNo
data.amountDecimalNo
data.currencyStringNo
data.statusStringNo
data.reasonStringNo
data.failureReasonStringNo
data.receiptNumberStringNo
data.descriptionStringNo
data.createdLong (timestamp-millis)No
data.metadataMap of StringNo
data.livemodeBooleanNo

reviews

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
reviewIdStringNo
chargeIdStringNo
paymentIntentIdStringNo
data.changeTypeStringNo
data.reviewIdStringNo
data.chargeIdStringNo
data.paymentIntentIdStringNo
data.reasonStringNo
data.openedReasonStringNo
data.closedReasonStringNo
data.openBooleanNo
data.createdLong (timestamp-millis)No
data.livemodeBooleanNo

subscription_schedule

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
scheduleIdStringNo
subscriptionIdStringNo
releasedSubscriptionIdStringNo
data.changeTypeStringNo
data.scheduleIdStringNo
data.subscriptionIdStringNo
data.releasedSubscriptionIdStringNo
data.statusStringNo
data.endBehaviorStringNo
data.createdLong (timestamp-millis)No
data.canceledAtLong (timestamp-millis)No
data.completedAtLong (timestamp-millis)No
data.releasedAtLong (timestamp-millis)No
data.expiresAtLong (timestamp-millis)No
data.currentPhase.startDateLong (timestamp-millis)No
data.currentPhase.endDateLong (timestamp-millis)No
data.phasesArray of StringNo
data.defaultSettings.collectionMethodStringNo
data.defaultSettings.billingCycleAnchorStringNo
data.defaultSettings.defaultPaymentMethodIdStringNo
data.defaultSettings.onBehalfOfStringNo
data.defaultSettings.descriptionStringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo

subscriptions

AttributeTypeRequired
eventIdStringYes
profileIdStringYes
userIdStringNo
sourceIdLongNo
anotherUserIdStringNo
timestampLongYes
subscriptionIdStringNo
latestInvoiceIdStringNo
scheduleIdStringNo
defaultPaymentMethodIdStringNo
data.changeTypeStringNo
data.subscriptionIdStringNo
data.latestInvoiceIdStringNo
data.scheduleIdStringNo
data.defaultPaymentMethodIdStringNo
data.statusStringNo
data.collectionMethodStringNo
data.currencyStringNo
data.amountDecimalNo
data.mrrDecimalNo
data.arrDecimalNo
data.createdLong (timestamp-millis)No
data.currentPeriodStartLong (timestamp-millis)No
data.currentPeriodEndLong (timestamp-millis)No
data.trialStartLong (timestamp-millis)No
data.trialEndLong (timestamp-millis)No
data.cancelAtLong (timestamp-millis)No
data.canceledAtLong (timestamp-millis)No
data.endedAtLong (timestamp-millis)No
data.cancelAtPeriodEndBooleanNo
data.cancellationDetails.reasonStringNo
data.cancellationDetails.feedbackStringNo
data.cancellationDetails.commentStringNo
data.previousAttributes.previousStatusStringNo
data.previousAttributes.previousQuantityDecimalNo
data.previousAttributes.previousPriceIdStringNo
data.previousAttributes.previousProductIdStringNo
data.previousAttributes.previousUnitAmountDecimalNo
data.previousAttributes.previousCurrencyStringNo
data.previousAttributes.previousIntervalStringNo
data.previousAttributes.previousCancelAtPeriodEndBooleanNo
data.previousAttributes.previousTrialEndLong (timestamp-millis)No
data.itemsArray of StringNo
data.discount.discountIdStringNo
data.discount.couponIdStringNo
data.discount.couponNameStringNo
data.discount.amountOffDecimalNo
data.discount.percentOffDecimalNo
data.discount.durationStringNo
data.discount.currencyStringNo
data.discountsArray of StringNo
data.metadataMap of StringNo
data.livemodeBooleanNo
userAttributes.customerIdStringNo
userAttributes.subscriptionStatusStringNo
userAttributes.currentPriceIdStringNo
userAttributes.currentProductIdStringNo
userAttributes.mrrDecimalNo
userAttributes.arrDecimalNo

On this page