Stripe record taxonomy
Every field on every Stripe record, nested ones included, with the type it carries and whether it is required.
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.
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
data.changeType | String | No |
data.livemode | Boolean | No |
data.settings.reconciliationMode | String | No |
data.settings.usingMerchantDefault | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.cashBalance | Array of String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
chargeId | String | No |
paymentIntentId | String | No |
invoiceId | String | No |
disputeId | String | No |
data.changeType | String | No |
data.chargeId | String | No |
data.paymentIntentId | String | No |
data.invoiceId | String | No |
data.disputeId | String | No |
data.status | String | No |
data.amount | Decimal | No |
data.amountCaptured | Decimal | No |
data.amountRefunded | Decimal | No |
data.currency | String | No |
data.paid | Boolean | No |
data.captured | Boolean | No |
data.refunded | Boolean | No |
data.disputed | Boolean | No |
data.created | Long (timestamp-millis) | No |
data.description | String | No |
data.statementDescriptor | String | No |
data.receiptUrl | String | No |
data.receiptNumber | String | No |
data.failureCode | String | No |
data.failureMessage | String | No |
data.paymentMethod | String | No |
data.paymentMethodDetails.type | String | No |
data.paymentMethodDetails.cardBrand | String | No |
data.paymentMethodDetails.cardLast4 | String | No |
data.paymentMethodDetails.cardCountry | String | No |
data.paymentMethodDetails.cardFunding | String | No |
data.paymentMethodDetails.cardExpMonth | Integer | No |
data.paymentMethodDetails.cardExpYear | Integer | No |
data.paymentMethodDetails.cardNetwork | String | No |
data.paymentMethodDetails.cardWallet | String | No |
data.outcome.networkStatus | String | No |
data.outcome.reason | String | No |
data.outcome.riskLevel | String | No |
data.outcome.riskScore | Integer | No |
data.outcome.sellerMessage | String | No |
data.outcome.type | String | No |
data.outcome.rule | String | No |
data.fraudDetails.stripeReport | String | No |
data.fraudDetails.userReport | String | No |
data.refunds | Array of String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.receiptEmail | String | No |
userAttributes.billingName | String | No |
userAttributes.billingEmail | String | No |
userAttributes.billingPhone | String | No |
userAttributes.billingAddressLine1 | String | No |
userAttributes.billingAddressLine2 | String | No |
userAttributes.billingAddressCity | String | No |
userAttributes.billingAddressState | String | No |
userAttributes.billingAddressPostalCode | String | No |
userAttributes.billingAddressCountry | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
checkoutSessionId | String | No |
paymentIntentId | String | No |
subscriptionId | String | No |
invoiceId | String | No |
paymentLinkId | String | No |
recoveredFromId | String | No |
data.changeType | String | No |
data.checkoutSessionId | String | No |
data.paymentIntentId | String | No |
data.subscriptionId | String | No |
data.invoiceId | String | No |
data.paymentLinkId | String | No |
data.recoveredFromId | String | No |
data.clientReferenceId | String | No |
data.mode | String | No |
data.status | String | No |
data.paymentStatus | String | No |
data.currency | String | No |
data.amountTotal | Decimal | No |
data.amountSubtotal | Decimal | No |
data.url | String | No |
data.successUrl | String | No |
data.cancelUrl | String | No |
data.created | Long (timestamp-millis) | No |
data.expiresAt | Long (timestamp-millis) | No |
data.paymentMethodTypes | Array of String | No |
data.paymentMethodCollection | String | No |
data.discounts | Array of String | No |
data.totalDetails.amountDiscount | Decimal | No |
data.totalDetails.amountShipping | Decimal | No |
data.totalDetails.amountTax | Decimal | No |
data.shippingCost.amountSubtotal | Decimal | No |
data.shippingCost.amountTax | Decimal | No |
data.shippingCost.amountTotal | Decimal | No |
data.consent.promotions | String | No |
data.consent.termsOfService | String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.email | String | No |
userAttributes.name | String | No |
userAttributes.phone | String | No |
userAttributes.businessName | String | No |
userAttributes.taxExempt | String | No |
userAttributes.addressLine1 | String | No |
userAttributes.addressLine2 | String | No |
userAttributes.city | String | No |
userAttributes.state | String | No |
userAttributes.postalCode | String | No |
userAttributes.country | String | No |
userAttributes.locale | String | No |
userAttributes.customerTaxIds | Array of String | No |
userAttributes.shippingName | String | No |
userAttributes.shippingPhone | String | No |
userAttributes.shippingAddressLine1 | String | No |
userAttributes.shippingAddressLine2 | String | No |
userAttributes.shippingAddressCity | String | No |
userAttributes.shippingAddressState | String | No |
userAttributes.shippingAddressPostalCode | String | No |
userAttributes.shippingAddressCountry | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
transactionId | String | No |
appliedToPaymentId | String | No |
appliedToInvoiceId | String | No |
refundedFromPaymentId | String | No |
data.changeType | String | No |
data.transactionId | String | No |
data.type | String | No |
data.netAmount | Decimal | No |
data.endingBalance | Decimal | No |
data.currency | String | No |
data.created | Long (timestamp-millis) | No |
data.funded.reference | String | No |
data.funded.fundingType | String | No |
data.funded.bankName | String | No |
data.funded.bankCountry | String | No |
data.funded.last4 | String | No |
data.funded.senderName | String | No |
data.appliedToPaymentId | String | No |
data.appliedToInvoiceId | String | No |
data.refundedFromPaymentId | String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
taxIdId | String | No |
data.changeType | String | No |
data.taxIdId | String | No |
data.created | Long (timestamp-millis) | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.taxId | String | No |
userAttributes.taxIdType | String | No |
userAttributes.taxIdCountry | String | No |
userAttributes.taxIdVerificationStatus | String | No |
userAttributes.taxIdVerifiedName | String | No |
userAttributes.taxIdVerifiedAddress | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
changeType | String | No |
userAttributes.customerId | String | No |
userAttributes.email | String | No |
userAttributes.name | String | No |
userAttributes.phone | String | No |
userAttributes.description | String | No |
userAttributes.created | Long (timestamp-millis) | No |
userAttributes.currency | String | No |
userAttributes.balance | Decimal | No |
userAttributes.delinquent | Boolean | No |
userAttributes.taxExempt | String | No |
userAttributes.preferredLocales | Array of String | No |
userAttributes.defaultSource | String | No |
userAttributes.defaultPaymentMethod | String | No |
userAttributes.livemode | Boolean | No |
userAttributes.deleted | Boolean | No |
userAttributes.addressLine1 | String | No |
userAttributes.addressLine2 | String | No |
userAttributes.city | String | No |
userAttributes.state | String | No |
userAttributes.postalCode | String | No |
userAttributes.country | String | No |
userAttributes.shipping.name | String | No |
userAttributes.shipping.phone | String | No |
userAttributes.shipping.address.line1 | String | No |
userAttributes.shipping.address.line2 | String | No |
userAttributes.shipping.address.city | String | No |
userAttributes.shipping.address.state | String | No |
userAttributes.shipping.address.postalCode | String | No |
userAttributes.shipping.address.country | String | No |
userAttributes.discount | String | No |
userAttributes.discounts | Array of String | No |
userAttributes.metadata | Map of String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
discountId | String | No |
subscriptionId | String | No |
invoiceId | String | No |
promotionCodeId | String | No |
data.changeType | String | No |
data.discountId | String | No |
data.subscriptionId | String | No |
data.invoiceId | String | No |
data.promotionCodeId | String | No |
data.start | Long (timestamp-millis) | No |
data.end | Long (timestamp-millis) | No |
data.coupon.couponId | String | No |
data.coupon.name | String | No |
data.coupon.amountOff | Decimal | No |
data.coupon.percentOff | Decimal | No |
data.coupon.currency | String | No |
data.coupon.duration | String | No |
data.coupon.durationInMonths | Integer | No |
data.coupon.maxRedemptions | Integer | No |
data.coupon.timesRedeemed | Integer | No |
data.coupon.redeemBy | Long (timestamp-millis) | No |
data.coupon.valid | Boolean | No |
data.coupon.created | Long (timestamp-millis) | No |
userAttributes.customerId | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
disputeId | String | No |
chargeId | String | No |
paymentIntentId | String | No |
data.changeType | String | No |
data.disputeId | String | No |
data.chargeId | String | No |
data.paymentIntentId | String | No |
data.amount | Decimal | No |
data.currency | String | No |
data.status | String | No |
data.reason | String | No |
data.isChargeRefundable | Boolean | No |
data.created | Long (timestamp-millis) | No |
data.evidenceDueBy | Long (timestamp-millis) | No |
data.networkReasonCode | String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
earlyFraudWarningId | String | No |
chargeId | String | No |
paymentIntentId | String | No |
data.changeType | String | No |
data.earlyFraudWarningId | String | No |
data.chargeId | String | No |
data.paymentIntentId | String | No |
data.fraudType | String | No |
data.actionable | Boolean | No |
data.created | Long (timestamp-millis) | No |
data.livemode | Boolean | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
invoiceId | String | No |
subscriptionId | String | No |
paymentIntentId | String | No |
chargeId | String | No |
defaultPaymentMethodId | String | No |
defaultSourceId | String | No |
data.changeType | String | No |
data.invoiceId | String | No |
data.subscriptionId | String | No |
data.paymentIntentId | String | No |
data.chargeId | String | No |
data.defaultPaymentMethodId | String | No |
data.defaultSourceId | String | No |
data.number | String | No |
data.receiptNumber | String | No |
data.status | String | No |
data.billingReason | String | No |
data.collectionMethod | String | No |
data.currency | String | No |
data.total | Decimal | No |
data.subtotal | Decimal | No |
data.tax | Decimal | No |
data.amountDue | Decimal | No |
data.amountPaid | Decimal | No |
data.amountRemaining | Decimal | No |
data.amountShipping | Decimal | No |
data.amountOverpaid | Decimal | No |
data.paid | Boolean | No |
data.paidOutOfBand | Boolean | No |
data.attempted | Boolean | No |
data.attemptCount | Integer | No |
data.nextPaymentAttempt | Long (timestamp-millis) | No |
data.created | Long (timestamp-millis) | No |
data.finalizedAt | Long (timestamp-millis) | No |
data.dueDate | Long (timestamp-millis) | No |
data.effectiveAt | Long (timestamp-millis) | No |
data.periodStart | Long (timestamp-millis) | No |
data.periodEnd | Long (timestamp-millis) | No |
data.hostedInvoiceUrl | String | No |
data.invoicePdf | String | No |
data.discount.discountId | String | No |
data.discount.couponId | String | No |
data.discount.couponName | String | No |
data.discount.amountOff | Decimal | No |
data.discount.percentOff | Decimal | No |
data.discount.duration | String | No |
data.discount.currency | String | No |
data.discounts | Array of String | No |
data.totalDiscountAmounts | Array of String | No |
data.lastFinalizationError.code | String | No |
data.lastFinalizationError.message | String | No |
data.lastFinalizationError.param | String | No |
data.lastFinalizationError.docUrl | String | No |
data.lastFinalizationError.type | String | No |
data.lastPaymentError.code | String | No |
data.lastPaymentError.declineCode | String | No |
data.lastPaymentError.message | String | No |
data.lastPaymentError.paymentMethodType | String | No |
data.lastPaymentError.cardBrand | String | No |
data.lastPaymentError.cardLast4 | String | No |
data.lines | Array of String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.email | String | No |
userAttributes.name | String | No |
userAttributes.phone | String | No |
userAttributes.addressLine1 | String | No |
userAttributes.addressLine2 | String | No |
userAttributes.city | String | No |
userAttributes.state | String | No |
userAttributes.postalCode | String | No |
userAttributes.country | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
paymentIntentId | String | No |
invoiceId | String | No |
latestChargeId | String | No |
paymentMethodId | String | No |
data.changeType | String | No |
data.paymentIntentId | String | No |
data.invoiceId | String | No |
data.latestChargeId | String | No |
data.paymentMethodId | String | No |
data.status | String | No |
data.amount | Decimal | No |
data.amountReceived | Decimal | No |
data.amountCapturable | Decimal | No |
data.currency | String | No |
data.created | Long (timestamp-millis) | No |
data.canceledAt | Long (timestamp-millis) | No |
data.cancellationReason | String | No |
data.description | String | No |
data.statementDescriptor | String | No |
data.statementDescriptorSuffix | String | No |
data.setupFutureUsage | String | No |
data.paymentMethodTypes | Array of String | No |
data.lastPaymentError.code | String | No |
data.lastPaymentError.declineCode | String | No |
data.lastPaymentError.message | String | No |
data.lastPaymentError.param | String | No |
data.lastPaymentError.docUrl | String | No |
data.lastPaymentError.chargeId | String | No |
data.lastPaymentError.paymentMethodId | String | No |
data.lastPaymentError.paymentMethodType | String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.receiptEmail | String | No |
userAttributes.shippingName | String | No |
userAttributes.shippingPhone | String | No |
userAttributes.shippingCarrier | String | No |
userAttributes.shippingTrackingNumber | String | No |
userAttributes.shippingAddressLine1 | String | No |
userAttributes.shippingAddressLine2 | String | No |
userAttributes.shippingAddressCity | String | No |
userAttributes.shippingAddressState | String | No |
userAttributes.shippingAddressPostalCode | String | No |
userAttributes.shippingAddressCountry | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
paymentMethodId | String | No |
data.changeType | String | No |
data.paymentMethodId | String | No |
data.type | String | No |
data.created | Long (timestamp-millis) | No |
data.card.brand | String | No |
data.card.last4 | String | No |
data.card.expMonth | Integer | No |
data.card.expYear | Integer | No |
data.card.country | String | No |
data.card.funding | String | No |
data.card.wallet | String | No |
data.card.network | String | No |
data.sepaDebit.last4 | String | No |
data.sepaDebit.country | String | No |
data.sepaDebit.bankCode | String | No |
data.sepaDebit.branchCode | String | No |
data.usBankAccount.last4 | String | No |
data.usBankAccount.bankName | String | No |
data.usBankAccount.accountType | String | No |
data.usBankAccount.accountHolderType | String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.billingName | String | No |
userAttributes.billingEmail | String | No |
userAttributes.billingPhone | String | No |
userAttributes.billingAddressLine1 | String | No |
userAttributes.billingAddressLine2 | String | No |
userAttributes.billingAddressCity | String | No |
userAttributes.billingAddressState | String | No |
userAttributes.billingAddressPostalCode | String | No |
userAttributes.billingAddressCountry | String | No |
| Attribute | Type | Required |
|---|
productId | String | Yes |
sourceId | Long | No |
timestamp | Long | Yes |
productAttributes.changeType | String | No |
productAttributes.productId | String | No |
productAttributes.defaultPriceId | String | No |
productAttributes.name | String | No |
productAttributes.description | String | No |
productAttributes.active | Boolean | No |
productAttributes.type | String | No |
productAttributes.taxCode | String | No |
productAttributes.url | String | No |
productAttributes.images | Array of String | No |
productAttributes.created | Long (timestamp-millis) | No |
productAttributes.updated | Long (timestamp-millis) | No |
productAttributes.metadata | Map of String | No |
productAttributes.livemode | Boolean | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
refundId | String | No |
chargeId | String | No |
paymentIntentId | String | No |
balanceTransactionId | String | No |
data.changeType | String | No |
data.refundId | String | No |
data.chargeId | String | No |
data.paymentIntentId | String | No |
data.balanceTransactionId | String | No |
data.amount | Decimal | No |
data.currency | String | No |
data.status | String | No |
data.reason | String | No |
data.failureReason | String | No |
data.receiptNumber | String | No |
data.description | String | No |
data.created | Long (timestamp-millis) | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
reviewId | String | No |
chargeId | String | No |
paymentIntentId | String | No |
data.changeType | String | No |
data.reviewId | String | No |
data.chargeId | String | No |
data.paymentIntentId | String | No |
data.reason | String | No |
data.openedReason | String | No |
data.closedReason | String | No |
data.open | Boolean | No |
data.created | Long (timestamp-millis) | No |
data.livemode | Boolean | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
scheduleId | String | No |
subscriptionId | String | No |
releasedSubscriptionId | String | No |
data.changeType | String | No |
data.scheduleId | String | No |
data.subscriptionId | String | No |
data.releasedSubscriptionId | String | No |
data.status | String | No |
data.endBehavior | String | No |
data.created | Long (timestamp-millis) | No |
data.canceledAt | Long (timestamp-millis) | No |
data.completedAt | Long (timestamp-millis) | No |
data.releasedAt | Long (timestamp-millis) | No |
data.expiresAt | Long (timestamp-millis) | No |
data.currentPhase.startDate | Long (timestamp-millis) | No |
data.currentPhase.endDate | Long (timestamp-millis) | No |
data.phases | Array of String | No |
data.defaultSettings.collectionMethod | String | No |
data.defaultSettings.billingCycleAnchor | String | No |
data.defaultSettings.defaultPaymentMethodId | String | No |
data.defaultSettings.onBehalfOf | String | No |
data.defaultSettings.description | String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
| Attribute | Type | Required |
|---|
eventId | String | Yes |
profileId | String | Yes |
userId | String | No |
sourceId | Long | No |
anotherUserId | String | No |
timestamp | Long | Yes |
subscriptionId | String | No |
latestInvoiceId | String | No |
scheduleId | String | No |
defaultPaymentMethodId | String | No |
data.changeType | String | No |
data.subscriptionId | String | No |
data.latestInvoiceId | String | No |
data.scheduleId | String | No |
data.defaultPaymentMethodId | String | No |
data.status | String | No |
data.collectionMethod | String | No |
data.currency | String | No |
data.amount | Decimal | No |
data.mrr | Decimal | No |
data.arr | Decimal | No |
data.created | Long (timestamp-millis) | No |
data.currentPeriodStart | Long (timestamp-millis) | No |
data.currentPeriodEnd | Long (timestamp-millis) | No |
data.trialStart | Long (timestamp-millis) | No |
data.trialEnd | Long (timestamp-millis) | No |
data.cancelAt | Long (timestamp-millis) | No |
data.canceledAt | Long (timestamp-millis) | No |
data.endedAt | Long (timestamp-millis) | No |
data.cancelAtPeriodEnd | Boolean | No |
data.cancellationDetails.reason | String | No |
data.cancellationDetails.feedback | String | No |
data.cancellationDetails.comment | String | No |
data.previousAttributes.previousStatus | String | No |
data.previousAttributes.previousQuantity | Decimal | No |
data.previousAttributes.previousPriceId | String | No |
data.previousAttributes.previousProductId | String | No |
data.previousAttributes.previousUnitAmount | Decimal | No |
data.previousAttributes.previousCurrency | String | No |
data.previousAttributes.previousInterval | String | No |
data.previousAttributes.previousCancelAtPeriodEnd | Boolean | No |
data.previousAttributes.previousTrialEnd | Long (timestamp-millis) | No |
data.items | Array of String | No |
data.discount.discountId | String | No |
data.discount.couponId | String | No |
data.discount.couponName | String | No |
data.discount.amountOff | Decimal | No |
data.discount.percentOff | Decimal | No |
data.discount.duration | String | No |
data.discount.currency | String | No |
data.discounts | Array of String | No |
data.metadata | Map of String | No |
data.livemode | Boolean | No |
userAttributes.customerId | String | No |
userAttributes.subscriptionStatus | String | No |
userAttributes.currentPriceId | String | No |
userAttributes.currentProductId | String | No |
userAttributes.mrr | Decimal | No |
userAttributes.arr | Decimal | No |