Explore the Stripe API data model

Pulling data from the Stripe API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Stripe API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Account

Documentation: https://docs.stripe.com/api/accounts

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
AnnualRevenue	decimal	-	-
EstimatedWorkerCount	decimal	-	-
MCC	decimal	-	-
SupportAddressCity	string	-	-
SupportAddressCountry	string	-	-
SupportAddressLine1	string	-	-
SupportAddressLine2	string	-	-
SupportAddressPostalCode	string	-	-
SupportAddressPostalState	string	-	-
SupportEmail	string	-	-
SupportPhone	string	-	-
Url	string	-	-
AfterPayClearPayPayments	string	-	-
BanContactPayments	string	-	-
CardPayments	string	-	-
EPSPayments	string	-	-
GiropayPayments	string	-	-
IdealPayments	string	-	-
KlarnaPayments	string	-	-
LinkPayments	string	-	-
P24Payments	string	-	-
SepaDebitPayments	string	-	-
SofortPayments	string	-	-
Transfers	string	-	-
ControllerType	string	-	-
ChargesEnabled	boolean	-	-
Country	string	-	-
DefaultCurrency	string	-	-
DetailsSubmitted	boolean	-	-
Email	string	-	-
PayoutsEnabled	boolean	-	-
Type	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

BalanceTransaction

Documentation: https://docs.stripe.com/api/balance_transactions

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
Amount	decimal	-	-
ExchangeRate	decimal	-	-
Net	decimal	-	-
Fee	decimal	-	-
AvailableOn	long	-	-
Currency	string	-	-
ReportingCategory	string	-	-
Source	string	-	-
Status	string	-	-
Type	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Charge

Documentation: https://docs.stripe.com/api/charges

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
Amount	decimal	-	-
AmountCaptured	decimal	-	-
AmountRefunded	decimal	-	-
BalanceTransaction	string	BalanceTransaction → ID	-
FailureBalanceTransaction	string	BalanceTransaction → ID	-
Invoice	string	Invoice → ID	-
PaymentIntent	string	-	-
Customer	string	Customer → ID	-
FailureCode	string	-	-
FailureMessage	string	-	-
Disputed	boolean	-	-
Paid	boolean	-	-
Refunded	boolean	-	-
ShippingAddressCity	string	-	-
ShippingAddressCountry	string	-	-
ShippingAddressLine1	string	-	-
ShippingAddressLine2	string	-	-
ShippingAddressPostalCode	string	-	-
ShippingName	string	-	-
ShippingPhone	string	-	-
Currency	string	-	-
ReceiptEmail	string	-	-
StatementDescriptor	string	-	-
Status	string	-	-
StatementDescriptorSuffix	string	-	-
Application	string	-	-
ReceiptNumber	string	-	-
ReceiptUrl	string	-	-
Review	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

ChargeDispute

Documentation: https://docs.stripe.com/api/disputes

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Amount	decimal	-	-
IsChargeRefundable	boolean	-	-
Charge	string	Charge → ID	-
Updated	long	-	-
Reason	string	-	-
Currency	string	-	-
Status	string	-	-
HasEvidence	boolean	-	-
EvidenceDueBy	long	-	-
EvidencePastDue	boolean	-	-
EvidenceSubmissionCount	int	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

CreditNote

Documentation: https://docs.stripe.com/api/credit_notes

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
ObjectTypeName	string	-	-
Amount	decimal	-	-
OutOfBandAmount	decimal	-	-
AmountShipping	decimal	-	-
Currency	string	-	-
Customer	string	Customer → ID	-
CustomerBalanceTransaction	string	-	-
DiscountAmount	decimal	-	-
Invoice	string	Invoice → ID	-
Memo	string	-	-
Number	string	-	-
Pdf	string	-	-
Reason	string	-	-
Status	string	-	-
Subtotal	decimal	-	-
SubtotalExcludingTax	decimal	-	-
Total	decimal	-	-
TotalExcludingTax	decimal	-	-
Type	string	-	-
VoidedAt	long	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-

Customer

Documentation: https://docs.stripe.com/api/customers

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Balance	decimal	-	-
Email	string	-	-
Phone	string	-	-
Currency	string	-	-
DefaultSource	string	-	-
ShippingAddressCity	string	-	-
ShippingAddressCountry	string	-	-
ShippingAddressLine1	string	-	-
ShippingAddressLine2	string	-	-
ShippingAddressPostalCode	string	-	-
ShippingName	string	-	-
ShippingPhone	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Invoice

Documentation: https://docs.stripe.com/api/invoices

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
AmountDue	decimal	-	-
AmountPaid	decimal	-	-
AmountRemaining	decimal	-	-
AmountShipping	decimal	-	-
AccountCountry	string	-	-
AccountName	string	-	-
AttemptCount	int	-	-
Attempted	boolean	-	-
AutoAdvance	boolean	-	-
CollectionMethod	string	-	-
Currency	string	-	-
Customer	string	Customer → ID	-
HostedInvoiceUrl	string	-	-
PaymentIntent	string	-	-
FromInvoice	string	Invoice → ID	-
PeriodEnd	long	-	-
PeriodStart	long	-	-
Status	string	-	-
Subscription	string	-	-
Total	decimal	-	-
EndingBalance	decimal	-	-
DueDate	long	-	-
EffectiveAt	long	-	-
Paid	boolean	-	-
PaidOutOfBand	boolean	-	-
PostPaymentCreditNotesAmount	decimal	-	-
PrePaymentCreditNotesAmount	decimal	-	-
Quote	string	-	-
DiscountAmount	decimal	-	-
ReceiptNumber	string	-	-
Number	string	-	-
Pdf	string	-	-
Reason	string	-	-
StatementDescriptor	string	-	-
Subtotal	decimal	-	-
SubtotalExcludingTax	decimal	-	-
TotalExcludingTax	decimal	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

PaymentIntent

Documentation: https://docs.stripe.com/api/payment_intents

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
Amount	decimal	-	-
AmountCapturable	decimal	-	-
AmountReceived	decimal	-	-
IsChargeRefundable	boolean	-	-
Customer	string	Customer → ID	-
Invoice	string	Invoice → ID	-
LatestCharge	string	Charge → ID	-
OnBehalfOf	string	Account → ID	-
PaymentMethod	string	-	-
CanceledAt	long	-	-
CancellationReason	string	-	-
CaptureMethod	string	-	-
Currency	string	-	-
ReceiptEmail	string	-	-
StatementDescriptorSuffix	string	-	-
SetupFutureUsage	string	-	-
Status	string	-	-
ConfirmationMethod	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Payout

Documentation: https://docs.stripe.com/api/payouts

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
Amount	decimal	-	-
ArrivalDate	long	-	-
Automatic	boolean	-	-
BalanceTransaction	string	BalanceTransaction → ID	-
FailureBalanceTransaction	string	BalanceTransaction → ID	-
Currency	string	-	-
Destination	string	-	-
FailureCode	string	-	-
FailureMessage	string	-	-
StatementDescriptor	string	-	-
Method	string	-	-
OriginalPayout	string	Payout → ID	-
ReversedBy	string	Payout → ID	-
ReconciliationStatus	string	-	-
Type	string	-	-
SourceType	string	-	-
Status	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Plan

Documentation: https://docs.stripe.com/api/plans

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Active	boolean	-	-
AggregateUsage	string	-	-
Amount	decimal	-	-
AmountDecimal	decimal	-	-
BillingScheme	string	-	-
Currency	string	-	-
Interval	string	-	-
IntervalCount	decimal	-	-
Livemode	boolean	-	-
Nickname	string	-	-
Product	string	Product → ID	-
TiersMode	string	-	-
TransFormUsageDivideBy	decimal	-	-
TransFormUsageRound	string	-	-
TrialPeriodDays	decimal	-	-
UsageType	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Price

Documentation: https://docs.stripe.com/api/prices

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
UnitAmountDecimal	decimal	-	-
Currency	string	-	-
LookupKey	string	-	-
Active	boolean	-	-
BillingScheme	string	-	-
Type	string	-	-
TiersMode	string	-	-
Product	string	Product → ID	-
TaxBehavior	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Product

Documentation: https://docs.stripe.com/api/products

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Name	string	-	-
Description	string	-	-
DefaultPrice	string	Price → ID	-
Active	boolean	-	-
Updated	long	-	-
UnitLabel	string	-	-
Currency	string	-	-
TaxCode	string	-	-
StatementDescriptor	string	-	-
PackageHeight	decimal	-	-
PackageWeight	decimal	-	-
PackageLength	decimal	-	-
PackageWidth	decimal	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

ChargeRefund

Documentation: https://docs.stripe.com/api/refunds

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Amount	decimal	-	-
BalanceTransaction	string	BalanceTransaction → ID	-
Charge	string	Charge → ID	-
PaymentIntent	string	PaymentIntent → ID	-
Currency	string	-	-
Reason	string	-	-
Status	string	-	-
ReceiptNumber	string	-	-
SourceTransferReversal	string	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

Subscription

Documentation: https://docs.stripe.com/api/subscriptions

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
ObjectTypeName	string	-	-
AutomaticTaxEnabled	boolean	-	-
CancellationComment	string	-	-
CancellationFeedback	string	-	-
CancellationReason	string	-	-
Application	string	-	21 Nov 2024 ID of the connect application that created the subscription
ApplicationFeePercent	decimal	-	-
BillingCycleAnchor	long	-	-
BillingThresholdAmountGTE	decimal	-	-
BillingThresholdResetBillingCycleAnchor	boolean	-	-
CancelAt	long	-	-
CancelAtPeriodEnd	boolean	-	-
CanceledAt	long	-	-
CollectionMethod	string	-	-
Currency	string	-	-
CurrentPeriodEnd	long	-	-
CurrentPeriodStart	long	-	-
Customer	string	Customer → ID	-
DaysUntilDue	long	-	-
DefaultPaymentMethod	string	-	-
DefaultSource	string	-	-
EndedAt	long	-	-
LatestInvoice	string	Invoice → ID	-
Livemode	boolean	-	-
NextPendingInvoiceItemInvoice	long	-	-
OnBehalfOf	string	-	21 Nov 2024 The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details
PauseCollectionBehaviour	string	-	-
PauseCollectionResumesAt	long	-	-
PendingInvoiceItemIntervalType	string	-	-
PendingInvoiceItemIntervalCount	decimal	-	-
Schedule	string	-	-
StartDate	long	-	-
Status	string	-	-
TestClock	string	-	-
TransferDataAmountPercent	decimal	-	22 Nov 2024 Connect only. A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account.
TransferDataDestination	string	Account → ID	22 Nov 2024 Connect only. The account to which the destination charges will be paid.
TrialEnd	long	-	-
TrialStart	long	-	-
DateModified	datetime	-	-
Created	long	-	-
Object	string	-	-

Evidence

Column	Type	Relates to	Notes
RemoteID	string	-	-
ChargeDisputeRemoteID	string	ChargeDispute → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
DisputeID	string	ChargeDispute → ID	-
AccessActivityLog	string	-	-
CancellationPolicy	string	-	-
BillingAddress	string	-	-
CancellationPolicyDisclosure	string	-	-
CancellationRebuttal	string	-	-
CustomerCommunication	string	-	-
CustomerEmailAddress	string	-	-
CustomerName	string	-	-
CustomerPurchaseIp	string	-	-
CustomerSignature	string	-	-
DuplicateChargeDocumentation	string	-	-
DuplicateChargeID	string	-	-
ProductDescription	string	-	-
Receipt	string	-	-
RefundPolicy	string	-	-
RefundRefusalExplanation	string	-	-
RefundPolicyDisclosure	string	-	-
ServiceDate	string	-	-
ServiceDocumentation	string	-	-
ShippingAddress	string	-	-
ShippingCarrier	string	-	-
ShippingDate	string	-	-
ShippingDocumentation	string	-	-
ShippingTrackingNumber	string	-	-
UncategorizedFile	string	-	-
UncategorizedText	string	-	-

CreditNoteLineItem

Documentation: https://docs.stripe.com/api/credit_notes/line_item

Column	Type	Relates to	Notes
RemoteID	string	-	-
CreditNoteRemoteID	string	CreditNote → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
CreditNoteID	string	CreditNote → ID	-
Amount	decimal	-	-
AmountExcludingTax	decimal	-	-
DiscountAmount	decimal	-	-
Quantity	decimal	-	-
UnitAmountDecimal	decimal	-	-
UnitAmountExcludingTax	decimal	-	-
InvoiceLineItem	string	InvoiceLineItem → ID	-
Type	string	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

InvoiceLineItem

Documentation: https://docs.stripe.com/api/invoice-line-item

Column	Type	Relates to	Notes
RemoteID	string	-	-
InvoiceRemoteID	string	Invoice → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Description	string	-	-
InvoiceID	string	Invoice → ID	-
Amount	decimal	-	-
AmountExcludingTax	decimal	-	-
DiscountAmount	decimal	-	-
Quantity	decimal	-	-
UnitAmountDecimal	decimal	-	-
UnitAmountExcludingTax	decimal	-	-
Proration	boolean	-	-
PriceID	string	Price → ID	-
PeriodStart	long	-	-
PeriodEnd	long	-	-
InvoiceItem	string	-	-
SubscriptionItem	string	-	-
Type	string	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-

SubscriptionItem

Column	Type	Relates to	Notes
RemoteID	string	-	-
SubscriptionRemoteID	string	Subscription → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	string	-	-
Subscription	string	Subscription → ID	-
PlanID	string	Plan → ID	-
PriceID	string	Price → ID	-
Quantity	decimal	-	-
Created	long	-	-
Object	string	-	-
ObjectTypeName	string	-	-