Stripe metrics and dimensions

62 metrics206 dimensions

Search fields

ACCOUNT

account_id

Field label	Account ID
Description	Unique ID of the account
Field type	dimension
Data type	string.text.value

account_name

Field label	Account name
Description	Display name of the account
Field type	dimension
Data type	string.text.value

APPLICATION

app_id

Field label	Application ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

APPLICATION FEE

app_fee_id

Field label	Application fee ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

app_fee_currency

Field label	Fee currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

app_fee_refunded

Field label	Fee is refunded
Description	Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false
Field type	dimension
Data type	bool

app_fee_orig_transaction

Field label	Originating transaction ID
Description	ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destinationparameter
Field type	dimension
Data type	string.text.value

app_fee_amount

Field label	Fee amount
Description	Amount earned, in cents
Field type	metric
Data type	float.currency.value

app_fee_amount_refunded

Field label	Fee refunded amount
Description	Amount, in cents
Field type	metric
Data type	float.currency.value

BALANCE

balance_type

Field label	Balance type
Description	String representing the object's type. Objects of the same type share the same value
Field type	dimension
Data type	string.text.value

balance_currency

Field label	Balance currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

balance_amount

Field label	Balance amount
Description	Gross amount of the transaction, in cents
Field type	metric
Data type	float.currency.value

balance_source_card

Field label	Card balance
Description	Current balance, if any, being stored on the account's card
Field type	metric
Data type	float.currency.value

balance_source_bank

Field label	Bank account balance
Description	Current balance, if any, being stored on the customer's account. If negative, the customer has credit to apply to the next invoice. If positive, the customer has an amount owed that will be added to the next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. Note that the balance does not include unpaid invoices
Field type	metric
Data type	float.currency.value

balance_source_bitcoin

Field label	Bitcoin receiver balance
Description	Current balance, if any, being stored on the account in bitcoin
Field type	metric
Data type	float.currency.value

BALANCE TRANSACTION

transaction_id

Field label	Transaction ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

transaction_type

Field label	Transaction type
Description	Transaction type: adjustment, advance, advance_funding, application_fee, application_fee_refund, charge, connect_collection_transfer, issuing_authorization_hold, issuing_authorization_release, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund
Field type	dimension
Data type	string.text.value

transaction_status

Field label	Transaction status
Description	If the transaction's net funds are available in the Stripe balance yet. Either available or pending
Field type	dimension
Data type	string.text.value

transaction_available_date

Field label	Transaction available date
Description	The date the transaction's net funds will become available in the Stripe balance
Field type	dimension
Data type	string.time.date

transaction_currency

Field label	Transaction currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

transaction_description

Field label	Transaction description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

transaction_fee_type

Field label	First fee type
Description	Type of the fee, one of: application_fee, stripe_fee or tax
Field type	dimension
Data type	string.text.value

transaction_fee_description

Field label	First fee description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

transaction_amount

Field label	Transaction amount
Description	Gross amount of the transaction, in cents
Field type	metric
Data type	float.currency.value

transaction_net

Field label	Transaction net
Description	Net amount of the transaction, in cents
Field type	metric
Data type	float.currency.value

transaction_fee

Field label	Transaction fee
Description	Fees (in cents) paid for this transaction
Field type	metric
Data type	float.currency.value

transaction_refund

Field label	Transaction refund
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transaction_charge_percent

Field label	Transaction charge %
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.number.percentage

transaction_fee_percent

Field label	Transaction fee %
Description	Fees (in cents) paid for this transaction
Field type	metric
Data type	float.number.percentage

transaction_refund_percent

Field label	Transaction refund %
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.number.percentage

transaction_average_amount

Field label	Average amount
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transaction_average_net

Field label	Average net
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transaction_average_charge

Field label	Average charge
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transaction_average_refund

Field label	Average refund
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transaction_charge_amount

Field label	Charge amount
Description	Amount of the fee, in cents
Field type	metric
Data type	float.currency.value

transaction_charge_net

Field label	Charge net
Description	Net amount of the transaction, in cents
Field type	metric
Data type	float.currency.value

transaction_charge_fee

Field label	Charge fee
Description	Fees (in cents) paid for this transaction
Field type	metric
Data type	float.currency.value

charge_fee_percent

Field label	Charge fee %
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.number.percentage

charge_average_amount

Field label	Charge average amount
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

charge_average_net

Field label	Charge average net
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

charge_average_fee

Field label	Charge average fee
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

transactions

Field label	Transactions
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	int.number.value

transaction_charges

Field label	Charge transactions
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	int.number.value

transaction_fees

Field label	Fee transactions
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	int.number.value

transaction_refunds

Field label	Refund transactions
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	int.number.value

CHARGE

charge_id

Field label	Charge ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

charge_type

Field label	Charge type
Description	String representing the object's type. Objects of the same type share the same value
Field type	dimension
Data type	string.text.value

charge_status

Field label	Charge status
Description	The status of the payment is either succeeded, pending, or failed
Field type	dimension
Data type	string.text.value

charge_currency

Field label	Charge currency
Description	The status of the payment is either succeeded, pending, or failed
Field type	dimension
Data type	string.currency.code

charge_description

Field label	Charge description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

charge_on_behalf_of

Field label	Charge on behalf of
Description	The account (if any) the charge was made on behalf of without triggering an automatic transfer
Field type	dimension
Data type	string.text.value

charge_captured

Field label	Charge is captured
Description	If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured
Field type	dimension
Data type	bool

charge_paid

Field label	Charge is paid
Description	true if the charge succeeded, or was successfully authorized for later capture
Field type	dimension
Data type	bool

charge_refunded

Field label	Charge is refunded
Description	Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false
Field type	dimension
Data type	bool

charge_statement

Field label	Charge statement descriptor
Description	Extra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter
Field type	dimension
Data type	string.text.value

charge_failure_code

Field label	Charge failure code
Description	Error code explaining reason for charge failure if available
Field type	dimension
Data type	string.text.value

charge_failure_message

Field label	Charge failure message
Description	Message to user further explaining reason for charge failure if available
Field type	dimension
Data type	string.text.value

charge_receipt_email

Field label	Charge receipt email
Description	This is the email address that the receipt for this charge was sent to
Field type	dimension
Data type	string.text.json

charge_receipt_number

Field label	Charge receipt number
Description	This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent
Field type	dimension
Data type	string.text.value

charge_transfer_group

Field label	Charge transfer group
Description	A string that identifies this transaction as part of a group. See the Connect documentation for details
Field type	dimension
Data type	string.text.value

charge_metadata

Field label	Charge metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

charge_outcome_type

Field label	Outcome type
Description	Possible values are authorized, manual_review, issuer_declined, blocked, and invalid
Field type	dimension
Data type	string.text.value

charge_outcome_network_status

Field label	Outcome network status
Description	Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. The value reversed_after_approval indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement
Field type	dimension
Data type	string.text.value

charge_outcome_risk_level

Field label	Outcome risk level
Description	Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are normal, elevated, highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown
Field type	dimension
Data type	string.text.value

charge_outcome_reason

Field label	Outcome reason
Description	An enumerated value providing a more detailed explanation of the outcome's type. Charges blocked by Radar's default block rule have the value highest_risk_level. Charges placed in review by Radar's default review rule have the value elevated_risk_level. Charges authorized, blocked, or placed in review by custom rules have the value rule
Field type	dimension
Data type	string.text.value

charge_outcome_seller_message

Field label	Outcome seller message
Description	A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer
Field type	dimension
Data type	string.text.value

charge_fraud_user_report

Field label	Fraud user report
Description	Assessments reported by you. If set, possible values of are safe and fraudulent
Field type	dimension
Data type	string.text.value

charge_fraud_details

Field label	Fraud user details
Description	Information on fraud assessments for the charge
Field type	dimension
Data type	string.text.json

charge_amount

Field label	Charge amount
Description	A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency) representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency
Field type	metric
Data type	float.currency.value

charge_amount_refunded

Field label	Charge refunded amount
Description	Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued)
Field type	metric
Data type	float.currency.value

charge_app_fee

Field label	Charge application fee
Description	The application fee (if any) for the charge
Field type	metric
Data type	float.currency.value

COUPON

coupon_id

Field label	Coupon ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

coupon_duration

Field label	Coupon duration
Description	One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount
Field type	dimension
Data type	string.text.value

coupon_percent_off

Field label	Coupon percent off
Description	Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead
Field type	dimension
Data type	int.number.percentage

coupon_redeem_by

Field label	Coupon redeem by date
Description	Date after which the coupon can no longer be redeemed
Field type	dimension
Data type	string.time.date

coupon_valid

Field label	Coupon is valid
Description	Taking account of the above properties, whether this coupon can still be applied to a customer
Field type	dimension
Data type	bool

coupon_metadata

Field label	Coupon metadata
Description	A set of key-value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format
Field type	dimension
Data type	string.text.json

coupon_duration_in_months

Field label	Duration in months
Description	If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once
Field type	metric
Data type	int.number.value

coupon_amount_off

Field label	Amount off
Description	Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer
Field type	metric
Data type	float.currency.value

coupon_max_redeems

Field label	Max redeems
Description	Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid
Field type	metric
Data type	int.number.value

coupon_times_redeemed

Field label	Times redeemed
Description	Number of times this coupon has been applied to a customer
Field type	metric
Data type	int.number.value

CUSTOMER

customer_id

Field label	Customer ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

customer_currency

Field label	Customer currency
Description	Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes
Field type	dimension
Data type	string.currency.code

customer_email

Field label	Customer email
Description	The customer's email address
Field type	dimension
Data type	string.text.email

customer_vat_id

Field label	Customer VAT ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

customer_delinquent

Field label	Customer is delinquent
Description	When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date
Field type	dimension
Data type	bool

customer_created_date

Field label	Customer created date
Description	Date when the customer was created
Field type	dimension
Data type	string.time.date

customer_created_datetime

Field label	Customer created datetime
Description	Timestamp when the customer was created
Field type	dimension
Data type	string.time.datetime

customer_account_balance

Field label	Customer Balance
Description	An integer amount that represents the account balance for your customer. Account balances only affect invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice
Field type	metric
Data type	float.currency.value

DATASOURCE

dataSourceName

Field label	Data source
Description	The name of the source for this data, as listed on supermetrics.com/docs
Field type	dimension
Data type	string.text.value
Destinations	API, Data warehouse

system_metadata.data_source_logins

Field label	Data source logins
Description	The data source login accounts that were used to authenticate against the data source
Field type	dimension
Data type	string.text.json

system_metadata.data_source_login_owners

Field label	Data source login owners
Description	The Supermetrics users that created the data source login connections
Field type	dimension
Data type	string.text.json

DEPRECATED

invoice_paid

Field label	Invoice is paid
Field type	dimension
Data type	bool
🚫 Deprecated	Deprecated on 2021-08-12

invoice_forgiven

Field label	Invoice is forgiven
Field type	dimension
Data type	bool
🚫 Deprecated	Deprecated on 2021-08-12

invoice_closed

Field label	Invoice is closed
Field type	dimension
Data type	bool
🚫 Deprecated	Deprecated on 2021-08-12

DESTINATION ACCOUNT

destination_id

Field label	Destination ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

DISPUTE

dispute_id

Field label	Dispute ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

dispute_status

Field label	Dispute status
Description	Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost
Field type	dimension
Data type	string.text.value

dispute_reason

Field label	Dispute reason
Description	Reason given by cardholder for dispute. Possible values are duplicate, fraudulent, subscription_canceled, product_unacceptable, product_not_received, unrecognized, credit_not_processed, general, incorrect_account_details, insufficient_funds, bank_cannot_process, debit_not_authorized, or customer_initiated
Field type	dimension
Data type	string.text.value

dispute_currency

Field label	Dispute currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

dispute_charge_refundable

Field label	Dispute charge is refundable
Description	If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute
Field type	dimension
Data type	bool

dispute_metadata

Field label	Dispute metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

dispute_has_evidence

Field label	Has evidence
Description	Whether evidence has been staged for this dispute
Field type	dimension
Data type	bool

dispute_evidence_due_by

Field label	Evidence due by date
Description	Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute
Field type	dimension
Data type	string.time.date

dispute_evidence_past_due

Field label	Evidence is past due
Description	Whether the last evidence submission was submitted past the due date. Defaults to false if no evidence submissions have occurred. If true, then delivery of the latest evidence is not guaranteed
Field type	dimension
Data type	bool

dispute_amount

Field label	Dispute amount
Description	Disputed amount. Usually the amount of the disputed_transaction, but can differ (usually because of currency fluctuation or because only part of the order is disputed)
Field type	metric
Data type	float.currency.value

dispute_evidence_submissions

Field label	Evidence submissions
Description	Evidence related to the dispute. This hash will contain exactly one non-null value, containing an evidence object that matches its reason
Field type	metric
Data type	int.number.value

INVOICE

invoice_id

Field label	Invoice ID
Description	The ID of the invoice this invoice item belongs to
Field type	dimension
Data type	string.text.value

invoice_currency

Field label	Invoice currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

invoice_description

Field label	Invoice description
Description	An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard
Field type	dimension
Data type	string.text.value

invoice_period_start

Field label	Invoice period start time
Description	Start of the usage period during which invoice items were added to this invoice
Field type	dimension
Data type	string.time.datetime

invoice_period_end

Field label	Invoice period end time
Description	End of the usage period during which invoice items were added to this invoice
Field type	dimension
Data type	string.time.datetime

invoice_next_payment_attempt

Field label	Invoice next payment attempt
Description	The time at which payment will next be attempted. This value will be null for invoices where billing=send_invoice
Field type	dimension
Data type	string.time.datetime

invoice_status

Field label	Invoice status
Description	The status of the invoice. Can have the values "draft", "open", "paid", "void", and "uncollectible"
Field type	dimension
Data type	string.text.value

invoice_marked_uncollectible_at

Field label	Invoice marked uncollectible
Description	The time that the invoice was marked uncollectible
Field type	dimension
Data type	string.time.datetime

invoice_metadata

Field label	Invoice metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

invoice_receipt_number

Field label	Invoice receipt number
Description	This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent
Field type	dimension
Data type	string.text.value

invoice_statement

Field label	Invoice statement descriptor
Description	Extra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter
Field type	dimension
Data type	string.text.value

invoice_amount_due

Field label	Invoice due amount
Description	Final 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
Field type	metric
Data type	float.currency.value

invoice_total

Field label	Invoice total
Description	Total after discount
Field type	metric
Data type	float.currency.value

invoice_subtotal

Field label	Invoice subtotal
Description	Total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied
Field type	metric
Data type	float.currency.value

invoice_tax_percent

Field label	Invoice tax (%)
Description	This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's tax_percent field, but can be changed before the invoice is paid
Field type	metric
Data type	int.number.percentage

invoice_tax

Field label	Invoice tax
Description	The amount of tax included in the total, calculated from tax_percent and the subtotal. If no tax_percent is defined, this value will be null
Field type	metric
Data type	float.currency.value

invoice_app_fee

Field label	Invoice application fee
Description	The fee in cents that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid
Field type	metric
Data type	float.currency.value

invoice_payment_attempts

Field label	Invoice payment attempts
Description	Number 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
Field type	metric
Data type	int.number.value

invoice_amount_starting_balance

Field label	Starting customer balance
Description	Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance
Field type	metric
Data type	float.currency.value

invoice_amount_ending_balance

Field label	Ending customer balance
Description	Ending 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
Field type	metric
Data type	float.currency.value

INVOICE ITEM

invoice_item_id

Field label	Invoice item ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

invoice_item_currency

Field label	Invoice item currency
Description	Three-letter ISO currency code
Field type	dimension
Data type	string.text.value

invoice_item_description

Field label	Invoice item description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

invoice_item_tax

Field label	Invoice item tax
Description	The amount of tax included for the item, calculated from tax_percent and the subtotal
Field type	metric
Data type	float.currency.value

invoice_item_amount

Field label	Invoice item amount
Description	Amount (in the currency specified) of the invoice item
Field type	metric
Data type	float.currency.value

ORDER

order_id

Field label	Order ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

order_status

Field label	Order status
Description	Current order status. One of created, paid, canceled, fulfilled, or returned
Field type	dimension
Data type	string.text.value

order_currency

Field label	Order currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

order_email

Field label	Order email
Description	The email address of the customer placing the order
Field type	dimension
Data type	string.text.email

order_shipping_method

Field label	Order shipping method
Description	The shipping method to select for fulfilling this order. If specified, must be one of the ids of a shipping method in the shipping_methods
Field type	dimension
Data type	string.text.value

order_paid_time

Field label	Order paid time
Description	Do not use, deprecated by Stripe
Field type	dimension
Data type	string.time.datetime

order_fulfilled_time

Field label	Order fulfilled time
Description	Do not use, deprecated by Stripe
Field type	dimension
Data type	string.time.datetime

order_cancelled_time

Field label	Order cancelled time
Description	Do not use, deprecated by Stripe
Field type	dimension
Data type	string.time.datetime

order_returned_time

Field label	Order returned time
Description	Do not use, deprecated by Stripe
Field type	dimension
Data type	string.time.datetime

order_updated_time

Field label	Order updated time
Description	Do not use, deprecated by Stripe
Field type	dimension
Data type	string.time.datetime

order_metadata

Field label	Order metadata
Description	A set of key-value pairs that you can attach to a product object. It can be useful for storing additional information about the order in a structured format
Field type	dimension
Data type	string.text.json

order_amount

Field label	Order amount
Description	A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order
Field type	metric
Data type	float.currency.value

order_amount_returned

Field label	Order returned amount
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

order_app_fee

Field label	Order application fee
Description	Do not use, deprecated by Stripe
Field type	metric
Data type	float.currency.value

PAYOUT

payout_id

Field label	Payout ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

payout_type

Field label	Payout type
Description	Can be bank_account or card
Field type	dimension
Data type	string.text.value

payout_status

Field label	Payout status
Description	Only return payouts that have the given status: pending, paid, failed, or canceled
Field type	dimension
Data type	string.text.value

payout_currency

Field label	Payout currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

payout_arrival_date

Field label	Payout arrival date
Description	Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays
Field type	dimension
Data type	string.time.date

payout_method

Field label	Payout method
Description	The method used to send this payout, which can be standard or instant
Field type	dimension
Data type	string.text.value

payout_description

Field label	Payout description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

payout_statement

Field label	Payout statement descriptor
Description	Extra information about a payout to be displayed on the user's bank statement
Field type	dimension
Data type	string.text.value

payout_source_type

Field label	Payout source type
Description	The source balance to use for this transfer. One of card, financing, bank_account, or alipay_account. For most users, this will default to card
Field type	dimension
Data type	string.text.value

payout_failure_code

Field label	Payout failure code
Description	Error code explaining reason for payout failure if available
Field type	dimension
Data type	string.text.value

payout_failure_message

Field label	Payout failure message
Description	Message to user further explaining reason for payout failure if available
Field type	dimension
Data type	string.text.value

payout_failure_transaction_id

Field label	Payout failure transaction ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

payout_metadata

Field label	Payout metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

payout_amount

Field label	Payout amount
Description	Amount (in cents) to be transferred to your bank account or debit card
Field type	metric
Data type	float.currency.value

QUERY

system_metadata.query_date_range_start

Field label	Start date
Description	The start date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_date_range_end

Field label	End date
Description	The end date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_timezone

Field label	Timezone
Description	The timezone that is supplied to the query
Field type	dimension
Data type	string.time.timezone

system_metadata.query_filters

Field label	Filters
Description	All filters used in the query
Field type	dimension
Data type	string.text.json

system_metadata.query_date_start

Field label	Start
Description	When the query was started
Field type	dimension
Data type	string.time.datetime

system_metadata.query_date_end

Field label	End
Description	When the query completed
Field type	dimension
Data type	string.time.datetime

system_metadata.query_duration

Field label	Duration
Description	The duration in seconds of the query
Field type	dimension
Data type	int.duration.seconds

system_metadata.query_accounts

Field label	Accounts
Description	A list of accounts of which the data was pulled from
Field type	dimension
Data type	string.text.json

system_metadata.query_excluded_accounts

Field label	Excluded invalid accounts
Description	A list of unavailable accounts excluded from the query due to the "Exclude invalid accounts" setting
Field type	dimension
Data type	string.text.json

REFUND

refund_id

Field label	Refund ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

refund_status

Field label	Refund status
Description	Status of the refund. For credit card refunds, this can be succeeded or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled
Field type	dimension
Data type	string.text.value

refund_currency

Field label	Refund currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

refund_reason

Field label	Refund reason
Description	Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer
Field type	dimension
Data type	string.text.value

refund_receipt_number

Field label	Refund receipt number
Description	This is the transaction number that appears on email receipts sent for this refund
Field type	dimension
Data type	string.text.value

refund_metadata

Field label	Refund metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

refund_amount

Field label	Refund amount
Description	Amount, in cents
Field type	metric
Data type	float.currency.value

REVIEW

review_id

Field label	Review ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

SHIPPING ADDRESS

shipping_carrier

Field label	Shipping carrier
Description	The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas
Field type	dimension
Data type	string.text.value

shipping_tracking_number

Field label	Shipping tracking number
Description	The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas
Field type	dimension
Data type	string.text.value

shipping_recipient_name

Field label	Shipping recipient name
Description	The name of the customer
Field type	dimension
Data type	string.text.value

shipping_recipient_phone

Field label	Shipping recipient phone
Description	The recipient's phone number
Field type	dimension
Data type	string.text.phone

shipping_line_1

Field label	Shipping address line 1
Description	Address line 1 (Street address/PO Box/Company name)
Field type	dimension
Data type	string.geo.street

shipping_line_2

Field label	Shipping address line 2
Description	Address line 2 (Apartment/Suite/Unit/Building)
Field type	dimension
Data type	string.geo.street

shipping_address_zip

Field label	Shipping zip code
Description	ZIP or postal code
Field type	dimension
Data type	string.geo.zip

shipping_address_city

Field label	Shipping city
Description	City/District/Suburb/Town/Village
Field type	dimension
Data type	string.geo.city

shipping_state

Field label	Shipping state
Description	State/County/Province/Region
Field type	dimension
Data type	string.geo.region

shipping_address_country

Field label	Shipping country
Description	Billing address country, if provided when creating card
Field type	dimension
Data type	string.geo.country.twolettercode

SOURCE

source_id

Field label	Source ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

source_type

Field label	Source type
Description	The type of the source. The type is a payment method
Field type	dimension
Data type	string.text.value

source_address_line_1

Field label	Source address line 1
Description	Address line 1 (Street address/PO Box/Company name)
Field type	dimension
Data type	string.geo.street

source_address_line_2

Field label	Source address line 2
Description	Address line 2 (Apartment/Suite/Unit/Building)
Field type	dimension
Data type	string.geo.street

source_address_city

Field label	Source address city
Description	City/District/Suburb/Town/Village
Field type	dimension
Data type	string.geo.city

source_address_state

Field label	Source address state
Description	State/County/Province/Region
Field type	dimension
Data type	string.geo.region

source_address_country

Field label	Source address country
Description	Billing address country, if provided when creating card
Field type	dimension
Data type	string.geo.country

source_address_zip

Field label	Source address zip code
Description	ZIP or postal code
Field type	dimension
Data type	string.geo.zip

source_address_zip_check

Field label	Source address zip code check
Description	If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked
Field type	dimension
Data type	string.text.value

source_metadata

Field label	Source metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

SOURCE CARD

source_card_brand

Field label	Card brand
Description	Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown
Field type	dimension
Data type	string.text.value

source_card_funding

Field label	Card funding type
Description	Card funding type. Can be credit, debit, prepaid, or unknown
Field type	dimension
Data type	string.text.value

source_card_country

Field label	Card country code
Description	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected
Field type	dimension
Data type	string.geo.country.twolettercode

source_card_name

Field label	Card holder name
Description	Cardholder name
Field type	dimension
Data type	string.text.value

source_card_exp_month

Field label	Card expiration month
Description	Two digit number representing the card's expiration month
Field type	dimension
Data type	int.number.value

source_card_exp_year

Field label	Card expiration year
Description	Four digit number representing the card's expiration year
Field type	dimension
Data type	int.number.value

source_card_fingerprint

Field label	Card fingerprint
Description	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example
Field type	dimension
Data type	string.text.value

source_card_tokenization

Field label	Card tokenization method
Description	If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay
Field type	dimension
Data type	string.text.value

source_card_cvc_check

Field label	Card CVC check
Description	If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked
Field type	dimension
Data type	string.text.value

source_card_last4

Field label	Card last 4 digits
Description	The last four digits of the card
Field type	dimension
Data type	string.text.value

source_card_last4_dynamic

Field label	Card last 4 digits (dynamic)
Description	(For tokenized numbers only.) The last four digits of the device account number
Field type	dimension
Data type	string.text.value

SUBSCRIPTION

subscription_id

Field label	Subscription ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

subscription_status

Field label	Subscription status
Description	Possible values are trialing, active, past_due, canceled, or unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. If subscription billing=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. If subscription billing=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.)
Field type	dimension
Data type	string.text.value

subscription_start_time

Field label	Subscription start time
Description	Date of the last substantial change to this subscription. For example, a change to the items array, or a change of status, will reset this timestamp
Field type	dimension
Data type	string.time.date

subscription_end_time

Field label	Subscription end time
Description	If the subscription has ended, the date the subscription ended
Field type	dimension
Data type	string.time.datetime

subscription_cancel_time

Field label	Subscription cancel time
Description	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_atwill still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state
Field type	dimension
Data type	string.time.datetime

subscription_cancel_period_end

Field label	Cancel at period end
Description	Boolean indicating whether this subscription should cancel at the end of the current period
Field type	dimension
Data type	bool

subscription_trial_start

Field label	Subscription trial start time
Description	If the subscription has a trial, the beginning of that trial
Field type	dimension
Data type	string.time.datetime

subscription_trial_end

Field label	Subscription trial end time
Description	Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan
Field type	dimension
Data type	string.time.datetime

subscription_period_start

Field label	Subscription period start time
Description	Start of the current period that the subscription has been invoiced for
Field type	dimension
Data type	string.time.datetime

subscription_period_end

Field label	Subscription period end time
Description	End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created
Field type	dimension
Data type	string.time.datetime

subscription_metadata

Field label	Subscription metadata
Description	A set of key-value pairs that you can attach to a Subscription object. It can be useful for storing additional information about the subscription in a structured format
Field type	dimension
Data type	string.text.json

subscription_quantity

Field label	Subscription quantity
Description	The quantity of the plan to which the customer is subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly
Field type	metric
Data type	int.number.value

subscription_appfee_percent

Field label	Application fee (%)
Description	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account
Field type	metric
Data type	float.number.percentage
Aggregation	Non-aggregatable metric

subscription_tax_percent

Field label	Subscription tax (%)
Description	A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a tax_percent of 20.0 will charge $12 per invoice. To unset a previously-set value, pass an empty string
Field type	metric
Data type	int.number.percentage

SUBSCRIPTION ITEM

subscription_item_id

Field label	Subscription item ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

subscription_item_currency

Field label	Subscription item currency
Description	Three-letter ISO currency code
Field type	dimension
Data type	string.text.value

subscription_item_description

Field label	Subscription items description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

SUBSCRIPTION PLAN

subscription_plan_id

Field label	Plan id
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

product_id

Field label	Product ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

subscription_product_name

Field label	Product name
Description	A brief description of the product
Field type	dimension
Data type	string.text.value

subscription_plan_name

Field label	Plan name
Description	A brief description of the plan, hidden from customers
Field type	dimension
Data type	string.text.value

subscription_plan_interval

Field label	Plan interval
Description	One of day, week, month or year. The frequency with which a subscription should be billed
Field type	dimension
Data type	string.text.value

subscription_plan_statement

Field label	Plan statement descriptor
Description	For a non-card charge, text that appears on the customer's statement as the statement descriptor
Field type	dimension
Data type	string.text.value

subscription_plan_metadata

Field label	Plan metadata
Description	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format
Field type	dimension
Data type	string.text.json

subscription_plan_amount

Field label	Plan amount
Description	A positive integer in cents (or 0 for a free plan) representing how much to charge on a recurring basis
Field type	metric
Data type	float.currency.value

subscription_plan_intervals

Field label	Plan interval count
Description	The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months
Field type	metric
Data type	int.number.value

subscription_plan_trial_days

Field label	Plan trial days
Description	Default number of trial days when subscribing a customer to this plan using trial_from_plan=true
Field type	metric
Data type	int.number.value

TAX RATES

tax_rate_id

Field label	Tax rate id
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

tax_rate_description

Field label	Tax rate description
Description	An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers
Field type	dimension
Data type	string.text.value

tax_rate_name

Field label	Tax rate name
Description	The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page
Field type	dimension
Data type	string.text.value

tax_rate_jurisdiction

Field label	Tax rate jurisdiction
Description	The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice
Field type	dimension
Data type	string.text.value

TIME

today

Field label	Today
Description	Today's date, e.g. 2017-01-31
Field type	dimension
Data type	string.time.date
Destinations	API, Data warehouse

year

Field label	Year
Description	Year, e.g. 2017
Field type	dimension
Data type	string.time.year

quarter

Field label	Quarter
Description	Quarter, e.g. 1
Field type	dimension
Data type	string.time.quarter

yearmonth

Field label	Year & month
Description	Year and month, e.g. 2017\|06
Field type	dimension
Data type	string.time.yearmonth

yearweek

Field label	Year & week (Sun-Sat)
Description	Year and week for US weeks, e.g. 2017\|08
Field type	dimension
Data type	string.time.yearweek

yearweekiso

Field label	Year & week (Mon-Sun)
Description	Year and week for ISO weeks, e.g. 2017\|08
Field type	dimension
Data type	string.time.yearweekiso

yearofweek

Field label	Year of week (Sun-Sat)
Description	Year of week for US weeks, e.g. 2017
Field type	dimension
Data type	string.time.year

yearofweekiso

Field label	Year of week (Mon-Sun)
Description	Year of week for ISO weeks, e.g. 2017
Field type	dimension
Data type	string.time.year

month

Field label	Month
Description	Month, e.g. 6
Field type	dimension
Data type	string.time.month

week

Field label	Week (Sun-Sat)
Description	US week number, e.g. 51
Field type	dimension
Data type	string.time.week

weekiso

Field label	Week (Mon-Sun)
Description	ISO week number, e.g. 51
Field type	dimension
Data type	string.time.weekiso

dayofweek

Field label	Day of week
Description	Day of week represented as a number, e.g 1
Field type	dimension
Data type	string.time.dayofweek

dayofweekname

Field label	Day of week (Sun-Sat)
Description	Day of week name for US weeks, e.g. 0 Sunday
Field type	dimension
Data type	string.time.dayofweek

dayofweeknameiso

Field label	Day of week (Mon-Sun)
Description	Day of week name for ISO weeks, e.g. 1 Sunday
Field type	dimension
Data type	string.time.dayofweekiso

date

Field label	Date
Description	Date, e.g. 2017-01-31
Field type	dimension
Data type	string.time.date

dayofmonth

Field label	Day of month
Description	Day of month, e.g. 2
Field type	dimension
Data type	string.time.dayofmonth

hour

Field label	Hour
Description	Hour in a 24-hour clock, e.g. 18
Field type	dimension
Data type	string.time.hour

minute

Field label	Minute
Description	Minute, e.g. 30
Field type	dimension
Data type	string.time.minute

TRANSFER

transfer_id

Field label	Transfer ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

transfer_currency

Field label	Transfers currency
Description	Three-letter ISO currency code, in lowercase
Field type	dimension
Data type	string.currency.code

transfer_description

Field label	Transfers description
Description	An arbitrary string attached to the object. Often useful for displaying to users
Field type	dimension
Data type	string.text.value

transfer_reversed

Field label	Transfer is reversed
Description	Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false
Field type	dimension
Data type	bool

transfer_source_type

Field label	Transfer source type
Description	The source balance this transfer came from. One of card, financing, bank_account, or alipay_account
Field type	dimension
Data type	string.text.value

transfer_source_transaction_id

Field label	Transfer source transaction ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

transfer_destination_payment_id

Field label	Transfers destination payment ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

transfer_group_id

Field label	Transfer group ID
Description	Unique identifier for the object
Field type	dimension
Data type	string.text.value

transfer_metadata

Field label	Transfer metadata
Description	A set of key-value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format
Field type	dimension
Data type	string.text.json

transfer_amount

Field label	Transfer amount
Description	Amount in cents to be transferred
Field type	metric
Data type	float.currency.value

transfer_amount_reversed

Field label	Transfer reversed amount
Description	Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)
Field type	metric
Data type	float.currency.value

Documentation Index