Datapipe
Stripe

Live

Stripe for agencies and in-house teams

Finance and marketing teams use Stripe in Datapipe to see charges, payouts, customers, and subscription revenue.

Start free

What connects

Stripe Connect OAuth with the read_write scope, because read_only is only for Stripe Apps. Or paste a restricted key that starts with rk_ and has read permission on the resources you use, such as charges, customers, payouts, and subscriptions.

What you can report on

What you set up

  1. Prefer Sign in with Stripe so the shop connects with Connect OAuth.
  2. Or, under Connections, paste a restricted key with read access on each resource.
  3. Create the charges, payouts, customers, or subscription report.

Limitations

Connect does not request read_only. A restricted key only returns resources it was allowed to read. The page's full Stripe field list is the API catalog, not the columns in the current reports.

Last reviewed 2026-10-29. Owner: Datapipe.

Connection

Live

Live with Stripe sign-in or a restricted key you paste. Sign-in uses read_write, because read_only is only for Stripe Apps. The key needs read permission on each resource, such as charges and customers.

Fields

Properties of the Stripe Charge, Customer, Subscription, Invoice, Payout, PaymentIntent, Product, Price, Refund, and Balance Transaction objects in the official OpenAPI spec. Source: https://github.com/stripe/openapi/blob/master/openapi/spec3.json. Read on 2026-10-27. 358 fields.

Synced today

Advertising

NameAPI fieldDescriptionTypeGroupCross-channel
reviewcharge.reviewID of the review associated with this charge if one exists.dimension · stringAdvertising
reviewpayment_intent.reviewID of the review associated with this PaymentIntent, if any.dimension · stringAdvertising

Content

NameAPI fieldDescriptionTypeGroupCross-channel
receipt urlcharge.receipt_urlThis is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.dimension · stringContent
urlproduct.urlA URL of a publicly-accessible webpage for this product.dimension · stringContent

Dimensions

NameAPI fieldDescriptionTypeGroupCross-channel
applicationcharge.applicationID of the Connect application that created the charge.dimension · stringDimensions
billing detailscharge.billing_detailsProperty billing_details on the Stripe charge object.dimension · stringDimensions
calculated statement descriptorcharge.calculated_statement_descriptorThe full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.dimension · stringDimensions
capturedcharge.capturedIf the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.dimension · booleanDimensions
createdcharge.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todaycharge.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringDimensions
customercharge.customerID of the customer this charge is for if one exists.dimension · stringDimensions
descriptioncharge.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.dimension · stringDimensions
disputedcharge.disputedWhether the charge has been disputed.dimension · booleanDimensions
failure codecharge.failure_codeError code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes).dimension · stringDimensions
failure messagecharge.failure_messageMessage to user further explaining reason for charge failure if available.dimension · stringDimensions
fraud detailscharge.fraud_detailsInformation on fraud assessments for the charge.dimension · stringDimensions
idcharge.idUnique identifier for the object.dimension · stringDimensions
livemodecharge.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
metadatacharge.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectDimensions
objectcharge.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
on behalf ofcharge.on_behalf_ofThe account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.dimension · stringDimensions
outcomecharge.outcomeDetails about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details.dimension · stringDimensions
paidcharge.paid`true` if the charge succeeded, or was successfully authorized for later capture.dimension · booleanDimensions
payment intentcharge.payment_intentID of the PaymentIntent associated with this charge, if one exists.dimension · stringDimensions
payment methodcharge.payment_methodID of the payment method used in this charge.dimension · stringDimensions
payment method detailscharge.payment_method_detailsDetails about the payment method at the time of the transaction.dimension · stringDimensions
radar optionscharge.radar_optionsProperty radar_options on the Stripe charge object.dimension · stringDimensions
receipt emailcharge.receipt_emailThis is the email address that the receipt for this charge was sent to.dimension · stringDimensions
receipt numbercharge.receipt_numberThis is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.dimension · stringDimensions
shippingcharge.shippingShipping information for the charge.dimension · stringDimensions
statement descriptorcharge.statement_descriptorFor a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.dimension · stringDimensions
statement descriptor suffixcharge.statement_descriptor_suffixProvides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.dimension · stringDimensions
statuscharge.statusThe status of the payment is either `succeeded`, `pending`, or `failed`.dimension · stringDimensions
transfercharge.transferID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).dimension · stringDimensions
transfer datacharge.transfer_dataAn optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.dimension · stringDimensions
transfer groupcharge.transfer_groupA string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.dimension · stringDimensions
addresscustomer.addressThe customer's billing address.dimension · stringDimensions
balancecustomer.balanceThe current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance).dimension · integerDimensions
business namecustomer.business_nameThe customer's business name.dimension · stringDimensions
cash balancecustomer.cash_balanceThe current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.dimension · stringDimensions
createdcustomer.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todaycustomer.currencyThree-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.dimension · stringDimensions
delinquentcustomer.delinquentTracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.dimension · booleanDimensions
descriptioncustomer.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.dimension · stringDimensions
emailcustomer.emailThe customer's email address.dimension · stringDimensions
idcustomer.idUnique identifier for the object.dimension · stringDimensions
individual namecustomer.individual_nameThe customer's individual name.dimension · stringDimensions
invoice credit balancecustomer.invoice_credit_balanceThe current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.dimension · objectDimensions
invoice prefixcustomer.invoice_prefixThe prefix for the customer used to generate unique invoice numbers.dimension · stringDimensions
invoice settingscustomer.invoice_settingsProperty invoice_settings on the Stripe customer object.dimension · stringDimensions
livemodecustomer.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
metadatacustomer.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectDimensions
namecustomer.nameThe customer's full name or business name.dimension · stringDimensions
next invoice sequencecustomer.next_invoice_sequenceThe suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.dimension · integerDimensions
objectcustomer.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
phonecustomer.phoneThe customer's phone number.dimension · stringDimensions
shippingcustomer.shippingMailing and shipping address for the customer. Appears on invoices emailed to this customer.dimension · stringDimensions
subscriptionscustomer.subscriptionsThe customer's current subscriptions, if any.dimension · objectDimensions
taxcustomer.taxProperty tax on the Stripe customer object.dimension · stringDimensions
tax exemptcustomer.tax_exemptDescribes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.dimension · stringDimensions
tax idscustomer.tax_idsThe customer's tax IDs.dimension · objectDimensions
test clockcustomer.test_clockID of the test clock that this customer belongs to.dimension · stringDimensions
applicationsubscription.applicationID of the Connect Application that created the subscription.dimension · stringDimensions
automatic taxsubscription.automatic_taxProperty automatic_tax on the Stripe subscription object.dimension · stringDimensions
billing cycle anchorsubscription.billing_cycle_anchorThe reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.dimension · integerDimensions
billing cycle anchor configsubscription.billing_cycle_anchor_configThe fixed values used to calculate the `billing_cycle_anchor`.dimension · stringDimensions
billing modesubscription.billing_modeProperty billing_mode on the Stripe subscription object.dimension · stringDimensions
billing schedulessubscription.billing_schedulesBilling schedules for this subscription.dimension · arrayDimensions
billing thresholdssubscription.billing_thresholdsDefine thresholds at which an invoice will be sent, and the subscription advanced to a new billing perioddimension · stringDimensions
cancel atsubscription.cancel_atA date in the future at which the subscription will automatically get canceleddimension · integerDimensions
cancel at period endsubscription.cancel_at_period_endWhether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.dimension · booleanDimensions
canceled atsubscription.canceled_atIf the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.dimension · integerDimensions
cancellation detailssubscription.cancellation_detailsDetails about why this subscription was cancelleddimension · stringDimensions
collection methodsubscription.collection_methodEither `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.dimension · stringDimensions
createdsubscription.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todaysubscription.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringDimensions
customersubscription.customerID of the customer who owns the subscription.dimension · stringDimensions
default payment methodsubscription.default_payment_methodID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).dimension · stringDimensions
default tax ratessubscription.default_tax_ratesThe tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.dimension · arrayDimensions
descriptionsubscription.descriptionThe subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.dimension · stringDimensions
ended atsubscription.ended_atIf the subscription has ended, the date the subscription ended.dimension · integerDimensions
idsubscription.idUnique identifier for the object.dimension · stringDimensions
invoice settingssubscription.invoice_settingsProperty invoice_settings on the Stripe subscription object.dimension · stringDimensions
latest invoicesubscription.latest_invoiceThe most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).dimension · stringDimensions
livemodesubscription.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
managed paymentssubscription.managed_paymentsSettings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).dimension · stringDimensions
metadatasubscription.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectDimensions
objectsubscription.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
on behalf ofsubscription.on_behalf_ofThe account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.dimension · stringDimensions
pause collectionsubscription.pause_collectionIf specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).dimension · stringDimensions
payment settingssubscription.payment_settingsPayment settings passed on to invoices created by the subscription.dimension · stringDimensions
pending setup intentsubscription.pending_setup_intentYou can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).dimension · stringDimensions
schedulesubscription.scheduleThe schedule attached to the subscriptiondimension · stringDimensions
statussubscription.statusPossible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials/free-trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.dimension · stringDimensions
status detailssubscription.status_detailsProperty status_details on the Stripe subscription object.dimension · stringDimensions
test clocksubscription.test_clockID of the test clock this subscription belongs to.dimension · stringDimensions
transfer datasubscription.transfer_dataThe account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.dimension · stringDimensions
trial endsubscription.trial_endIf the subscription has a trial, the end of that trial.dimension · integerDimensions
trial settingssubscription.trial_settingsSettings related to subscription trials.dimension · stringDimensions
trial startsubscription.trial_startIf the subscription has a trial, the beginning of that trial.dimension · integerDimensions
applicationinvoice.applicationID of the Connect Application that created the invoice.dimension · stringDimensions
attemptedinvoice.attemptedWhether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.dimension · booleanDimensions
auto advanceinvoice.auto_advanceControls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.dimension · booleanDimensions
automatic taxinvoice.automatic_taxProperty automatic_tax on the Stripe invoice object.dimension · stringDimensions
automatically finalizes atinvoice.automatically_finalizes_atThe time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.dimension · integerDimensions
billing reasoninvoice.billing_reasonIndicates the reason why the invoice was created. * `manual`: Unrelated to a subscription, for example, created via the invoice editor. * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * `subscription_create`: A new subscription was created. * `subscription_cycle`: A subscription advanced into a new period. * `subscription_threshold`: A subscription reached a billing threshold. * `subscription_update`: A subscription was updated. * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription.dimension · stringDimensions
collection methodinvoice.collection_methodEither `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.dimension · stringDimensions
confirmation secretinvoice.confirmation_secretThe confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.dimension · stringDimensions
createdinvoice.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todayinvoice.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringDimensions
custom fieldsinvoice.custom_fieldsCustom fields displayed on the invoice.dimension · arrayDimensions
customerinvoice.customerThe ID of the customer to bill.dimension · stringDimensions
customer addressinvoice.customer_addressThe customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer emailinvoice.customer_emailThe customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer nameinvoice.customer_nameThe customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer phoneinvoice.customer_phoneThe customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer shippinginvoice.customer_shippingThe customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer tax exemptinvoice.customer_tax_exemptThe customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.dimension · stringDimensions
customer tax idsinvoice.customer_tax_idsThe customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.dimension · arrayDimensions
default payment methodinvoice.default_payment_methodID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.dimension · stringDimensions
default tax ratesinvoice.default_tax_ratesThe tax rates applied to this invoice, if any.dimension · arrayDimensions
descriptioninvoice.descriptionAn arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.dimension · stringDimensions
effective atinvoice.effective_atThe date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.dimension · integerDimensions
ending balanceinvoice.ending_balanceEnding customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.dimension · integerDimensions
footerinvoice.footerFooter displayed on the invoice.dimension · stringDimensions
from invoiceinvoice.from_invoiceDetails of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.dimension · stringDimensions
idinvoice.idUnique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.dimension · stringDimensions
invoice pdfinvoice.invoice_pdfThe link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.dimension · stringDimensions
issuerinvoice.issuerProperty issuer on the Stripe invoice object.dimension · stringDimensions
last finalization errorinvoice.last_finalization_errorThe error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.dimension · stringDimensions
latest revisioninvoice.latest_revisionThe ID of the most recent non-draft revision of this invoicedimension · stringDimensions
linesinvoice.linesThe individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.dimension · objectDimensions
livemodeinvoice.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
metadatainvoice.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectDimensions
next payment attemptinvoice.next_payment_attemptThe time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.dimension · integerDimensions
numberinvoice.numberA unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.dimension · stringDimensions
objectinvoice.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
on behalf ofinvoice.on_behalf_ofThe account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.dimension · stringDimensions
parentinvoice.parentThe parent that generated this invoicedimension · stringDimensions
payment settingsinvoice.payment_settingsProperty payment_settings on the Stripe invoice object.dimension · stringDimensions
paymentsinvoice.paymentsPayments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.dimension · objectDimensions
period endinvoice.period_endThe latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.dimension · integerDimensions
period startinvoice.period_startThe earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.dimension · integerDimensions
receipt numberinvoice.receipt_numberThis is the transaction number that appears on email receipts sent for this invoice.dimension · stringDimensions
renderinginvoice.renderingThe rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.dimension · stringDimensions
shipping detailsinvoice.shipping_detailsShipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.dimension · stringDimensions
starting balanceinvoice.starting_balanceStarting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.dimension · integerDimensions
statement descriptorinvoice.statement_descriptorExtra information about an invoice for the customer's credit card statement.dimension · stringDimensions
statusinvoice.statusThe status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)dimension · stringDimensions
status detailsinvoice.status_detailsProperty status_details on the Stripe invoice object.dimension · stringDimensions
status transitionsinvoice.status_transitionsProperty status_transitions on the Stripe invoice object.dimension · stringDimensions
test clockinvoice.test_clockID of the test clock this invoice belongs to.dimension · stringDimensions
threshold reasoninvoice.threshold_reasonProperty threshold_reason on the Stripe invoice object.dimension · stringDimensions
automaticpayout.automaticReturns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).dimension · booleanDimensions
createdpayout.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todaypayout.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringDimensions
descriptionpayout.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.dimension · stringDimensions
destinationpayout.destinationID of the bank account or card the payout is sent to.dimension · stringDimensions
failure codepayout.failure_codeError code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures).dimension · stringDimensions
failure messagepayout.failure_messageMessage that provides the reason for a payout failure, if available.dimension · stringDimensions
idpayout.idUnique identifier for the object.dimension · stringDimensions
livemodepayout.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
metadatapayout.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectDimensions
methodpayout.methodThe method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).dimension · stringDimensions
objectpayout.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
original payoutpayout.original_payoutIf the payout reverses another, this is the ID of the original payout.dimension · stringDimensions
payout methodpayout.payout_methodID of the v2 FinancialAccount the funds are sent to.dimension · stringDimensions
reconciliation statuspayout.reconciliation_statusIf `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.dimension · stringDimensions
reversed bypayout.reversed_byIf the payout reverses, this is the ID of the payout that reverses this payout.dimension · stringDimensions
statement descriptorpayout.statement_descriptorExtra information about a payout that displays on the user's bank statement.dimension · stringDimensions
statuspayout.statusCurrent status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.dimension · stringDimensions
trace idpayout.trace_idA value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.dimension · stringDimensions
typepayout.typeCan be `bank_account` or `card`.dimension · stringDimensions
allowed payment method typespayment_intent.allowed_payment_method_typesThe list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the `payment_method_types` field of the response, based on the other PaymentIntent parameters, such as `currency`, `amount`, and `customer`.dimension · arrayDimensions
applicationpayment_intent.applicationID of the Connect application that created the PaymentIntent.dimension · stringDimensions
automatic payment methodspayment_intent.automatic_payment_methodsSettings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)dimension · stringDimensions
canceled atpayment_intent.canceled_atPopulated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.dimension · integerDimensions
cancellation reasonpayment_intent.cancellation_reasonReason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).dimension · stringDimensions
capture methodpayment_intent.capture_methodControls when the funds will be captured from the customer's account.dimension · stringDimensions
client secretpayment_intent.client_secretThe client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.dimension · stringDimensions
confirmation methodpayment_intent.confirmation_methodDescribes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.dimension · stringDimensions
createdpayment_intent.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerDimensions
currency · Synced todaypayment_intent.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringDimensions
customerpayment_intent.customerID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.dimension · stringDimensions
descriptionpayment_intent.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.dimension · stringDimensions
excluded payment method typespayment_intent.excluded_payment_method_typesThe list of payment method types to exclude from use with this payment.dimension · arrayDimensions
hookspayment_intent.hooksProperty hooks on the Stripe payment_intent object.dimension · stringDimensions
idpayment_intent.idUnique identifier for the object.dimension · stringDimensions
last payment errorpayment_intent.last_payment_errorThe payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.dimension · stringDimensions
latest chargepayment_intent.latest_chargeID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.dimension · stringDimensions
livemodepayment_intent.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanDimensions
managed paymentspayment_intent.managed_paymentsSettings for Managed Payments.dimension · stringDimensions
metadatapayment_intent.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).dimension · objectDimensions
next actionpayment_intent.next_actionIf present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.dimension · stringDimensions
objectpayment_intent.objectString representing the object's type. Objects of the same type share the same value.dimension · stringDimensions
on behalf ofpayment_intent.on_behalf_ofYou can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details.dimension · stringDimensions
payment detailspayment_intent.payment_detailsProperty payment_details on the Stripe payment_intent object.dimension · stringDimensions
payment methodpayment_intent.payment_methodID of the payment method used in this PaymentIntent.dimension · stringDimensions
payment method configuration detailspayment_intent.payment_method_configuration_detailsInformation about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent.dimension · stringDimensions
payment method optionspayment_intent.payment_method_optionsPayment-method-specific configuration for this PaymentIntent.dimension · stringDimensions
payment method typespayment_intent.payment_method_typesThe list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).dimension · arrayDimensions
payment recordpayment_intent.payment_recordID of the [Payment Record object](https://docs.stripe.com/api/payment-record) created by this PaymentIntent.dimension · stringDimensions
processingpayment_intent.processingIf present, this property tells you about the processing state of the payment.dimension · stringDimensions
receipt emailpayment_intent.receipt_emailEmail address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).dimension · stringDimensions
setup future usagepayment_intent.setup_future_usageIndicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).dimension · stringDimensions
shippingpayment_intent.shippingShipping information for this PaymentIntent.dimension · stringDimensions
statement descriptorpayment_intent.statement_descriptorText that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.dimension · stringDimensions
statement descriptor suffixpayment_intent.statement_descriptor_suffixProvides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.dimension · stringDimensions
statuspayment_intent.statusStatus of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses).dimension · stringDimensions
transfer datapayment_intent.transfer_dataThe data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).dimension · stringDimensions
transfer grouppayment_intent.transfer_groupA string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers).dimension · stringDimensions

Ecommerce

NameAPI fieldDescriptionTypeGroupCross-channel
amountcharge.amountAmount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).metric · integerEcommerce
amount capturedcharge.amount_capturedAmount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).metric · integerEcommerce
amount refundedcharge.amount_refundedAmount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).metric · integerEcommerce
application feecharge.application_feeThe application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.metric · stringEcommerce
application fee amountcharge.application_fee_amountThe amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.metric · integerEcommerce
balance transactioncharge.balance_transactionID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).dimension · stringEcommerce
failure balance transactioncharge.failure_balance_transactionID of the balance transaction that describes the reversal of the balance on your account due to payment failure.dimension · stringEcommerce
refundedcharge.refundedWhether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.dimension · booleanEcommerce
refunds · Synced todaycharge.refundsA list of refunds that have been applied to the charge.dimension · objectEcommerce
application fee percentsubscription.application_fee_percentA 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 application owner's Stripe account.metric · numberEcommerce
itemssubscription.itemsList of subscription items, each with an attached price.dimension · objectEcommerce
next pending invoice item invoicesubscription.next_pending_invoice_item_invoiceSpecifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.dimension · integerEcommerce
pending invoice item intervalsubscription.pending_invoice_item_intervalSpecifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.dimension · stringEcommerce
amount dueinvoice.amount_dueFinal amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.metric · integerEcommerce
amount overpaidinvoice.amount_overpaidAmount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.metric · integerEcommerce
amount paidinvoice.amount_paidThe amount, in cents (or local equivalent), that was paid.metric · integerEcommerce
amount paid off stripeinvoice.amount_paid_off_stripeAmount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.metric · integerEcommerce
amount remaininginvoice.amount_remainingThe difference between amount_due and amount_paid, in cents (or local equivalent).metric · integerEcommerce
amount shippinginvoice.amount_shippingThis is the sum of all the shipping amounts.metric · integerEcommerce
pre payment credit notes amountinvoice.pre_payment_credit_notes_amountTotal amount of all pre-payment credit notes issued for this invoice.metric · integerEcommerce
total discount amountsinvoice.total_discount_amountsThe aggregate amounts calculated per discount across all line items.metric · arrayEcommerce
total pretax credit amountsinvoice.total_pretax_credit_amountsContains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.metric · arrayEcommerce
amountpayout.amountThe amount (in cents (or local equivalent)) that transfers to your bank account or debit card.metric · integerEcommerce
application feepayout.application_feeThe application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.metric · stringEcommerce
application fee amountpayout.application_fee_amountThe amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.metric · integerEcommerce
balance transactionpayout.balance_transactionID of the balance transaction that describes the impact of this payout on your account balance.dimension · stringEcommerce
failure balance transactionpayout.failure_balance_transactionIf the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.dimension · stringEcommerce
amountpayment_intent.amountAmount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).metric · integerEcommerce
amount capturablepayment_intent.amount_capturableAmount that can be captured from this PaymentIntent.metric · integerEcommerce
amount detailspayment_intent.amount_detailsProperty amount_details on the Stripe payment_intent object.metric · stringEcommerce
amount receivedpayment_intent.amount_receivedAmount that this PaymentIntent collects.metric · integerEcommerce
application fee amountpayment_intent.application_fee_amountThe amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).metric · integerEcommerce
activeproduct.activeWhether the product is currently available for purchase.dimension · booleanEcommerce
createdproduct.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerEcommerce
default priceproduct.default_priceThe ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.dimension · stringEcommerce
descriptionproduct.descriptionThe product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.dimension · stringEcommerce
idproduct.idUnique identifier for the object.dimension · stringEcommerce
imagesproduct.imagesA list of up to 8 URLs of images for this product, meant to be displayable to the customer.dimension · arrayEcommerce
livemodeproduct.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanEcommerce
marketing featuresproduct.marketing_featuresA list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).dimension · arrayEcommerce
metadataproduct.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectEcommerce
nameproduct.nameThe product's name, meant to be displayable to the customer.dimension · stringEcommerce
objectproduct.objectString representing the object's type. Objects of the same type share the same value.dimension · stringEcommerce
package dimensionsproduct.package_dimensionsThe dimensions of this product for shipping purposes.dimension · stringEcommerce
shippableproduct.shippableWhether this product is shipped (i.e., physical goods).dimension · booleanEcommerce
statement descriptorproduct.statement_descriptorExtra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.dimension · stringEcommerce
tax codeproduct.tax_codeA [tax code](https://docs.stripe.com/tax/tax-categories) ID.dimension · stringEcommerce
tax detailsproduct.tax_detailsTax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.dimension · stringEcommerce
unit labelproduct.unit_labelA label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.dimension · stringEcommerce
activeprice.activeWhether the price can be used for new purchases.dimension · booleanEcommerce
billing schemeprice.billing_schemeDescribes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.dimension · stringEcommerce
createdprice.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerEcommerce
currency · Synced todayprice.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringEcommerce
currency optionsprice.currency_optionsPrices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).dimension · objectEcommerce
custom unit amountprice.custom_unit_amountWhen set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.metric · stringEcommerce
idprice.idUnique identifier for the object.dimension · stringEcommerce
livemodeprice.livemodeIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.dimension · booleanEcommerce
lookup keyprice.lookup_keyA lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.dimension · stringEcommerce
metadataprice.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectEcommerce
nicknameprice.nicknameA brief description of the price, hidden from customers.dimension · stringEcommerce
objectprice.objectString representing the object's type. Objects of the same type share the same value.dimension · stringEcommerce
product · Synced todayprice.productThe ID of the product this price is associated with.dimension · stringEcommerce
recurringprice.recurringThe recurring components of a price such as `interval` and `usage_type`.dimension · stringEcommerce
tax behaviorprice.tax_behaviorOnly required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.dimension · stringEcommerce
tiersprice.tiersEach element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.dimension · arrayEcommerce
tiers modeprice.tiers_modeDefines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.dimension · stringEcommerce
transform quantityprice.transform_quantityApply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.metric · stringEcommerce
typeprice.typeOne of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.dimension · stringEcommerce
unit amountprice.unit_amountThe unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.metric · integerEcommerce
unit amount decimalprice.unit_amount_decimalThe unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.metric · stringEcommerce
amountrefund.amountAmount, in cents (or local equivalent).metric · integerEcommerce
balance transactionrefund.balance_transactionBalance transaction that describes the impact on your account balance.dimension · stringEcommerce
chargerefund.chargeID of the charge that's refunded.dimension · stringEcommerce
createdrefund.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerEcommerce
currency · Synced todayrefund.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringEcommerce
customerrefund.customerID of the customer of this refund.dimension · stringEcommerce
customer accountrefund.customer_accountID of the account of this refund.metric · stringEcommerce
descriptionrefund.descriptionAn arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).dimension · stringEcommerce
destination detailsrefund.destination_detailsProperty destination_details on the Stripe refund object.dimension · stringEcommerce
failure balance transactionrefund.failure_balance_transactionAfter the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.dimension · stringEcommerce
failure reasonrefund.failure_reasonProvides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.dimension · stringEcommerce
idrefund.idUnique identifier for the object.dimension · stringEcommerce
instructions emailrefund.instructions_emailFor payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.dimension · stringEcommerce
metadatarefund.metadataSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.dimension · objectEcommerce
next actionrefund.next_actionProperty next_action on the Stripe refund object.dimension · stringEcommerce
objectrefund.objectString representing the object's type. Objects of the same type share the same value.dimension · stringEcommerce
payment intentrefund.payment_intentID of the PaymentIntent that's refunded.dimension · stringEcommerce
payment methodrefund.payment_methodID of the payment method associated with this refund.dimension · stringEcommerce
pending reasonrefund.pending_reasonProvides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.dimension · stringEcommerce
presentment detailsrefund.presentment_detailsProperty presentment_details on the Stripe refund object.dimension · stringEcommerce
reasonrefund.reasonReason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).dimension · stringEcommerce
receipt numberrefund.receipt_numberThis is the transaction number that appears on email receipts sent for this refund.dimension · stringEcommerce
statusrefund.statusStatus of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds).dimension · stringEcommerce
transfer reversalrefund.transfer_reversalThis refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.dimension · stringEcommerce
amountbalance_transaction.amountGross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.metric · integerEcommerce
available onbalance_transaction.available_onThe date that the transaction's net funds become available in the Stripe balance.dimension · integerEcommerce
balance typebalance_transaction.balance_typeThe balance that this transaction impacts.dimension · stringEcommerce
createdbalance_transaction.createdTime at which the object was created. Measured in seconds since the Unix epoch.dimension · integerEcommerce
currency · Synced todaybalance_transaction.currencyThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).dimension · stringEcommerce
descriptionbalance_transaction.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.dimension · stringEcommerce
exchange ratebalance_transaction.exchange_rateIf applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.dimension · numberEcommerce
feebalance_transaction.feeFees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.metric · integerEcommerce
fee detailsbalance_transaction.fee_detailsDetailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.metric · arrayEcommerce
idbalance_transaction.idUnique identifier for the object.dimension · stringEcommerce
netbalance_transaction.netNet impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`dimension · integerEcommerce
objectbalance_transaction.objectString representing the object's type. Objects of the same type share the same value.dimension · stringEcommerce
reporting categorybalance_transaction.reporting_categoryLearn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.dimension · stringEcommerce
statusbalance_transaction.statusThe transaction's net funds status in the Stripe balance, which are either `available` or `pending`.dimension · stringEcommerce
typebalance_transaction.typeTransaction type: `tax_fund`, `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_dispute_provisional_credit`, `issuing_dispute_provisional_credit_reversal`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.dimension · stringEcommerce

Engagement

NameAPI fieldDescriptionTypeGroupCross-channel
presentment detailscharge.presentment_detailsProperty presentment_details on the Stripe charge object.dimension · stringEngagement
presentment detailssubscription.presentment_detailsProperty presentment_details on the Stripe subscription object.dimension · stringEngagement
webhooks delivered atinvoice.webhooks_delivered_atInvoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.dimension · integerEngagement
presentment detailspayment_intent.presentment_detailsProperty presentment_details on the Stripe payment_intent object.dimension · stringEngagement

Geography

NameAPI fieldDescriptionTypeGroupCross-channel
account countryinvoice.account_countryThe country of the business associated with this invoice, most often the business creating the invoice.metric · stringGeography

Metrics

NameAPI fieldDescriptionTypeGroupCross-channel
customer accountcustomer.customer_accountThe ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.metric · stringMetrics
discountcustomer.discountDescribes the current discount active on the customer, if there is one.metric · stringMetrics
customer accountsubscription.customer_accountID of the account representing the customer who owns the subscription.metric · stringMetrics
discountssubscription.discountsThe discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.metric · arrayMetrics
account nameinvoice.account_nameThe public name of the business associated with this invoice, most often the business creating the invoice.metric · stringMetrics
account tax idsinvoice.account_tax_idsThe account tax IDs associated with the invoice. Only editable when the invoice is a draft.metric · arrayMetrics
attempt countinvoice.attempt_countNumber of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.metric · integerMetrics
customer accountinvoice.customer_accountThe ID of the account representing the customer to bill.metric · stringMetrics
discountsinvoice.discountsThe discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.metric · arrayMetrics
subtotalinvoice.subtotalTotal of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporatedmetric · integerMetrics
subtotal excluding taxinvoice.subtotal_excluding_taxThe integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporatedmetric · integerMetrics
totalinvoice.totalTotal after discounts and taxes.metric · integerMetrics
total excluding taxinvoice.total_excluding_taxThe integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.metric · integerMetrics
total taxesinvoice.total_taxesThe aggregate tax information of all line items.metric · arrayMetrics
customer accountpayment_intent.customer_accountID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.metric · stringMetrics

Technology

NameAPI fieldDescriptionTypeGroupCross-channel
hosted invoice urlinvoice.hosted_invoice_urlThe URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.dimension · stringTechnology
post payment credit notes amountinvoice.post_payment_credit_notes_amountTotal amount of all post-payment credit notes issued for this invoice.metric · integerTechnology
shipping costinvoice.shipping_costThe details of the cost of shipping, including the ShippingRate applied on the invoice.dimension · stringTechnology

Time

NameAPI fieldDescriptionTypeGroupCross-channel
days until duesubscription.days_until_dueNumber of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.dimension · integerTime
pending updatesubscription.pending_updateIf specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.dimension · stringTime
start datesubscription.start_dateDate when the subscription was first created. The date might differ from the `created` date due to backdating.dimension · integerTime
due dateinvoice.due_dateThe date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.dimension · integerTime
arrival datepayout.arrival_dateDate that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.dimension · integerTime
updatedproduct.updatedTime at which the object was last updated. Measured in seconds since the Unix epoch.dimension · integerTime

Traffic

NameAPI fieldDescriptionTypeGroupCross-channel
source transfercharge.source_transferThe transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.dimension · stringTraffic
default sourcecustomer.default_sourceID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.dimension · stringTraffic
preferred localescustomer.preferred_localesThe customer's preferred locales (languages), ordered by preference.dimension · arrayTraffic
sourcescustomer.sourcesThe customer's payment sources, if any.dimension · objectTraffic
default sourcesubscription.default_sourceID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).dimension · stringTraffic
default sourceinvoice.default_sourceID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.dimension · stringTraffic
source typepayout.source_typeThe source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.dimension · stringTraffic
source transfer reversalrefund.source_transfer_reversalThe transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.dimension · stringTraffic
sourcebalance_transaction.sourceThis transaction relates to the Stripe object.dimension · stringTraffic

Cross-channel metrics

Spend, Impressions, Clicks, Conversions, and Revenue roll up on All channels when a field maps to them. ROAS is revenue divided by spend. CPA is spend divided by conversions. The Cross-channel column above shows the match.

Example reports

Charges

A Stripe report of charges.

Destinations

Stripe to Looker Studio

Charts that read the Google Sheet this integration keeps up to date.

Included on every plan. Looker reads the sheet. There is no separate Looker install.

Stripe to AI and MCP

Ask a question in plain English, or let another tool read the report through MCP.

Included on every plan. An AI key is optional.

Stripe to the API

Download the rows as CSV or JSON from the report.

Included on every plan.

Stripe to Google Drive

CSV, Excel, and an optional JSON file in a Drive folder you pick. Each client gets a Datapipe folder. The file can overwrite itself or keep the date in the name.

Included on every plan. Drive API v3 with the drive.file scope only. Enable the Google Drive API in the GCP project. Hourly, daily, or weekly.

How to connect

  1. Create a free account.
  2. Open Connections and find this source.
  3. Paste the key the page asks for. The steps next to the box say where to copy it.
  4. Open the sample report. It switches to your numbers after the key is accepted.

Refresh by plan

PlanRefreshBigQueryPrice
FreeDailyNo$0/mo
StarterDailyNo$15/mo
ProHourlyYes$49/mo
Agency15 minutesYes$149/mo

FAQ

Is the Stripe connection live?

Live with Stripe sign-in or a restricted key you paste. Sign-in uses read_write, because read_only is only for Stripe Apps. The key needs read permission on each resource, such as charges and customers.

Do I have to talk to sales?

No. Create an account, connect the source, and the first report is on Home. Sample numbers stay available when a key is missing.

How often do the numbers refresh?

Free and Starter refresh daily. Pro refreshes hourly. Agency refreshes every 15 minutes on up to 50 accounts and hourly on the rest. We keep the history for you: 90 days on Free, and for as long as you subscribe on paid plans. No warehouse to set up.

Which fields are synced today?

The list marks Synced today on the fields the current connector pulls. The rest of the list is what the platform publishes, so you can see it before you sign up.

Create an account

Related integrations

Shopify · WooCommerce