Stripe: Most-used fields

Stripe: Most-used fields#

The table below gives information about most-used fields that you can import from Stripe. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Amount

Amount

The monetary value of the transaction or financial event. This represents the total value, for instance, of a charge, refund, or payout. [1, 3, 4]

metric

Amount Refunded

Amount Refunded

The portion of the original transaction amount that has been refunded.

metric

Captured

Captured

Indicates whether the funds for a charge have been successfully captured.

dimension

Converted Amount

Converted Amount

The amount after currency conversion, if applicable.

metric

Converted Amount Refunded

Converted Amount Refunded

The amount refunded after currency conversion, if applicable.

metric

Converted Currency

Converted Currency

The three-letter ISO currency code of the amount after conversion.

dimension

Created (UTC)

Created (UTC)

The date and time (in UTC) when the object was created.

dimension

Currency

Currency

The three-letter ISO currency code of the transaction.

dimension

Customer Description

Customer Description

A customizable description provided when creating or updating the customer, often used for internal notes.

dimension

Customer Email

Customer Email

The email address of the customer associated with the transaction.

dimension

Customer ID

Customer ID

Unique identifier for the customer.

dimension

Description

Description

A general description associated with the object or transaction.

dimension

Fee

Fee

The charge applied by Stripe for processing a transaction or providing a service.

metric

Invoice ID

Invoice ID

Unique identifier for the invoice associated with the transaction.

dimension

Statement Descriptor

Statement Descriptor

Text displayed on the customer’s bank or card statement for the transaction.

dimension

Status

Status

The current state or outcome of an object or process (e.g., ‘succeeded’, ‘pending’, ‘failed’).

dimension

Tax

Tax

The total tax amount applied to a transaction or invoice.

metric

Transfer

Transfer

The unique identifier or amount related to a transfer of funds to a connected account or bank account.

dimension

activity_at

activity_at

Timestamp indicating when a specific activity or event occurred, often used in reports to define a time range.

dimension

activity_end_date

activity_end_date

The exclusive end date (timestamp) for the data included in a report, defining the upper boundary of the reporting period.

dimension

activity_start_date

activity_start_date

The inclusive start date (timestamp) for the data included in a report, defining the lower boundary of the reporting period.

dimension

amount

amount

The monetary value of the transaction or financial event. For fees, it represents the amount of the fee. [1, 3, 4]

metric

amount_refunded

amount_refunded

The portion of the original transaction amount that has been refunded.

metric

automatic_payout_effective_at

automatic_payout_effective_at

The date and time (in UTC) when an automatic payout is expected to arrive in the bank account, and when funds are deducted from the Stripe balance.

dimension

automatic_payout_id

automatic_payout_id

Unique identifier for the automatically created payout associated with a balance transaction.

dimension

available_on

available_on

The date when the net funds from a balance transaction become available in the Stripe balance.

dimension

available_on_utc

available_on_utc

The date and time (in UTC) when the net funds from a balance transaction become available in the Stripe balance.

dimension

balance_transaction_component

balance_transaction_component

Represents a detailed component of the fees applied to a balance transaction, such as application fees, Stripe fees, or tax.

dimension

balance_transaction_created_at_timestamp

balance_transaction_created_at_timestamp

Timestamp (in UTC) when the balance transaction was created and affected the Stripe balance.

dimension

balance_transaction_description

balance_transaction_description

A description of the balance transaction, providing details about its nature or purpose.

dimension

balance_transaction_id

balance_transaction_id

Unique identifier for the balance transaction, representing a movement of funds in the Stripe account.

dimension

balance_transaction_reporting_category

balance_transaction_reporting_category

A top-level categorization of balance transactions designed for financial accounting purposes.

dimension

billing_amount

billing_amount

The total amount charged or billed to a customer for services or products, often related to subscriptions or invoices.

metric

billing_currency

billing_currency

The three-letter ISO currency code used for billing purposes.

dimension

blocked_by_default_high_risk_rule_count

blocked_by_default_high_risk_rule_count

The number of transactions or payment attempts that were blocked due to Stripe’s default high-risk fraud detection rules, often identified by Stripe Radar. [2, 3]

metric

blocked_by_radar_rule_count

blocked_by_radar_rule_count

The total count of transactions or payment attempts that were blocked by custom or default rules configured within Stripe Radar, Stripe’s real-time fraud prevention system. [2, 3]

metric

blocked_by_stripe_count

blocked_by_stripe_count

The overall count of transactions or payment attempts that were blocked by Stripe for various reasons, including fraud rules, issuer rejections, or other system-level validations. [2]

metric

captured

captured

Indicates whether the funds for a charge have been successfully captured.

dimension

card_brand

card_brand

The brand of the card used for the transaction (e.g., Visa, Mastercard, American Express).

dimension

card_country

card_country

The two-letter ISO country code of the card’s issuing bank.

dimension

card_funding

card_funding

The funding type of the card (e.g., credit, debit, prepaid).

dimension

card_input_method

card_input_method

The method by which the card details were provided (e.g., manually typed, swiped, or chip read).

dimension

card_present

card_present

Indicates whether the card was physically present during the transaction (e.g., via a card reader).

dimension

card_type

card_type

The type of payment card used (e.g., credit card, debit card).

dimension

category

category

A general category associated with the transaction or event.

dimension

charge_id

charge_id

Unique identifier for the charge associated with the transaction.

dimension

connected_account

connected_account

For Stripe Connect platforms, the unique identifier of the connected Stripe account involved in the transaction.

dimension

contribution

contribution

Represents a financial transaction categorized as a contribution or gift, typically made to a not-for-profit organization, where no good or service is exchanged.

metric

converted_amount

converted_amount

The amount after currency conversion, if applicable.

metric

converted_amount_refunded

converted_amount_refunded

The amount refunded after currency conversion, if applicable.

metric

converted_currency

converted_currency

The three-letter ISO currency code of the amount after conversion.

dimension

count

count

A generic count of items or occurrences in a report or summary.

metric

currency

currency

The three-letter ISO currency code of the transaction.

dimension

customer_description

customer_description

A customizable description provided when creating or updating the customer, often used for internal notes.

dimension

customer_email

customer_email

The email address of the customer associated with the transaction.

dimension

customer_facing_amount

customer_facing_amount

The amount of the original charge, refund, or dispute as seen by the customer. This field is particularly useful if the customer was charged in a currency different from your account’s default. [1, 3]

metric

customer_facing_currency

customer_facing_currency

The three-letter ISO currency code that corresponds to the customer_facing_amount, indicating the currency in which the customer was charged. [1, 3]

dimension

customer_id

customer_id

Unique identifier for the customer.

dimension

date

date

A general date field related to the transaction or event.

dimension

description

description

A general description associated with the object or transaction.

dimension

destination_id

destination_id

For Stripe Connect transfers, the unique identifier of the destination account.

dimension

dispute_id

dispute_id

Unique identifier for a dispute related to a charge.

dimension

event_type

event_type

The type of event that occurred, often related to webhooks (e.g., payment_intent.succeeded).

dimension

fee

fee

The fees charged by Stripe or associated networks for a specific transaction or service. [1, 3, 4]

metric

fee_category

fee_category

A categorization for the type of fee incurred.

dimension

fee_currency

fee_currency

The three-letter ISO currency code for the fee amount.

dimension

fee_id

fee_id

Unique identifier for a specific fee applied to a transaction.

dimension

fee_name

fee_name

The name or description of a specific fee item incurred, such as a Stripe processing fee, network fee, or a fee associated with a particular product feature. [1, 4]

dimension

final_charge_id

final_charge_id

The unique identifier for a completed charge.

dimension

fx_rate

fx_rate

The foreign exchange rate applied during a currency conversion.

dimension

gross

gross

The gross amount of the transaction before any fees or adjustments are applied.

metric

id

id

A unique identifier for the object.

dimension

incurred_at

incurred_at

Timestamp indicating when a cost or event was incurred.

dimension

invoice_id

invoice_id

Unique identifier for the invoice associated with the transaction.

dimension

is_final_attempt

is_final_attempt

This field indicates whether a payment attempt is the final attempt for a given transaction. It helps to identify the definitive outcome when multiple attempts are made for a single payment, such as when a payment is declined and then retried.

dimension

issuer_authorized_count

issuer_authorized_count

The number of times a card issuer has authorized a transaction attempt.

metric

issuer_authorized_sum

issuer_authorized_sum

The cumulative sum of amounts for transactions that have been authorized by the card issuer.

metric

max_amount

max_amount

The maximum monetary value allowed for a transaction, charge, or a custom unit amount specified by a customer for an item.

dimension

min_amount

min_amount

The minimum monetary value required for a transaction, charge, or a custom unit amount specified by a customer for an item.

dimension

net

net

The net amount of the transaction after fees and other adjustments have been applied.

metric

net_amount

net_amount

The net amount of the transaction after fees and other adjustments have been applied.

metric

outcome_reason

outcome_reason

The specific reason for the outcome of a payment attempt or other event (e.g., ‘insufficient_funds’, ‘card_not_supported’).

dimension

outcome_type

outcome_type

The general type of outcome for a payment attempt, review, or other related process.

dimension

payout_description

payout_description

A description associated with the payout, often provided for reconciliation purposes.

dimension

payout_destination_id

payout_destination_id

The unique identifier for the bank account or card to which the payout was sent.

dimension

payout_expected_arrival_date

payout_expected_arrival_date

The date when the payout is expected to arrive in the destination bank account.

dimension

payout_id

payout_id

Unique identifier for the payout.

dimension

payout_reversed_at

payout_reversed_at

Timestamp indicating when a payout was reversed.

dimension

payout_status

payout_status

The current status of the payout (e.g., ‘pending’, ‘paid’, ‘failed’).

dimension

payout_type

payout_type

The type of payout (e.g., ‘bank_account’, ‘card’).

dimension

plan_name

plan_name

The name of the subscription plan to which a customer is subscribed.

dimension

refund_id

refund_id

Unique identifier for a refund.

dimension

reporting_category

reporting_category

A high-level category used to group balance transactions for financial reporting and analysis.

dimension

request_id

request_id

Unique identifier for the API request that created or modified the object, useful for tracing and debugging.

dimension

retried_payout_id

retried_payout_id

The unique identifier for a payout that has been re-attempted following an initial failure or delay. This ID is used to track the specific payout transaction throughout its lifecycle.

dimension

source

source

The source of funds for a payment or a generic identifier for the origin of an event.

dimension

source_id

source_id

Unique identifier for the source of funds, such as a PaymentMethod or token.

dimension

statement_descriptor

statement_descriptor

Text displayed on the customer’s bank or card statement for the transaction.

dimension

status

status

The current state or outcome of an object or process (e.g., ‘succeeded’, ‘pending’, ‘failed’).

dimension

subtotal_amount

subtotal_amount

The sum of all items on an invoice or order before taxes, discounts, or other charges are applied.

metric

tax

tax

The total tax amount applied to a transaction or invoice.

metric

tax_amount

tax_amount

The total amount of tax charged for a transaction.

metric

tax_rate

tax_rate

The percentage rate of tax applied to a transaction.

metric

total_amount

total_amount

The grand total amount of an invoice or transaction, including all line items, taxes, and fees.

metric

transaction_count

transaction_count

The total number of transactions within a given period or filter.

metric

transaction_sum

transaction_sum

The cumulative sum of amounts for transactions within a given period or filter.

metric

transfer

transfer

The unique identifier or amount related to a transfer of funds to a connected account or bank account.

dimension

type

type

A classification or category of the object or event.

dimension

variable_rate

variable_rate

This field indicates that a financial rate, such as a subscription price or payment amount, is not fixed and can vary. This often applies to pricing models where customers can set their own price or where amounts are dynamically determined, such as for donations, custom orders, or tiered subscriptions.

metric