Stripe

Application fees

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
charge → Charges > id

Application fees collected from connected accounts (Stripe Connect), with amount and refunds.

Field	Type
id	text	[en] Unique identifier for the object.
account	text	[en] ID of the Stripe account this fee was taken from.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount earned.
amount_refunded	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount refunded (can be less than the amount attribute on the fee if a partial refund was issued)
application	text	[en] ID of the Connect application that earned the fee.
balance_transaction	text	[en] Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). Balance transactions > > id
charge	text	[en] ID of the charge that the application fee was taken from. Charges > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
fee_source_charge	text	[en] Charge ID that created this application fee.
fee_source_payout	text	[en] Payout ID that created this application fee.
fee_source_type	text	[en] Type of object that created the application fee. Possible values: charge = charge; payout = payout to bank account.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
originating_transaction	text	[en] ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
refunded	boolean	[en] Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. Values: true (yes) or false (no).

Balance transactions

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction_id > _balance_transactions_fee_details → Balance transactions > id

Main object

Balance transactions: the statement of your Stripe balance, already in the balance currency (e.g. BRL). Best source for revenue, fees and reconciliation: type = charge (sale), refund, payout (to the bank); amount = gross, fee = Stripe fee, net = amount − fee. Sign: positive entered the balance, negative left it (payouts and refunds are negative here). The fee child table itemizes each fee (processing, currency conversion...).

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Gross amount of this transaction. A positive value represents funds charged to another party, and a negative value represents funds sent to another party. Gross, in your Stripe balance currency (e.g. BRL). Positive = entered the balance; negative = left it (payouts and refunds are negative here).
available_on	timestamp	[en] The date that the transaction's net funds become available in the Stripe balance. Date the money becomes available for payout (the date is what matters; the time is 00:00 UTC).
balance_type	text	[en] The balance that this transaction impacts. Possible values: issuing = Issuing balance; payments = payments balance; refund_and_dispute_prefunding = prefunded balance for refunds and disputes; risk_reserved = balance held in risk reserve.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
exchange_rate	float	[en] If 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. Exchange rate used: charge amount (customer currency) × exchange_rate = this row's amount (balance currency). Empty when there was no conversion.
fee	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Fees paid for this transaction. Fee charged by Stripe on this transaction (processing + currency conversion, itemized in the fees child table).
net	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Net impact to a Stripe balance. 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… Net = amount − fee: what actually stays in your balance.
reporting_category	text	[en] Accounting category of the transaction, simpler than type: charge = sale; refund; payout; fee; dispute; adjustment.
source	text	[en] This transaction relates to the Stripe object. Id of the record that generated the transaction: charge (ch_...), refund (re_...), payout (po_...), etc.
status	text	[en] The transaction's net funds status in the Stripe balance, which are either available or pending.
type	text	[en] Transaction 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… Possible values: adjustment = balance adjustment; advance = funds advance; advance_funding = advance funding; anticipation_repayment = anticipation repayment; application_fee = Connect platform application fee; application_fee_refund = application fee refund; charge = charge; climate_order_purchase = Climate carbon removal purchase; climate_order_refund = Climate order refund; connect_collection_transfer = Connect collection transfer; contribution = contribution (e.g. Climate); fee_credit_funding = Stripe fee credit funding; inbound_transfer = inbound transfer; inbound_transfer_reversal = inbound transfer reversal; issuing_authorization_hold = Issuing authorization hold; issuing_authorization_release = Issuing authorization release; issuing_dispute = Issuing dispute; issuing_dispute_provisional_credit = Issuing dispute provisional credit; issuing_dispute_provisional_credit_reversal = Issuing provisional credit reversal; issuing_transaction = Issuing card transaction; obligation_outbound = outbound obligation; obligation_reversal_inbound = inbound obligation reversal; payment = payment; payment_failure_refund = failed payment refund; payment_network_reserve_hold = payment network reserve hold; payment_network_reserve_release = payment network reserve release; payment_refund = payment refund; payment_reversal = payment reversal; payment_unreconciled = unreconciled payment; payout = payout to bank account; payout_cancel = payout canceled; payout_failure = payout failed; payout_minimum_balance_hold = payout minimum balance hold; payout_minimum_balance_release = payout minimum balance release; refund = refund; refund_failure = refund failed; reserve_hold = reserve hold; reserve_release = reserve release; reserve_transaction = reserve transaction; reserved_funds = reserved funds; stripe_balance_payment_debit = Stripe balance payment debit; stripe_balance_payment_debit_reversal = Stripe balance payment debit reversal; stripe_fee = Stripe fee; stripe_fx_fee = Stripe currency conversion fee; tax_fee = tax fee (Stripe Tax); tax_fund = tax funds; topup = balance top-up; topup_reversal = top-up reversal; transfer = transfer to connected account; transfer_cancel = transfer canceled; transfer_failure = transfer failed; transfer_refund = transfer reversal. Most common: charge = sale; refund; payout = transfer to the bank; adjustment; stripe_fee = standalone Stripe fee.

stripe_balance_transactions_fee_details

Balance transactions: fee_details (one row per item; joins stripe_balance_transactions by column balance_transaction_id).

Field	Type
balance_transaction_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_balance_transactions). Balance transactions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the fee.
application	text	[en] ID of the Connect application that earned the fee.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Fee description: "Stripe processing fees" or "Stripe currency conversion fee".
type	text	[en] Type of the fee, one of: application_fee, payment_method_passthrough_fee, stripe_fee, tax, or withheld_tax. Fee type (usually stripe_fee). To tell processing from currency conversion use the description column.

Billing credit grants

Replication type: Full

Relationships:

customer → Customers > id
credit_grant_id > _billing_credit_grants_applicability__scope_prices → Billing credit grants > id
credit_grant_id > _billing_credit_grants_metadata → Billing credit grants > id

Main object

Credits granted to customers for usage-based billing.

Field	Type
id	text	[en] Unique identifier for the object.
amount_monetary_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
amount_monetary_value	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing the amount.
amount_type	text	[en] The type of this amount. We currently only support monetary billing credits. Possible values: monetary = monetary credit.
applicability_config_scope_price_type	text	[en] The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices. Possible values: metered = usage-based metered price.
category	text	[en] The category of this credit grant. This is for tracking purposes and isn't displayed to the customer. Possible values: paid = paid credit; promotional = promotional credit.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
customer	text	[en] ID of the customer receiving the billing credits. Customers > > id
customer_account	text	[en] ID of the account representing the customer receiving the billing credits…
effective_at	timestamp	[en] The time when the billing credits become effective-when they're eligible for use. Date and time in UTC.
expires_at	timestamp	[en] The time when the billing credits expire. If not present, the billing credits don't expire. Date and time in UTC.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
name	text	[en] A descriptive name shown in dashboard.
priority	int	[en] The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
test_clock	text	[en] ID of the test clock this credit grant belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.
updated	timestamp	[en] Time at which the object was last updated. Date and time in UTC.
voided_at	timestamp	[en] The time when this credit grant was voided. If not present, the credit grant hasn't been voided. Date and time in UTC.

stripe_billing_credit_grants_applicability__scope_prices

Billing credit grants: applicability_config.scope.prices (one row per item; joins stripe_billing_credit_grants by column credit_grant_id).

Field	Type
credit_grant_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_billing_credit_grants). Billing credit grants > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.

Field

Type

credit_grant_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_billing_credit_grants).

Billing credit grants > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

id

text

[en] Unique identifier for the object.

stripe_billing_credit_grants_metadata

Billing credit grants: metadata (one row per item; joins stripe_billing_credit_grants by column credit_grant_id).

Field	Type
credit_grant_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_billing_credit_grants). Billing credit grants > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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

credit_grant_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_billing_credit_grants).

Billing credit grants > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Billing meters

Replication type: Full

Usage meters for usage-based billing (active and inactive).

Field	Type
id	text	[en] Unique identifier for the object.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
customer_mapping_event_payload_key	text	[en] The key in the meter event payload to use for mapping the event to a customer.
customer_mapping_type	text	[en] The method for mapping a meter event to a customer. Possible values: by_id = mapped by customer ID.
default_aggregation_formula	text	[en] Specifies how events are aggregated. Possible values: count = count of events; last = last reported value; sum = sum of values.
display_name	text	[en] The meter's name.
event_name	text	[en] The name of the meter event to record usage for. Corresponds with the event_name field on meter events.
event_time_window	text	[en] The time window which meter events have been pre-aggregated for, if any. Possible values: day = pre-aggregated per day; hour = pre-aggregated per hour.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
status	text	[en] The meter's status. Possible values: active = active, in effect; inactive = inactive.
status_transitions_deactivated_at	timestamp	[en] The time the meter was deactivated, if any. Measured in seconds since Unix epoch. Date and time in UTC.
updated	timestamp	[en] Time at which the object was last updated. Date and time in UTC.
value_settings_event_payload_key	text	[en] The key in the meter event payload to use as the value for this meter.

Charges

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
customer → Customers > id
payment_intent → Payment intents > id
transfer → Transfers > id
charge_id > _charges_metadata → Charges > id
charge_id > _charges_payment_method_details → Charges > id
charge_id > _charges_payment_method_details_preferred_locales → Charges > id
charge_id > _charges_paym_seller_protection_dispute_categories → Charges > id

Main object

Charges: every attempt to charge the customer (card, boleto, Pix...), paid or declined. Amounts are in the currency charged to the customer (currency column, e.g. usd); the same amount converted to your Stripe balance currency, with the Stripe fee and the net, is in balance_transaction_amount, balance_transaction_fee and balance_transaction_net. For revenue use status = succeeded; declines have status = failed and the reason in outcome_reason / failure_code.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this payment. A value representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency. In the currency charged to the customer (currency column). The same amount in your Stripe balance currency (e.g. BRL) is in balance_transaction_amount.
amount_captured	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount captured (can be less than the amount attribute on the charge if a partial capture was made).
amount_refunded	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount refunded (can be less than the amount attribute on the charge if a partial refund was issued).
application	text	[en] ID of the Connect application that created the charge.
application_fee	text	[en] The application fee (if any) for the charge.
application_fee_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the application fee (if any) requested for the charge.
balance_transaction	text	[en] ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). Balance transactions > > id
billing_details_address_city	text	[en] City, district, suburb, town, or village.
billing_details_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
billing_details_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
billing_details_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
billing_details_address_postal_code	text	[en] ZIP or postal code.
billing_details_address_state	text	[en] State, county, province, or region (ISO 3166-2).
billing_details_email	text	[en] Email address.
billing_details_name	text	[en] Full name.
billing_details_phone	text	[en] Billing phone number (including extension).
billing_details_tax_id	text	[en] Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
calculated_statement_descriptor	text	[en] The 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.
captured	boolean	[en] If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. Values: true (yes) or false (no).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] ID of the customer this charge is for if one exists. Customers > > id
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
disputed	boolean	[en] Whether the charge has been disputed. Values: true (yes) or false (no).
failure_balance_transaction	text	[en] ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
failure_code	text	[en] Error code explaining reason for charge failure if available (see the errors section for a list of codes). Most common codes: insufficient_funds; do_not_honor = declined by the bank with no reason; card_velocity_exceeded = attempt/amount limit exceeded; lost_card / stolen_card (do not retry); expired_card; transaction_not_allowed; previously_declined_do_not_retry = declined before, Stripe blocked a retry; try_again_later; invalid_account; highest_risk_level = blocked by fraud prevention.
failure_message	text	[en] Message to user further explaining reason for charge failure if available.
fraud_details_stripe_report	text	[en] Assessments from Stripe. If set, the value is fraudulent.
fraud_details_user_report	text	[en] Assessments reported by you. If set, possible values of are safe and fraudulent.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
on_behalf_of	text	[en] The account (if any) the charge was made on behalf of without triggering an automatic transfer.
outcome_advice_code	text	[en] An enumerated value providing a more detailed explanation on how to proceed with an error. Possible values: confirm_card_data = confirm card data before retrying; do_not_try_again = do not retry; try_again_later = retry later.
outcome_network_advice_code	text	[en] For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
outcome_network_decline_code	text	[en] For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.
outcome_network_status	text	[en] 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.
outcome_reason	text	[en] 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. Most common codes: insufficient_funds; do_not_honor = declined by the bank with no reason; card_velocity_exceeded = attempt/amount limit exceeded; lost_card / stolen_card (do not retry); expired_card; transaction_not_allowed; previously_declined_do_not_retry = declined before, Stripe blocked a retry; try_again_later; invalid_account; highest_risk_level = blocked by fraud prevention.
outcome_risk_level	text	[en] Stripe Radar'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.
outcome_risk_score	int	[en] Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present.
outcome_rule	text	[en] The ID of the Radar rule that matched the payment, if applicable.
outcome_seller_message	text	[en] A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
outcome_type	text	[en] Possible values are authorized, manual_review, issuer_declined, blocked, and invalid. See understanding declines and Radar reviews for details. authorized = approved; issuer_declined = declined by the issuing bank; blocked = blocked by Stripe fraud prevention; manual_review; invalid = invalid data.
paid	boolean	[en] true if the charge succeeded, or was successfully authorized for later capture. Values: true (yes) or false (no).
payment_intent	text	[en] ID of the PaymentIntent associated with this charge, if one exists. Payment intents > > id
payment_method	text	[en] ID of the payment method used in this charge.
payment_method_details_type	text	[en] The type of transaction-specific details of the payment method used in the payment. See PaymentMethod.type for the full list of possible types. An additional hash is included on payment_method_details with a name matching this value. It contains information specific to the payment method.
presentment_details_presentment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this payment, denominated in presentment_currency.
presentment_details_presentment_currency	text	[en] Currency presented to the customer during payment.
radar_options_session	text	[en] A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
receipt_email	text	[en] This is the email address that the receipt for this charge was sent to.
receipt_number	text	[en] 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.
receipt_url	text	[en] This 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.
refunded	boolean	[en] Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. Values: true (yes) or false (no).
review	text	[en] ID of the review associated with this charge if one exists.
shipping_address_city	text	[en] City, district, suburb, town, or village.
shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
shipping_address_postal_code	text	[en] ZIP or postal code.
shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
shipping_carrier	text	[en] The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
shipping_name	text	[en] Recipient name.
shipping_phone	text	[en] Recipient phone (including extension).
shipping_tracking_number	text	[en] 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.
source_transfer	text	[en] The transfer ID which created this charge. Only present if the charge came from another Stripe account.
statement_descriptor	text	[en] For 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.
statement_descriptor_suffix	text	[en] Provides information about a card charge. Concatenated to the account's statement descriptor prefix 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.
status	text	[en] The status of the payment is either succeeded, pending, or failed. Possible values: failed = failed; pending = pending; succeeded = succeeded.
transfer	text	[en] ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter). Transfers > > id
transfer_data_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
transfer_data_destination	text	[en] ID of an existing, connected Stripe account to transfer funds to if transfer_data was specified in the charge request.
transfer_group	text	[en] A string that identifies this transaction as part of a group.
balance_transaction_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This amount converted to the currency of your Stripe balance (e.g. BRL), as recorded in the balance.
balance_transaction_fee	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Stripe fee for this transaction, in the currency of your Stripe balance.
balance_transaction_net	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Net amount (amount minus Stripe fee), in the currency of your Stripe balance.
balance_transaction_currency	text	[en] Currency of your Stripe balance in which balance_transaction_amount, balance_transaction_fee and balance_transaction_net are expressed.
balance_transaction_exchange_rate	float	[en] Exchange rate used to convert this amount to the balance currency (amount x exchange_rate = balance_transaction_amount). Empty when there was no conversion.
balance_transaction_available_on	timestamp	[en] Date the money becomes available in your Stripe balance for payout. Date and time in UTC.
balance_transaction_status	text	[en] Whether the money is already available in your Stripe balance (available) or not yet (pending).

stripe_charges_metadata

Charges: metadata (one row per item; joins stripe_charges by column charge_id).

Field

Type

charge_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_charges).

Charges > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_charges_payment_method_details

Charges: payment_method_details (one row per item; joins stripe_charges by column charge_id).

Field	Type
charge_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_charges). Charges > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
account_holder_name	text	[en] The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
account_holder_type	text	[en] Type of entity that holds the account. This can be either individual or company. Possible values: company = company account holder; individual = individual account holder.
account_number	text	[en] Account number to transfer funds to.
account_type	text	[en] Account type: checkings or savings. Defaults to checking if omitted. Possible values: checking = checking account; savings = savings account.
amount_authorized	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The authorized amount.
authorization_code	text	[en] Authorization code on the charge.
bank	text	[en] The customer's bank. Possible values: arzte_und_apotheker_bank; austrian_anadi_bank_ag; bank_austria; bankhaus_carl_spangler; bankhaus_schelhammer_und_schattera_ag; bawag_psk_ag; bks_bank_ag; brull_kallmus_bank_ag; btv_vier_lander_bank; capital_bank_grawe_gruppe_ag; deutsche_bank_ag; dolomitenbank; easybank_ag; erste_bank_und_sparkassen; hypo_alpeadriabank_international_ag; hypo_bank_burgenland_aktiengesellschaft; hypo_noe_lb_fur_niederosterreich_u_wien; hypo_oberosterreich_salzburg_steiermark; hypo_tirol_bank_ag; hypo_vorarlberg_bank_ag; marchfelder_bank; oberbank_ag; raiffeisen_bankengruppe_osterreich; schoellerbank_ag; sparda_bank_wien; volksbank_gruppe; volkskreditbank_ag; vr_bank_braunau.
bank_code	text	[en] Bank code of bank associated with the bank account.
bank_name	text	[en] Name of the bank associated with the routing number.
bank_transaction_id	text	[en] Unique transaction id generated by BCB…
bic	text	[en] Bank Identifier Code of the bank associated with the bank account.
branch_code	text	[en] The numeric code for the bank account's bank branch.
brand	text	[en] Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.
brand_product	text	[en] The product code that identifies the specific program or product associated with a card.
bsb_number	text	[en] Bank-State-Branch number of the bank account.
buyer_address	text	[en] The wallet address of the customer.
buyer_id	text	[en] Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
capture_before	timestamp	[en] When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. Date and time in UTC.
card_brand	text	[en] Brand of the card used in the transaction…
card_country	text	[en] Two-letter ISO code representing the country of the card…
card_exp_month	int	[en] Two digit number representing the card's expiration month…
card_exp_year	int	[en] Two digit number representing the card's expiration year…
card_last4	text	[en] The last 4 digits of the card…
cardholder_name	text	[en] The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card.
cashtag	text	[en] A public identifier for buyers using Cash App.
checks_address_line1_check	text	[en] If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.
checks_address_postal_code_check	text	[en] If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.
checks_cvc_check	text	[en] If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.
country	text	[en] Two-letter ISO code representing the country the bank account is located in.
description	text	[en] A high-level description of the type of cards issued in this range.
electronic_commerce_indicator	text	[en] The Electronic Commerce Indicator (ECI) returned by the card network in the authorization response. Indicates the level of authentication used. Only populated for Visa and Mastercard transactions. This is the network's final ECI and can differ from the request value.
emv_auth_data	text	[en] Authorization response cryptogram.
entity	text	[en] Entity number associated with this Multibanco payment.
exp_month	int	[en] Two-digit number representing the card's expiration month.
exp_year	int	[en] Four-digit number representing the card's expiration year.
expected_debit_date	text	[en] Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
extended_authorization_status	text	[en] Indicates whether or not the capture window is extended beyond the standard authorization. Possible values: disabled = disabled; enabled = enabled.
fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
funding	text	[en] Card funding type (credit, debit, prepaid or unknown), for card payment methods.
funding_card_brand	text	[en] Card brand. Can be American Express, Cartes Bancaires, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.
funding_card_country	text	[en] 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.
funding_card_exp_month	int	[en] Two-digit number representing the card's expiration month.
funding_card_exp_year	int	[en] Four-digit number representing the card's expiration year.
funding_card_funding	text	[en] Card funding type. Can be credit, debit, prepaid, or unknown.
funding_card_last4	text	[en] The last four digits of the card.
funding_type	text	[en] funding type of the underlying payment method. Possible values: card = card (online).
funding_source_group	text	[en] The funding source group code applied to this Link payment at confirmation time.
generated_card	text	[en] ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
generated_sepa_debit	text	[en] The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
generated_sepa_debit_mandate	text	[en] The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
iban_last4	text	[en] Last four characters of the IBAN.
incremental_authorization_status	text	[en] Indicates whether or not the incremental authorization feature is supported. Possible values: available = available; unavailable = unavailable.
incremental_authorization_supported	boolean	[en] Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support. Values: true (yes) or false (no).
installments_count	int	[en] The number of installments.
installments_plan_count	int	[en] For fixed_count installment plans, this is the number of installment payments your customer will make to their credit card.
installments_plan_interval	text	[en] For fixed_count installment plans, this is the interval between installment payments your customer will make to their credit card. One of month. Possible values: month = monthly.
installments_plan_type	text	[en] Type of installment plan, one of fixed_count, bonus, or revolving. Possible values: bonus = bonus installment plan; fixed_count = fixed number of installments; revolving = revolving credit.
institution_number	text	[en] Institution number of the bank account…
issuer	text	[en] The name of the card's issuing bank.
last4	text	[en] Last four digits of the bank account number.
location	text	[en] ID of the location that this reader is assigned to.
mandate	text	[en] ID of the mandate used to make this payment.
multicapture_status	text	[en] Indicates whether or not multiple captures are supported. Possible values: available = available; unavailable = unavailable.
network	text	[en] Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.
network_token_used	boolean	[en] Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. Values: true (yes) or false (no).
network_transaction_id	text	[en] This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
number	text	[en] OXXO reference number…
offline_stored_at	timestamp	[en] Time at which the payment was collected while offline… Date and time in UTC.
offline_type	text	[en] The method used to process this payment method offline. Only deferred is allowed. Possible values: deferred = deferred (offline) processing.
order_id	text	[en] The Afterpay order ID associated with this payment intent.
overcapture_maximum_amount_capturable	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum amount that can be captured.
overcapture_status	text	[en] Indicates whether or not the authorized amount can be over-captured. Possible values: available = available; unavailable = unavailable.
overcapture_supported	boolean	[en] Defines whether the authorized amount can be over-captured or not… Values: true (yes) or false (no).
pay_id	text	[en] The PayID alias for the bank account.
payer_details_address_country	text	[en] The payer address country…
payer_email	text	[en] Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
payer_id	text	[en] PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
payer_name	text	[en] Owner's full name. Values provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
payment_method_category	text	[en] The Klarna payment method used for this transaction. Can be one of pay_later, pay_now, pay_with_financing, or pay_in_installments…
payment_reference	text	[en] Payer bank reference number for the payment…
preferred_language	text	[en] Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of en, de, fr, or nl… Possible values: de = German; en = English; fr = French; nl = Dutch.
preferred_locale	text	[en] Preferred language of the Klarna authorization page that the customer is redirected to.
read_method	text	[en] How card details were read in this transaction. Possible values: contact_emv = chip inserted (EMV); contactless_emv = contactless (EMV); contactless_magstripe_mode = contactless magstripe mode; magnetic_stripe_fallback = magstripe fallback after chip failure; magnetic_stripe_track2 = magnetic stripe (track 2).
reader	text	[en] ID of the reader this transaction was made on.
receipt_account_type	text	[en] The type of account being debited or credited… Possible values: checking = checking account; credit = credit account; prepaid = prepaid account; unknown = unknown type.
receipt_application_cryptogram	text	[en] The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
receipt_application_preferred_name	text	[en] The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
receipt_authorization_code	text	[en] Identifier for this transaction.
receipt_authorization_response_code	text	[en] EMV tag 8A. A code returned by the card issuer.
receipt_cardholder_verification_method	text	[en] Describes the method used by the cardholder to verify ownership of the card. One of the following: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin, or signature.
receipt_dedicated_file_name	text	[en] Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
receipt_terminal_verification_results	text	[en] A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
receipt_transaction_status_information	text	[en] An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
reference	text	[en] Order identifier shown to the merchant in Afterpay's online portal.
regulated_status	text	[en] Status of a card based on the card issuer. Possible values: regulated = regulated card (capped interchange); unregulated = unregulated card.
routing_number	text	[en] Routing transit number for the bank account to transfer funds to.
seller_protection_status	text	[en] Indicates whether the transaction is eligible for PayPal's seller protection. Possible values: eligible = eligible for seller protection; not_eligible = not eligible for seller protection; partially_eligible = partially eligible for protection.
sort_code	text	[en] Sort code of the bank account. (e.g., 10-20-30)
store_chain	text	[en] The name of the convenience store chain where the payment was completed. Possible values: familymart = FamilyMart (convenience store chain); lawson = Lawson (convenience store chain); ministop = Ministop (convenience store chain); seicomart = Seicomart (convenience store chain).
suffix	text	[en] The suffix of the bank account number.
swift_code	text	[en] SWIFT code of the bank associated with the routing number.
tax_id	text	[en] The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
three_d_secure_authentication_flow	text	[en] For authenticated transactions: how the customer was authenticated by the issuing bank. Possible values: challenge = customer completed a challenge; frictionless = authenticated without customer interaction.
three_d_secure_electronic_commerce_indicator	text	[en] The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. Possible values: 01 = ECI 01: attempted authentication (Mastercard); 02 = ECI 02: fully authenticated (Mastercard); 05 = ECI 05: fully authenticated (Visa and others); 06 = ECI 06: attempted authentication (Visa and others); 07 = ECI 07: no 3DS authentication.
three_d_secure_exemption_indicator	text	[en] The exemption requested via 3DS and accepted by the issuer at authentication time. Possible values: low_risk = low-risk exemption accepted; none = no exemption.
three_d_secure_exemption_indicator_applied	boolean	[en] Whether Stripe requested the value of exemption_indicator in the transaction. This will depend on the outcome of Stripe's internal risk assessment. Values: true (yes) or false (no).
three_d_secure_result	text	[en] Indicates the outcome of 3D Secure authentication. Possible values: attempt_acknowledged = attempt acknowledged, not fully authenticated; authenticated = successfully authenticated; data_share_only = data shared only, no authentication; exempted = exempted from authentication; failed = authentication failed; not_supported = card does not support 3D Secure; processing_error = processing error.
three_d_secure_result_reason	text	[en] Additional information about why 3D Secure succeeded or failed based on the result. Possible values: abandoned = customer abandoned authentication; bypassed = 3DS bypassed by issuer; canceled = authentication canceled; card_not_enrolled = card not enrolled in 3DS; network_not_supported = card network does not support 3DS; protocol_error = 3DS protocol error; rejected = issuer rejected authentication.
three_d_secure_transaction_id	text	[en] The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment.
three_d_secure_version	text	[en] The version of 3D Secure that was used. Possible values: 1.0.2 = 3D Secure version 1.0.2; 2.1.0 = 3D Secure version 2.1.0; 2.2.0 = 3D Secure version 2.2.0; 2.3.0 = 3D Secure version 2.3.0; 2.3.1 = 3D Secure version 2.3.1.
token_currency	text	[en] The token currency that the transaction was sent with. Possible values: phantom_cash = Phantom Cash (stablecoin); usdc = USDC (USD stablecoin); usdg = USDG (USD stablecoin); usdp = USDP / Pax Dollar (stablecoin); usdsui = USDsui (stablecoin on Sui); usdt = USDT / Tether (stablecoin).
transaction_hash	text	[en] The blockchain transaction hash of the crypto payment.
transaction_id	text	[en] The Affirm transaction ID associated with this payment.
transaction_link_id	text	[en] Transaction Link ID (TLID) is a unique identifier for a transaction. This is used by some card networks, such as Mastercard, for transaction linking, in addition to Network Transaction IDs.
transit_number	text	[en] Transit number of the bank account.
verified_name	text	[en] Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
verified_phone_last4	text	[en] The last four digits of the Swish account phone number…
vpa	text	[en] Customer's unique Virtual Payment Address.
wallet_dynamic_last4	text	[en] (For tokenized numbers only.) The last four digits of the device account number.
wallet_link_funding_source_group	text	[en] The funding source group code applied to this Link payment at confirmation time.
wallet_masterpass_billing_address_city	text	[en] City, district, suburb, town, or village.
wallet_masterpass_billing_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
wallet_masterpass_billing_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
wallet_masterpass_billing_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
wallet_masterpass_billing_address_postal_code	text	[en] ZIP or postal code.
wallet_masterpass_billing_address_state	text	[en] State, county, province, or region (ISO 3166-2).
wallet_masterpass_email	text	[en] Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
wallet_masterpass_name	text	[en] Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
wallet_masterpass_shipping_address_city	text	[en] City, district, suburb, town, or village.
wallet_masterpass_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
wallet_masterpass_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
wallet_masterpass_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
wallet_masterpass_shipping_address_postal_code	text	[en] ZIP or postal code.
wallet_masterpass_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
wallet_type	text	[en] The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. Possible values: amex_express_checkout = Amex Express Checkout (wallet); apple_pay = Apple Pay (wallet); google_pay = Google Pay (wallet); link = Link (Stripe saved checkout); masterpass = Masterpass (wallet); samsung_pay = Samsung Pay (digital wallet); visa_checkout = Visa Checkout (wallet).
wallet_visa_checkout_billing_address_city	text	[en] City, district, suburb, town, or village.
wallet_visa_checkout_billing_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
wallet_visa_checkout_billing_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
wallet_visa_checkout_billing_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
wallet_visa_checkout_billing_address_postal_code	text	[en] ZIP or postal code.
wallet_visa_checkout_billing_address_state	text	[en] State, county, province, or region (ISO 3166-2).
wallet_visa_checkout_email	text	[en] Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
wallet_visa_checkout_name	text	[en] Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
wallet_visa_checkout_shipping_address_city	text	[en] City, district, suburb, town, or village.
wallet_visa_checkout_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
wallet_visa_checkout_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
wallet_visa_checkout_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
wallet_visa_checkout_shipping_address_postal_code	text	[en] ZIP or postal code.
wallet_visa_checkout_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).

stripe_charges_payment_method_details_preferred_locales

Charges: payment_method_details.preferred_locales (one row per item; joins stripe_charges by column charge_id).

Field	Type
charge_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_charges). Charges > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_charges_payment_method_details, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.

stripe_charges_paym_seller_protection_dispute_categories

Charges: payment_method_details.seller_protection.dispute_categories (one row per item; joins stripe_charges by column charge_id).

Field	Type
charge_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_charges). Charges > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_charges_payment_method_details, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] An array of conditions that are covered for the transaction, if applicable. Possible values: fraudulent = fraud dispute; product_not_received = product not received.

Checkout sessions

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
invoice → Invoices > id
payment_intent → Payment intents > id
payment_link → Payment links > id
setup_intent → Setup intents > id
subscription → Subscriptions > id
checkout_session_id > _checkout_sessions_allowed_payment_method_types → Checkout sessions > id
checkout_session_id > _checkout_sessions_custom_fields → Checkout sessions > id
checkout_session_id > _checkout_sessions_custom_fields_dropdown_options → Checkout sessions > id
checkout_session_id > _checkout_sessions_customer_details_tax_ids → Checkout sessions > id
checkout_session_id > _checkout_sessions_discounts → Checkout sessions > id
checkout_session_id > _checkout_sessions_excluded_payment_method_types → Checkout sessions > id
checkout_session_id > _checkout_sessions_inv_invoice_dat_account_tax_ids → Checkout sessions > id
checkout_session_id > _checkout_sessions_invo_invoice_data_custom_fields → Checkout sessions > id
checkout_session_id > _checkout_sessions_invoice_c_invoice_data_metadata → Checkout sessions > id
checkout_session_id > _checkout_sessions_metadata → Checkout sessions > id
checkout_session_id > _checkout_sessions_optional_items → Checkout sessions > id
checkout_session_id > _checkout_sessions_payment_method_options → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_ban_requested_address_types → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_fin_fil_account_subcategori → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_financial_conne_permissions → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_financial_connecti_prefetch → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_mandate_options_default_for → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_restrictions_brands_blocked → Checkout sessions > id
checkout_session_id > _checkout_sessions_pay_restr_funding_types_blocked → Checkout sessions > id
checkout_session_id > _checkout_sessions_payment_method_types → Checkout sessions > id
checkout_session_id > _checkout_sessions_saved_p_allow_redisplay_filters → Checkout sessions > id
checkout_session_id > _checkout_sessions_shipping_addr_allowed_countries → Checkout sessions > id
checkout_session_id > _checkout_sessions_shipping_cost_taxes → Checkout sessions > id
checkout_session_id > _checkout_sessions_shipping_options → Checkout sessions > id
checkout_session_id > _checkout_sessions_total_detai_breakdown_discounts → Checkout sessions > id
checkout_session_id > _checkout_sessions_total_details_breakdown_taxes → Checkout sessions > id

Main object

Stripe Checkout sessions (payment page), with customer, amounts, payment status and the resulting payment or subscription.

Field	Type
id	text	[en] Unique identifier for the object.
adaptive_pricing_enabled	boolean	[en] If enabled, Adaptive Pricing is available on eligible sessions. Values: true (yes) or false (no).
after_expiration_recovery_allow_promotion_codes	boolean	[en] Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false… Values: true (yes) or false (no).
after_expiration_recovery_enabled	boolean	[en] If true, a recovery url will be generated to recover this Checkout Session if it expires before a transaction is completed. It will be attached to the Checkout Session object upon expiration. Values: true (yes) or false (no).
after_expiration_recovery_expires_at	timestamp	[en] The timestamp at which the recovery URL will expire. Date and time in UTC.
after_expiration_recovery_url	text	[en] URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session…
allow_promotion_codes	boolean	[en] Enables user redeemable promotion codes. Values: true (yes) or false (no).
amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total of all items before discounts or taxes are applied.
amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total of all items after discounts and taxes are applied.
automatic_tax_enabled	boolean	[en] Indicates whether automatic tax is enabled for the session… Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
automatic_tax_provider	text	[en] The tax provider powering automatic tax.
automatic_tax_status	text	[en] The status of the most recent automated tax calculation for this session. Possible values: complete = complete; failed = failed; requires_location_inputs = requires valid customer location.
billing_address_collection	text	[en] Describes whether Checkout should collect the customer's billing address. Defaults to auto. Possible values: auto = collect address only when needed; required = billing address required.
branding_settings_background_color	text	[en] A hex color value starting with # representing the background color for the Checkout Session.
branding_settings_border_style	text	[en] The border style for the Checkout Session. Must be one of rounded, rectangular, or pill. Possible values: pill = pill-shaped borders; rectangular = square (rectangular) borders; rounded = rounded borders.
branding_settings_button_color	text	[en] A hex color value starting with # representing the button color for the Checkout Session.
branding_settings_display_name	text	[en] The display name shown on the Checkout Session.
branding_settings_font_family	text	[en] The font family for the Checkout Session. Must be one of the supported font families.
branding_settings_icon_file	text	[en] The ID of a File upload representing the icon. Purpose must be business_icon. Required if type is file and disallowed otherwise.
branding_settings_icon_type	text	[en] The type of image for the icon. Must be one of file or url. Possible values: file = uploaded file image; url = image from URL.
branding_settings_icon_url	text	[en] The URL of the image. Present when type is url.
branding_settings_logo_file	text	[en] The ID of a File upload representing the logo. Purpose must be business_logo. Required if type is file and disallowed otherwise.
branding_settings_logo_type	text	[en] The type of image for the logo. Must be one of file or url. Possible values: file = uploaded file image; url = image from URL.
branding_settings_logo_url	text	[en] The URL of the image. Present when type is url.
cancel_url	text	[en] If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
client_reference_id	text	[en] A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.
collected_information_business_name	text	[en] Customer’s business name for this Checkout Session…
collected_information_individual_name	text	[en] Customer’s individual name for this Checkout Session…
collected_information_shipping_details_address_city	text	[en] City, district, suburb, town, or village.
collected_information_shipping_details_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
collected_information_shipping_details_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
collected_information_shipping_details_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
collected_information_shipping_details_address_postal_code	text	[en] ZIP or postal code.
collected_information_shipping_details_address_state	text	[en] State, county, province, or region (ISO 3166-2).
collected_information_shipping_details_name	text	[en] Customer name.
consent_promotions	text	[en] If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session. Possible values: opt_in = customer opted in to promotions; opt_out = customer opted out of promotions.
consent_terms_of_service	text	[en] If accepted, the customer in this Checkout Session has agreed to the merchant's terms of service. Possible values: accepted = terms of service accepted.
consent_collection_payment_method_reuse_agreement_position	text	[en] Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI. Possible values: auto = position chosen by Stripe; hidden = reuse agreement hidden.
consent_collection_promotions	text	[en] If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants and US customers. Possible values: auto = collect promotional consent when applicable; none = promotional consent not collected.
consent_collection_terms_of_service	text	[en] If set to required, it requires customers to accept the terms of service before being able to pay. Possible values: none = terms acceptance not required; required = terms acceptance required.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
currency_conversion_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total of all items in source currency before discounts or taxes are applied.
currency_conversion_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total of all items in source currency after discounts and taxes are applied.
currency_conversion_fx_rate	text	[en] Exchange rate used to convert source currency amounts to customer currency amounts…
currency_conversion_source_currency	text	[en] Creation currency of the CheckoutSession before localization…
custom_text_after_submit_message	text	[en] Text can be up to 1200 characters in length.
custom_text_shipping_address_message	text	[en] Text can be up to 1200 characters in length.
custom_text_submit_message	text	[en] Text can be up to 1200 characters in length.
custom_text_terms_of_service_acceptance_message	text	[en] Text can be up to 1200 characters in length.
customer	text	[en] The ID of the customer for this Session. Customers > > id
customer_account	text	[en] The ID of the account for this Session.
customer_creation	text	[en] Configure whether a Checkout Session creates a Customer when the Checkout Session completes. Possible values: always = always creates a customer; if_required = creates customer only if required.
customer_details_address_city	text	[en] City, district, suburb, town, or village.
customer_details_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
customer_details_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
customer_details_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
customer_details_address_postal_code	text	[en] ZIP or postal code.
customer_details_address_state	text	[en] State, county, province, or region (ISO 3166-2).
customer_details_business_name	text	[en] The customer's business name after a completed Checkout Session.
customer_details_email	text	[en] The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
customer_details_individual_name	text	[en] The customer's individual name after a completed Checkout Session.
customer_details_name	text	[en] The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
customer_details_phone	text	[en] The customer's phone number after a completed Checkout Session.
customer_details_tax_exempt	text	[en] The customer’s tax exempt status after a completed Checkout Session. Possible values: exempt = customer tax exempt; none = customer not exempt; reverse = reverse charge: buyer accounts for the tax.
customer_email	text	[en] If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file.
expires_at	timestamp	[en] The timestamp at which the Checkout Session will expire. Date and time in UTC.
integration_identifier	text	[en] The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.
invoice	text	[en] ID of the invoice created by the Checkout Session, if it exists. Invoices > > id
invoice_creation_enabled	boolean	[en] Indicates whether invoice creation is enabled for the Checkout Session. Values: true (yes) or false (no).
invoice_creation_invoice_data_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
invoice_creation_invoice_data_footer	text	[en] Footer displayed on the invoice.
invoice_creation_invoice_data_issuer_account	text	[en] The connected account being referenced when type is account.
invoice_creation_invoice_data_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
invoice_creation_invoice_data_rendering_o_amount_tax_display	text	[en] How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
invoice_creation_invoice_data_rendering_options_template	text	[en] ID of the invoice rendering template to be used for the generated invoice.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
locale	text	[en] The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used. Possible values: auto = browser language (automatic); bg = Bulgarian; cs = Czech; da = Danish; de = German; el = Greek; en = English; en-GB = English (United Kingdom); es = Spanish; es-419 = Spanish (Latin America); et = Estonian; fi = Finnish; fil = Filipino; fr = French; fr-CA = French (Canada); hr = Croatian; hu = Hungarian; id = Indonesian; it = Italian; ja = Japanese; ko = Korean; lt = Lithuanian; lv = Latvian; ms = Malay; mt = Maltese; nb = Norwegian (Bokmål); nl = Dutch; pl = Polish; pt = Portuguese; pt-BR = Portuguese (Brazil); ro = Romanian; ru = Russian; sk = Slovak; sl = Slovenian; sv = Swedish; th = Thai; tr = Turkish; vi = Vietnamese; zh = Chinese (Simplified); zh-HK = Chinese (Hong Kong); zh-TW = Traditional Chinese (Taiwan).
managed_payments_enabled	boolean	[en] Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session. Values: true (yes) or false (no).
mode	text	[en] The mode of the Checkout Session. Possible values: payment = one-time payment; setup = save payment method for later; subscription = recurring subscription.
name_collection_business_enabled	boolean	[en] Indicates whether business name collection is enabled for the session… Values: true (yes) or false (no).
name_collection_business_optional	boolean	[en] Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false. Values: true (yes) or false (no).
name_collection_individual_enabled	boolean	[en] Indicates whether individual name collection is enabled for the session… Values: true (yes) or false (no).
name_collection_individual_optional	boolean	[en] Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false. Values: true (yes) or false (no).
origin_context	text	[en] Where the user is coming from. This informs the optimizations that are applied to the session. Possible values: mobile_app = user coming from a mobile app; web = user coming from the web.
payment_intent	text	[en] The ID of the PaymentIntent for Checkout Sessions in payment mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, expire the Checkout Session instead. Payment intents > > id
payment_link	text	[en] The ID of the Payment Link that created this Session. Payment links > > id
payment_method_collection	text	[en] Configure whether a Checkout Session should collect a payment method for sessions with mode payment. Defaults to always. Possible values: always = always collect a payment method; if_required = collect only if required.
payment_method_configuration_details_id	text	[en] ID of the payment method configuration used.
payment_method_configuration_details_parent	text	[en] ID of the parent payment method configuration used.
payment_status	text	[en] The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order. Possible values: no_payment_required = no payment required; paid = paid; unpaid = not paid.
permissions_update_shipping_details	text	[en] Determines which entity is allowed to update the shipping details. Default is client_only. Stripe Checkout client will automatically update the shipping details. If set to server_only, only your server is allowed to update the shipping details. This parameter is only supported when ui_mode=elements. Possible values: client_only = only the Checkout client updates shipping; server_only = only the server updates shipping.
phone_number_collection_enabled	boolean	[en] Indicates whether phone number collection is enabled for the session… Values: true (yes) or false (no).
presentment_details_presentment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this payment, denominated in presentment_currency.
presentment_details_presentment_currency	text	[en] Currency presented to the customer during payment.
recovered_from	text	[en] The ID of the original expired Checkout Session that triggered the recovery flow.
redirect_on_completion	text	[en] This parameter applies to ui_mode: embedded_page. Defaults to always. Possible values: always = always redirects on completion; if_required = redirects only if required; never = never redirects.
return_url	text	[en] Applies to Checkout Sessions with ui_mode: embedded_page or ui_mode: elements. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
saved_payment_method_options_payment_method_remove	text	[en] Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. Possible values: disabled = customer cannot remove saved methods; enabled = customer can remove saved methods.
saved_payment_method_options_payment_method_save	text	[en] Enable customers to choose if they wish to save their payment method for future use. Disabled by default. Possible values: disabled = saving payment method disabled; enabled = customer can save payment method.
setup_intent	text	[en] The ID of the SetupIntent for Checkout Sessions in setup mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, expire the Checkout Session instead. Setup intents > > id
shipping_cost_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost before any discounts or taxes are applied.
shipping_cost_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
shipping_cost_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost after discounts and taxes are applied.
shipping_cost_shipping_rate	text	[en] The ID of the ShippingRate for this order.
status	text	[en] The status of the Checkout Session, one of open, complete, or expired. Possible values: complete = complete; expired = expired; open = open, awaiting completion.
submit_type	text	[en] Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode. If blank or auto, pay is used. Possible values: auto = default button text (automatic); book = Book button; donate = Donate button; pay = Pay button; subscribe = Subscribe button.
subscription	text	[en] The ID of the Subscription for Checkout Sessions in subscription mode. Subscriptions > > id
success_url	text	[en] The URL the customer will be directed to after the payment or subscription creation is successful.
tax_id_collection_enabled	boolean	[en] Indicates whether tax ID collection is enabled for the session… Values: true (yes) or false (no).
tax_id_collection_required	text	[en] Indicates whether a tax ID is required on the payment page… Possible values: if_supported = required if supported; never = never required.
total_details_amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the discounts.
total_details_amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
total_details_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the tax amounts.
ui_mode	text	[en] The UI mode of the Session. Defaults to hosted_page. Possible values: elements = Elements components on your site; embedded_page = Checkout embedded in your site; form = embedded form; hosted_page = Stripe-hosted page.
url	text	[en] The URL to the Checkout Session. Applies to Checkout Sessions with ui_mode: hosted_page. Redirect customers to this URL to take them to Checkout. If you’re using Custom Domains, the URL will use your subdomain. Otherwise, it’ll use checkout.stripe.com.
wallet_options_link_display	text	[en] Describes whether Checkout should display Link. Defaults to auto. Possible values: auto = show Link when applicable; never = never show Link.

stripe_checkout_sessions_allowed_payment_method_types

Checkout sessions: allowed_payment_method_types (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] A list of the types of payment methods (e.g., card) this Checkout Session can accept.

stripe_checkout_sessions_custom_fields

Checkout sessions: custom_fields (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
dropdown_default_value	text	[en] The value that pre-fills on the payment page.
dropdown_value	text	[en] The option selected by the customer. This will be the value for the option.
key	text	[en] String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
label_custom	text	[en] Custom text for the label, displayed to the customer. Up to 100 characters.
label_type	text	[en] The type of the label. Possible values: custom = custom payment method.
numeric_default_value	text	[en] The value that pre-fills the field on the payment page.
numeric_maximum_length	int	[en] The maximum character length constraint for the customer's input.
numeric_minimum_length	int	[en] The minimum character length requirement for the customer's input.
numeric_value	text	[en] The value entered by the customer, containing only digits.
optional	boolean	[en] Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false. Values: true (yes) or false (no).
text_default_value	text	[en] The value that pre-fills the field on the payment page.
text_maximum_length	int	[en] The maximum character length constraint for the customer's input.
text_minimum_length	int	[en] The minimum character length requirement for the customer's input.
text_value	text	[en] The value entered by the customer.
type	text	[en] The type of the field. Possible values: dropdown = dropdown; numeric = numeric field; text = text field.

stripe_checkout_sessions_custom_fields_dropdown_options

Checkout sessions: custom_fields.dropdown.options (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_custom_fields, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
label	text	[en] The label for the option, displayed to the customer. Up to 100 characters.
value	text	[en] The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

stripe_checkout_sessions_customer_details_tax_ids

Checkout sessions: customer_details.tax_ids (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
type	text	[en] The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn,… Possible values: ad_nrt = NRT (Andorra); ae_trn = TRN (United Arab Emirates); al_tin = TIN (Albania); am_tin = TIN (Armenia); ao_tin = TIN (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Australia); au_arn = ARN (Australia); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijan); ba_tin = TIN (Bosnia and Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgaria); bh_vat = VAT (Bahrain); bj_ifu = IFU (Benin); bo_tin = TIN (Bolivia); br_cnpj = CNPJ (Brazil); br_cpf = CPF (Brazil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canada); ca_gst_hst = GST/HST (Canada); ca_pst_bc = PST British Columbia (Canada); ca_pst_mb = PST Manitoba (Canada); ca_pst_sk = PST Saskatchewan (Canada); ca_qst = QST Quebec (Canada); cd_nif = NIF (DR Congo); ch_uid = UID (Switzerland); ch_vat = VAT (Switzerland); cl_tin = TIN/RUT (Chile); cm_niu = NIU (Cameroon); cn_tin = TIN (China); co_nit = NIT (Colombia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cape Verde); de_stn = Steuernummer (Germany); do_rcn = RNC (Dominican Republic); ec_ruc = RUC (Ecuador); eg_tin = TIN (Egypt); es_cif = CIF/NIF (Spain); et_tin = TIN (Ethiopia); eu_oss_vat = OSS VAT (European Union); eu_vat = VAT (European Union); fo_vat = VAT (Faroe Islands); gb_vat = VAT (United Kingdom); ge_vat = VAT (Georgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guinea); hk_br = BR (Hong Kong); hr_oib = OIB (Croatia); hu_tin = TIN (Hungary); ic_nif = NIF (Canary Islands); id_npwp = NPWP (Indonesia); il_vat = VAT (Israel); in_gst = GSTIN (India); is_vat = VAT (Iceland); it_cf = Codice Fiscale (Italy); jp_cn = Corporate Number (Japan); jp_rn = Registered Foreign Business number (Japan); jp_trn = consumption tax TRN (Japan); ke_pin = KRA PIN (Kenya); kg_tin = TIN (Kyrgyzstan); kh_tin = TIN (Cambodia); kr_brn = BRN (South Korea); kz_bin = BIN (Kazakhstan); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT (Liechtenstein); lk_vat = VAT (Sri Lanka); ma_vat = VAT (Morocco); md_vat = VAT (Moldova); me_pib = PIB (Montenegro); mk_vat = VAT (North Macedonia); mr_nif = NIF (Mauritania); mx_rfc = RFC (Mexico); my_frp = FRP (Malaysia); my_itn = ITN (Malaysia); my_sst = SST (Malaysia); ng_tin = TIN (Nigeria); no_vat = VAT (Norway); no_voec = VOEC (Norway); np_pan = PAN (Nepal); nz_gst = GST (New Zealand); om_vat = VAT (Oman); pe_ruc = RUC (Peru); ph_tin = TIN (Philippines); pl_nip = NIP (Poland); py_ruc = RUC (Paraguay); ro_tin = TIN (Romania); rs_pib = PIB (Serbia); ru_inn = INN (Russia); ru_kpp = KPP (Russia); sa_vat = VAT (Saudi Arabia); sg_gst = GST (Singapore); sg_uen = UEN (Singapore); si_tin = TIN (Slovenia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT (Thailand); tj_tin = TIN (Tajikistan); tr_tin = TIN (Turkey); tw_vat = VAT (Taiwan); tz_vat = VAT (Tanzania); ua_vat = VAT (Ukraine); ug_tin = TIN (Uganda); unknown = unknown tax ID type; us_ein = EIN (US); uy_ruc = RUC (Uruguay); uz_tin = TIN (Uzbekistan); uz_vat = VAT (Uzbekistan); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnam); za_vat = VAT (South Africa); zm_tin = TIN (Zambia); zw_tin = TIN (Zimbabwe).
value	text	[en] The value of the tax ID.

stripe_checkout_sessions_discounts

Checkout sessions: discounts (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
coupon	text	[en] Coupon attached to the Checkout Session.
promotion_code	text	[en] Promotion code attached to the Checkout Session.

stripe_checkout_sessions_excluded_payment_method_types

Checkout sessions: excluded_payment_method_types (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] A list of the types of payment methods (e.g., card) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the Stripe Dashboard.

stripe_checkout_sessions_inv_invoice_dat_account_tax_ids

Checkout sessions: invoice_creation.invoice_data.account_tax_ids (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The account tax IDs associated with the invoice.

stripe_checkout_sessions_invo_invoice_data_custom_fields

Checkout sessions: invoice_creation.invoice_data.custom_fields (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_checkout_sessions_invoice_c_invoice_data_metadata

Checkout sessions: invoice_creation.invoice_data.metadata (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_checkout_sessions_metadata

Checkout sessions: metadata (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_checkout_sessions_optional_items

Checkout sessions: optional_items (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
adjustable_quantity_enabled	boolean	[en] Set to true if the quantity can be adjusted to any non-negative integer. Values: true (yes) or false (no).
adjustable_quantity_maximum	int	[en] The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
adjustable_quantity_minimum	int	[en] The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
price	text	[en] Identifier of the price of the optional item offered in Checkout.
quantity	int	[en] Initial quantity of the optional item offered in Checkout.

stripe_checkout_sessions_payment_method_options

Checkout sessions: payment_method_options (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
app_id	text	[en] The app ID registered with WeChat Pay. Only required when client is iOS or Android.
bank_transfer_eu_bank_transfer_country	text	[en] The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL. Possible values: BE = Belgium; DE = Germany; ES = Spain; FR = France; IE = Ireland; NL = Netherlands.
bank_transfer_type	text	[en] The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. Possible values: eu_bank_transfer = bank transfer (Eurozone); gb_bank_transfer = bank transfer (UK); jp_bank_transfer = bank transfer (Japan); mx_bank_transfer = bank transfer (Mexico); us_bank_transfer = bank transfer (US).
capture_method	text	[en] Controls when the funds will be captured from the customer's account. Possible values: manual = captured manually later.
client	text	[en] The client type that the end customer will pay from… Possible values: android = Android app; ios = iOS app; web = web browser.
currency	text	[en] Currency supported by the bank account. Returned when the Session is in setup mode. Possible values: cad = Canadian dollar; usd = US dollar.
expires_after_days	int	[en] The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
expires_after_seconds	int	[en] The number of seconds after which Pix payment will expire.
financial_connections_return_url	text	[en] For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
funding_type	text	[en] The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible values: bank_transfer = bank transfer.
installments_enabled	boolean	[en] Indicates if installments are enabled… Values: true (yes) or false (no).
mandate_options_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that will be collected. It is required when amount_type is fixed.
mandate_options_amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
mandate_options_amount_type	text	[en] The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible values: fixed = exact amount to charge; maximum = maximum amount to charge.
mandate_options_currency	text	[en] Three-letter ISO currency code, in lowercase.
mandate_options_custom_mandate_url	text	[en] A URL for custom mandate text…
mandate_options_description	text	[en] A description of the mandate or subscription that is meant to be displayed to the customer.
mandate_options_end_date	text	[en] Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
mandate_options_interval_description	text	[en] Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
mandate_options_payment_schedule	text	[en] Payment schedule for the mandate. Possible values: combined = combined: interval and sporadic; interval = at fixed intervals; sporadic = sporadic, on demand.
mandate_options_payments_per_period	int	[en] The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.
mandate_options_purpose	text	[en] The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support = dependant support; government = government payment; loan = loan; mortgage = mortgage; other = other purpose; pension = pension; personal = personal payment; retail = retail purchase; salary = salary; tax = tax payment; utility = utility bills.
mandate_options_reference	text	[en] Subscription name displayed to buyers in their bank app.
mandate_options_reference_prefix	text	[en] Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
mandate_options_start_date	text	[en] Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
mandate_options_transaction_type	text	[en] Transaction type of the mandate. Possible values: business = business transaction; personal = personal transaction.
preferred_locale	text	[en] Preferred locale of the PayPal checkout page that the customer is redirected to.
reference	text	[en] A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
request_extended_authorization	text	[en] Request ability to capture beyond the standard authorization validity window for this CheckoutSession. Possible values: if_available = request extended authorization if available; never = never request extended authorization.
request_incremental_authorization	text	[en] Request ability to increment the authorization for this CheckoutSession. Possible values: if_available = request incremental auth if available; never = never request incremental auth.
request_multicapture	text	[en] Request ability to make multiple captures for this CheckoutSession. Possible values: if_available = request multicapture if available; never = never request multicapture.
request_overcapture	text	[en] Request ability to overcapture for this CheckoutSession. Possible values: if_available = overcapture if available; never = never allow overcapture.
request_three_d_secure	text	[en] We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Possible values: any = request 3D Secure whenever possible; automatic = Stripe decides when 3D Secure is required; challenge = force a 3D Secure challenge.
setup_future_usage	text	[en] Indicates 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 to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. Possible values: none = not saved for future use; off_session = future use without customer present; on_session = future use with customer present.
statement_descriptor_suffix_kana	text	[en] Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters.
statement_descriptor_suffix_kanji	text	[en] Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters.
target_date	text	[en] Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
verification_method	text	[en] Bank account verification method. The default value is automatic. Possible values: automatic = automatic (instant or microdeposits); instant = instant verification; microdeposits = microdeposit verification.

stripe_checkout_sessions_pay_ban_requested_address_types

Checkout sessions: payment_method_options.bank_transfer.requested_address_types (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. Permitted values include: sort_code, zengin, iban, or spei. Possible values: aba = ABA (US); iban = IBAN; sepa = SEPA (Europe); sort_code = sort code (UK); spei = SPEI (Mexico); swift = SWIFT (international); zengin = Zengin (Japan).

stripe_checkout_sessions_pay_fin_fil_account_subcategori

Checkout sessions: payment_method_options.financial_connections.filters.account_subcategories (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible values: checking = checking account; savings = savings account.

stripe_checkout_sessions_pay_financial_conne_permissions

Checkout sessions: payment_method_options.financial_connections.permissions (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The list of permissions to request. The payment_method permission must be included. Possible values: balances = account balances; ownership = account ownership; payment_method = use as payment method; transactions = account transactions.

stripe_checkout_sessions_pay_financial_connecti_prefetch

Checkout sessions: payment_method_options.financial_connections.prefetch (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Data features requested to be retrieved upon account creation. Possible values: balances = balances; ownership = ownership; transactions = transactions.

stripe_checkout_sessions_pay_mandate_options_default_for

Checkout sessions: payment_method_options.mandate_options.default_for (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] List of Stripe products where this mandate can be selected automatically. Returned when the Session is in setup mode. Possible values: invoice = default for invoices; subscription = default for subscriptions.

stripe_checkout_sessions_pay_restrictions_brands_blocked

Checkout sessions: payment_method_options.restrictions.brands_blocked (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment. Possible values: american_express = American Express (brand); discover_global_network = Discover Global Network (brand); mastercard = Mastercard (brand); visa = Visa (brand).

stripe_checkout_sessions_pay_restr_funding_types_blocked

Checkout sessions: payment_method_options.restrictions.funding_types_blocked (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_sessions_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Card funding types to block for this Checkout Session. Supported values are credit, debit, and prepaid. Possible values: credit = credit cards blocked; debit = debit cards blocked; prepaid = prepaid cards blocked.

stripe_checkout_sessions_payment_method_types

Checkout sessions: payment_method_types (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.

stripe_checkout_sessions_saved_p_allow_redisplay_filters

Checkout sessions: saved_payment_method_options.allow_redisplay_filters (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. Possible values: always = can always be redisplayed; limited = limited redisplay; unspecified = unspecified.

stripe_checkout_sessions_shipping_addr_allowed_countries

Checkout sessions: shipping_address_collection.allowed_countries (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field

Type

checkout_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions).

Checkout sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI. Possible values: ISO 3166-1 alpha-2 country code (e.g. BR = Brazil, US = United States, PT = Portugal), among the 238 countries and territories Stripe supports.

stripe_checkout_sessions_shipping_cost_taxes

Checkout sessions: shipping_cost.taxes (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_checkout_sessions_shipping_options

Checkout sessions: shipping_options (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
shipping_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing how much to charge.
shipping_rate	text	[en] The shipping rate.

stripe_checkout_sessions_total_detai_breakdown_discounts

Checkout sessions: total_details.breakdown.discounts (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to. Related guide: Applying discounts to subscriptions…

stripe_checkout_sessions_total_details_breakdown_taxes

Checkout sessions: total_details.breakdown.taxes (one row per item; joins stripe_checkout_sessions by column checkout_session_id).

Field	Type
checkout_session_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_sessions). Checkout sessions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

Checkout sessions - Details - Line items

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

checkout_session_id → Checkout sessions > id
checkout_session_id > _checkout_session_line_items_discounts → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_discounts → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_metadata → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_metadata → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_pric_currency_options → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_pric_currency_options → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_price_currency__tiers → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_price_currency__tiers → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_price_metadata → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_price_metadata → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_price_tiers → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_price_tiers → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_taxes → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_taxes → Checkout sessions - Details - Line items > id
checkout_session_id > _checkout_session_line_items_taxes_rate_metadata → Checkout sessions > id
checkout_session_line_item_id > _checkout_session_line_items_taxes_rate_metadata → Checkout sessions - Details - Line items > id

Main object

Items purchased in each checkout session, with price, quantity and amounts.

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
id	text	[en] Unique identifier for the object.
adjustable_quantity_enabled	boolean	[en] Whether the customer can adjust the quantity of this item in Checkout. Values: true (yes) or false (no).
adjustable_quantity_maximum	int	[en] Maximum quantity the customer can choose for this item in Checkout.
adjustable_quantity_minimum	int	[en] Minimum quantity the customer can choose for this item in Checkout.
amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total discount amount applied. If no discounts were applied, defaults to 0.
amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied. If no tax was applied, defaults to 0.
amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
price_id	text	[en] Unique identifier for the object.
price_active	boolean	[en] Whether the price can be used for new purchases. Values: true (yes) or false (no).
price_billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
price_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
price_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
price_custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
price_custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
price_custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
price_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
price_lookup_key	text	[en] A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
price_nickname	text	[en] A brief description of the price, hidden from customers.
price_product	text	[en] The ID of the product this price is associated with.
price_recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
price_recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
price_recurring_meter	text	[en] The meter tracking the usage of a metered price…
price_recurring_usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.
price_tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
price_tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
price_transform_quantity_divide_by	int	[en] Divide usage by this number.
price_transform_quantity_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
price_type	text	[en] One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: one_time = one-time price; recurring = recurring price (subscription).
price_unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
price_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
quantity	int	[en] The quantity of products being purchased.

stripe_checkout_session_line_items_discounts

Checkout sessions - Details - Line items: discounts (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.
discount_checkout_session	text	[en] The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
discount_customer	text	[en] The ID of the customer associated with this discount.
discount_customer_account	text	[en] The ID of the account representing the customer associated with this discount.
discount_end	timestamp	[en] If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. Date and time in UTC.
discount_invoice	text	[en] The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
discount_invoice_item	text	[en] The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
discount_promotion_code	text	[en] The promotion code applied to create this discount.
discount_source_coupon	text	[en] The coupon that was redeemed to create this discount.
discount_source_type	text	[en] The source type of the discount. Possible values: coupon = coupon.
discount_start	timestamp	[en] Date that the coupon was applied. Date and time in UTC.
discount_subscription	text	[en] The subscription that this coupon is applied to, if it is applied to a particular subscription.
discount_subscription_item	text	[en] The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

stripe_checkout_session_line_items_metadata

Checkout sessions - Details - Line items: metadata (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_checkout_session_line_items_pric_currency_options

Checkout sessions - Details - Line items: price.currency_options (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_checkout_session_line_items_price_currency__tiers

Checkout sessions - Details - Line items: price.currency_options.tiers (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_session_line_items_pric_currency_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_checkout_session_line_items_price_metadata

Checkout sessions - Details - Line items: price.metadata (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_checkout_session_line_items_price_tiers

Checkout sessions - Details - Line items: price.tiers (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_checkout_session_line_items_taxes

Checkout sessions - Details - Line items: taxes (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Unique identifier for the object.
rate_active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
rate_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
rate_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
rate_description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
rate_display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
rate_effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
rate_flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
rate_flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
rate_inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
rate_jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
rate_jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
rate_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
rate_percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
rate_state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
rate_tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_checkout_session_line_items_taxes_rate_metadata

Checkout sessions - Details - Line items: taxes.rate.metadata (one row per item; joins stripe_checkout_session_line_items by column checkout_session_line_item_id).

Field	Type
checkout_session_id	text	[en] Identifier of the parent record (id column of table stripe_checkout_sessions). Checkout sessions > > id
checkout_session_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_checkout_session_line_items). Checkout sessions - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_checkout_session_line_items_taxes, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Connected accounts (Connect)

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

account_id > _connected_accounts_bus_minority_owned_business_de → Connected accounts (Connect) > id
account_id > _connected_accounts_future_requiremen_alternatives → Connected accounts (Connect) > id
account_id > _connected_accounts_fut_alt_alternative_fields_due → Connected accounts (Connect) > id
account_id > _connected_accounts_fut_altern_original_fields_due → Connected accounts (Connect) > id
account_id > _connected_accounts_future_requireme_currently_due → Connected accounts (Connect) > id
account_id > _connected_accounts_future_requirements_errors → Connected accounts (Connect) > id
account_id > _connected_accounts_future_requirem_eventually_due → Connected accounts (Connect) > id
account_id > _connected_accounts_future_requirements_past_due → Connected accounts (Connect) > id
account_id > _connected_accounts_future_re_pending_verification → Connected accounts (Connect) > id
account_id > _connected_accounts_metadata → Connected accounts (Connect) > id
account_id > _connected_accounts_requirements_alternatives → Connected accounts (Connect) > id
account_id > _connected_accounts_req_alt_alternative_fields_due → Connected accounts (Connect) > id
account_id > _connected_accounts_req_altern_original_fields_due → Connected accounts (Connect) > id
account_id > _connected_accounts_requirements_currently_due → Connected accounts (Connect) > id
account_id > _connected_accounts_requirements_errors → Connected accounts (Connect) > id
account_id > _connected_accounts_requirements_eventually_due → Connected accounts (Connect) > id
account_id > _connected_accounts_requirements_past_due → Connected accounts (Connect) > id
account_id > _connected_accounts_requireme_pending_verification → Connected accounts (Connect) > id
account_id > _connected_accounts_set_inv_default_account_tax_id → Connected accounts (Connect) > id
account_id > _connected_accounts_set_pay_sch_monthly_payout_day → Connected accounts (Connect) > id
account_id > _connected_accounts_set_pay_sch_weekly_payout_days → Connected accounts (Connect) > id
account_id > _connected_accounts_settings_payp_additional_files → Connected accounts (Connect) > id

Main object

Accounts connected to the platform (Stripe Connect), with onboarding status, capabilities and settings.

Field	Type
id	text	[en] Unique identifier for the object.
business_profile_annual_revenue_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing the amount.
business_profile_annual_revenue_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
business_profile_annual_revenue_fiscal_year_end	text	[en] The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
business_profile_estimated_worker_count	int	[en] An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
business_profile_mcc	text	[en] The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.
business_profile_monthly_estimated_revenue_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing how much to charge.
business_profile_monthly_estimated_revenue_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
business_profile_name	text	[en] The customer-facing business name.
business_profile_product_description	text	[en] Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
business_profile_specified_commercial_transactions_act_url	text	[en] A link to the business's publicly available terms related to the Specified Commercial Transaction Act. Only used for accounts in Japan.
business_profile_support_address_city	text	[en] City, district, suburb, town, or village.
business_profile_support_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
business_profile_support_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
business_profile_support_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
business_profile_support_address_postal_code	text	[en] ZIP or postal code.
business_profile_support_address_state	text	[en] State, county, province, or region (ISO 3166-2).
business_profile_support_email	text	[en] A publicly available email address for sending support issues to.
business_profile_support_phone	text	[en] A publicly available phone number to call with support issues.
business_profile_support_url	text	[en] A publicly available website for handling support issues.
business_profile_url	text	[en] The business's publicly available website.
business_type	text	[en] The business type. Possible values: company = company; government_entity = government entity; individual = individual; non_profit = non-profit organization.
capabilities_acss_debit_payments	text	[en] The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. Possible values: active = capability active: Canadian pre-authorized debits; inactive = capability inactive: Canadian pre-authorized debits; pending = capability pending: Canadian pre-authorized debits.
capabilities_affirm_payments	text	[en] The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. Possible values: active = can process Affirm; inactive = cannot process Affirm; pending = Affirm capability pending review.
capabilities_afterpay_clearpay_payments	text	[en] The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. Possible values: active = capability active: Afterpay Clearpay; inactive = capability inactive: Afterpay Clearpay; pending = capability pending: Afterpay Clearpay.
capabilities_alma_payments	text	[en] The status of the Alma capability of the account, or whether the account can directly process Alma payments. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_amazon_pay_payments	text	[en] The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. Possible values: active = can process Amazon Pay; inactive = cannot process Amazon Pay; pending = Amazon Pay capability pending review.
capabilities_app_distribution	text	[en] The status of the app_distribution capability of the account, or whether the platform can distribute apps to other accounts. Possible values: active = capability active: app distribution; inactive = capability inactive: app distribution; pending = capability pending: app distribution.
capabilities_au_becs_debit_payments	text	[en] The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_bacs_debit_payments	text	[en] The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_bancontact_payments	text	[en] The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. Possible values: active = can process Bancontact; inactive = cannot process Bancontact; pending = Bancontact capability pending review.
capabilities_bank_transfer_payments	text	[en] The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. Possible values: active = capability active: bank transfer; inactive = capability inactive: bank transfer; pending = capability pending: bank transfer.
capabilities_billie_payments	text	[en] The status of the Billie capability of the account, or whether the account can directly process Billie payments. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_bizum_payments	text	[en] The status of the Bizum capability of the account, or whether the account can directly process Bizum payments. Possible values: active = can process Bizum; inactive = cannot process Bizum; pending = Bizum capability pending review.
capabilities_blik_payments	text	[en] The status of the blik payments capability of the account, or whether the account can directly process blik charges. Possible values: active = capability active: BLIK; inactive = capability inactive: BLIK; pending = capability pending: BLIK.
capabilities_blik_recurring_payments	text	[en] The status of the BLIK recurring payments capability of the account, or whether the account can accept recurring and subscription BLIK payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_boleto_payments	text	[en] The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_card_issuing	text	[en] The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards… Possible values: active = capability active: card issuing (Issuing); inactive = capability inactive: card issuing (Issuing); pending = capability pending: card issuing (Issuing).
capabilities_card_payments	text	[en] The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_cartes_bancaires_payments	text	[en] The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_cashapp_payments	text	[en] The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. Possible values: active = can process Cash App Pay; inactive = cannot process Cash App Pay; pending = Cash App Pay capability pending review.
capabilities_crypto_payments	text	[en] The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_eps_payments	text	[en] The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_fpx_payments	text	[en] The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. Possible values: active = can process FPX; inactive = cannot process FPX; pending = FPX capability pending review.
capabilities_gb_bank_transfer_payments	text	[en] The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. Possible values: active = capability active: GBP bank transfer; inactive = capability inactive: GBP bank transfer; pending = capability pending: GBP bank transfer.
capabilities_giropay_payments	text	[en] The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_grabpay_payments	text	[en] The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_ideal_payments	text	[en] The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_india_international_payments	text	[en] The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_jcb_payments	text	[en] The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. Possible values: active = can process JCB; inactive = cannot process JCB; pending = JCB capability pending review.
capabilities_jp_bank_transfer_payments	text	[en] The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. Possible values: active = capability active: JPY bank transfer; inactive = capability inactive: JPY bank transfer; pending = capability pending: JPY bank transfer.
capabilities_kakao_pay_payments	text	[en] The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_klarna_payments	text	[en] The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_konbini_payments	text	[en] The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. Possible values: active = can process Konbini; inactive = cannot process Konbini; pending = Konbini capability pending review.
capabilities_kr_card_payments	text	[en] The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. Possible values: active = capability active: Korean cards (KrCard); inactive = capability inactive: Korean cards (KrCard); pending = capability pending: Korean cards (KrCard).
capabilities_legacy_payments	text	[en] The status of the legacy payments capability of the account. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_link_payments	text	[en] The status of the link_payments capability of the account, or whether the account can directly process Link charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_mb_way_payments	text	[en] The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. Possible values: active = can process MB WAY; inactive = cannot process MB WAY; pending = MB WAY capability pending review.
capabilities_mobilepay_payments	text	[en] The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_multibanco_payments	text	[en] The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. Possible values: active = can process Multibanco; inactive = cannot process Multibanco; pending = Multibanco capability pending review.
capabilities_mx_bank_transfer_payments	text	[en] The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. Possible values: active = capability active: MXN bank transfer; inactive = capability inactive: MXN bank transfer; pending = capability pending: MXN bank transfer.
capabilities_naver_pay_payments	text	[en] The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_nz_bank_account_becs_debit_payments	text	[en] The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_oxxo_payments	text	[en] The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. Possible values: active = can process OXXO; inactive = cannot process OXXO; pending = OXXO capability pending review.
capabilities_p24_payments	text	[en] The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. Possible values: active = capability active: Przelewy24 (P24); inactive = capability inactive: Przelewy24 (P24); pending = capability pending: Przelewy24 (P24).
capabilities_pay_by_bank_payments	text	[en] The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_payco_payments	text	[en] The status of the Payco capability of the account, or whether the account can directly process Payco payments. Possible values: active = can process Payco; inactive = cannot process Payco; pending = Payco capability pending review.
capabilities_paynow_payments	text	[en] The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_paypay_payments	text	[en] The status of the Paypay capability of the account, or whether the account can directly process Paypay payments. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_payto_payments	text	[en] The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. Possible values: active = can process PayTo; inactive = cannot process PayTo; pending = PayTo capability pending review.
capabilities_pix_payments	text	[en] The status of the pix payments capability of the account, or whether the account can directly process pix charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_promptpay_payments	text	[en] The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_revolut_pay_payments	text	[en] The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. Possible values: active = can process Revolut Pay; inactive = cannot process Revolut Pay; pending = Revolut Pay capability pending review.
capabilities_samsung_pay_payments	text	[en] The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. Possible values: active = capability active: Samsung Pay; inactive = capability inactive: Samsung Pay; pending = capability pending: Samsung Pay.
capabilities_satispay_payments	text	[en] The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_scalapay_payments	text	[en] The status of the Scalapay capability of the account, or whether the account can directly process Scalapay payments. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_sepa_bank_transfer_payments	text	[en] The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. Possible values: active = can process SEPA bank transfer; inactive = cannot process SEPA bank transfer; pending = SEPA bank transfer capability pending review.
capabilities_sepa_debit_payments	text	[en] The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. Possible values: active = capability active: SEPA Direct Debit; inactive = capability inactive: SEPA Direct Debit; pending = capability pending: SEPA Direct Debit.
capabilities_sequra_payments	text	[en] The status of the SeQura capability of the account, or whether the account can directly process SeQura payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_sofort_payments	text	[en] The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. Possible values: active = can process Sofort; inactive = cannot process Sofort; pending = Sofort capability pending review.
capabilities_sunbit_payments	text	[en] The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments. Possible values: active = capability active: Sunbit; inactive = capability inactive: Sunbit; pending = capability pending: Sunbit.
capabilities_swish_payments	text	[en] The status of the Swish capability of the account, or whether the account can directly process Swish payments. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_tax_reporting_us_1099_k	text	[en] The status of the tax reporting 1099-K (US) capability of the account. Possible values: active = capability active: 1099-K tax reporting (US); inactive = capability inactive: 1099-K tax reporting (US); pending = capability pending: 1099-K tax reporting (US).
capabilities_tax_reporting_us_1099_misc	text	[en] The status of the tax reporting 1099-MISC (US) capability of the account. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_transfers	text	[en] The status of the transfers capability of the account, or whether your platform can transfer funds to the account. Possible values: active = can receive transfers; inactive = cannot receive transfers; pending = transfers capability pending review.
capabilities_treasury	text	[en] The status of the banking capability, or whether the account can have bank accounts. Possible values: active = capability active: bank accounts (Treasury); inactive = capability inactive: bank accounts (Treasury); pending = capability pending: bank accounts (Treasury).
capabilities_twint_payments	text	[en] The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. Possible values: active = capability active; inactive = capability inactive; pending = capability pending verification.
capabilities_upi_payments	text	[en] The status of the upi payments capability of the account, or whether the account can directly process upi charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
capabilities_us_bank_account_ach_payments	text	[en] The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. Possible values: active = can process US bank account ACH; inactive = cannot process US bank account ACH; pending = US bank account ACH capability pending review.
capabilities_us_bank_transfer_payments	text	[en] The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. Possible values: active = capability active: USD bank transfer; inactive = capability inactive: USD bank transfer; pending = capability pending: USD bank transfer.
capabilities_zip_payments	text	[en] The status of the Zip capability of the account, or whether the account can directly process Zip charges. Possible values: active = capability active: can process; inactive = capability inactive: cannot process; pending = capability pending approval.
charges_enabled	boolean	[en] Whether the account can process charges. Values: true (yes) or false (no).
company_address_city	text	[en] City, district, suburb, town, or village.
company_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
company_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
company_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
company_address_postal_code	text	[en] ZIP or postal code.
company_address_state	text	[en] State, county, province, or region (ISO 3166-2).
company_address_kana_city	text	[en] City/Ward.
company_address_kana_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
company_address_kana_line1	text	[en] Block/Building number.
company_address_kana_line2	text	[en] Building details.
company_address_kana_postal_code	text	[en] ZIP or postal code.
company_address_kana_state	text	[en] Prefecture.
company_address_kana_town	text	[en] Town/cho-me.
company_address_kanji_city	text	[en] City/Ward.
company_address_kanji_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
company_address_kanji_line1	text	[en] Block/Building number.
company_address_kanji_line2	text	[en] Building details.
company_address_kanji_postal_code	text	[en] ZIP or postal code.
company_address_kanji_state	text	[en] Prefecture.
company_address_kanji_town	text	[en] Town/cho-me.
company_administrative_address_city	text	[en] City, district, suburb, town, or village.
company_administrative_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
company_administrative_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
company_administrative_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
company_administrative_address_postal_code	text	[en] ZIP or postal code.
company_administrative_address_state	text	[en] State, county, province, or region (ISO 3166-2).
company_directors_provided	boolean	[en] Whether the company's directors have been provided. This Boolean will be true if you've manually indicated that all directors are provided via the directors_provided parameter. Values: true (yes) or false (no).
company_directorship_declaration_date	timestamp	[en] The date marking when the directorship declaration attestation was made. Date and time in UTC.
company_directorship_declaration_ip	text	[en] The IP address from which the directorship declaration attestation was made.
company_directorship_declaration_user_agent	text	[en] The user-agent string from the browser where the directorship declaration attestation was made.
company_executives_provided	boolean	[en] Whether the company's executives have been provided. This Boolean will be true if you've manually indicated that all executives are provided via the executives_provided parameter, or if Stripe determined that sufficient executives were provided. Values: true (yes) or false (no).
company_export_license_id	text	[en] The export license ID number of the company, also referred as Import Export Code (India only).
company_export_purpose_code	text	[en] The purpose code to use for export transactions (India only).
company_name	text	[en] The company's legal name. Also available for accounts where controller.requirement_collection is stripe.
company_name_kana	text	[en] The Kana variation of the company's legal name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
company_name_kanji	text	[en] The Kanji variation of the company's legal name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
company_owners_provided	boolean	[en] Whether the company's owners have been provided. This Boolean will be true if you've manually indicated that all owners are provided via the owners_provided parameter, or if Stripe determined that sufficient owners were provided. Values: true (yes) or false (no).
company_ownership_declaration_date	timestamp	[en] The date marking when the beneficial owner attestation was made. Date and time in UTC.
company_ownership_declaration_ip	text	[en] The IP address from which the beneficial owner attestation was made.
company_ownership_declaration_user_agent	text	[en] The user-agent string from the browser where the beneficial owner attestation was made.
company_ownership_exemption_reason	text	[en] This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details. Possible values: qualified_entity_exceeds_ownership_threshold = qualified entity exceeds ownership threshold; qualifies_as_financial_institution = qualifies as a financial institution.
company_phone	text	[en] The company's phone number (used for verification).
company_principal_place_of_business_city	text	[en] City, district, suburb, town, or village.
company_principal_place_of_business_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
company_principal_place_of_business_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
company_principal_place_of_business_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
company_principal_place_of_business_postal_code	text	[en] ZIP or postal code.
company_principal_place_of_business_state	text	[en] State, county, province, or region (ISO 3166-2).
company_registration_date_day	int	[en] The day of registration, between 1 and 31.
company_registration_date_month	int	[en] The month of registration, between 1 and 12.
company_registration_date_year	int	[en] The four-digit year of registration.
company_representative_declaration_date	timestamp	[en] The date marking when the representative declaration attestation was made. Date and time in UTC.
company_representative_declaration_ip	text	[en] The IP address from which the representative declaration attestation was made.
company_representative_declaration_user_agent	text	[en] The user-agent string from the browser where the representative declaration attestation was made.
company_structure	text	[en] The category identifying the legal structure of the company or legal entity. Also available for accounts where controller.requirement_collection is stripe. See Business structure for more details. Possible values: free_zone_establishment = free zone establishment; free_zone_llc = free zone LLC; government_instrumentality = government instrumentality; governmental_unit = governmental unit; incorporated_non_profit = incorporated non-profit; incorporated_partnership = incorporated partnership; limited_liability_partnership = limited liability partnership (LLP); llc = limited liability company (LLC); multi_member_llc = multi-member LLC; private_company = private company; private_corporation = private corporation; private_partnership = private partnership; public_company = public company; public_corporation = public corporation; public_partnership = public partnership; registered_charity = registered charity; single_member_llc = single-member LLC; sole_establishment = sole establishment; sole_proprietorship = sole proprietorship; tax_exempt_government_instrumentality = tax-exempt government instrumentality; unincorporated_association = unincorporated association; unincorporated_non_profit = unincorporated non-profit; unincorporated_partnership = unincorporated partnership.
company_tax_id_provided	boolean	[en] Whether the company's business ID number was provided. Values: true (yes) or false (no).
company_tax_id_registrar	text	[en] The jurisdiction in which the tax_id is registered (Germany-based companies only).
company_vat_id_provided	boolean	[en] Whether the company's business VAT number was provided. Values: true (yes) or false (no).
company_verification_document_back	text	[en] The back of a document returned by a file upload with a purpose value of additional_verification. Note that additional_verification files are not downloadable.
company_verification_document_details	text	[en] A user-displayable string describing the verification state of this document.
company_verification_document_details_code	text	[en] One of document_corrupt, document_expired, document_failed_copy, document_failed_greyscale, document_failed_other, document_failed_test_mode, document_fraudulent, document_incomplete, document_invalid, document_manipulated, document_not_readable, document_not_uploaded, document_type_not_supported, or document_too_large.
company_verification_document_front	text	[en] The front of a document returned by a file upload with a purpose value of additional_verification. Note that additional_verification files are not downloadable.
controller_fees_payer	text	[en] A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Possible values: account = the account pays the fees; application = the Connect platform pays the fees; application_custom = platform pays (Custom accounts); application_express = platform pays (Express accounts).
controller_is_controller	boolean	[en] true if the Connect application retrieving the resource controls the account and can therefore exercise platform controls. Otherwise, this field is null. Values: true (yes) or false (no).
controller_losses_payments	text	[en] A value indicating who is liable when this account can't pay back negative balances from payments. Possible values: application = Connect platform is liable; stripe = Stripe is liable.
controller_requirement_collection	text	[en] A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. Possible values: application = Connect platform collects requirements; stripe = Stripe collects requirements.
controller_stripe_dashboard_type	text	[en] A value indicating the Stripe dashboard this account has access to independent of the Connect application. Possible values: express = Express Connect account; full = full Dashboard access; none = no account type.
controller_type	text	[en] The controller type. Can be application, if a Connect application controls the account, or account, if the account controls itself. Possible values: account = the account itself; application = Connect application.
country	text	[en] The account's country.
created	timestamp	[en] Time at which the account was connected. Date and time in UTC.
default_currency	text	[en] Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
details_submitted	boolean	[en] Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details. Values: true (yes) or false (no).
email	text	[en] An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
future_requirements_current_deadline	timestamp	[en] Date on which future_requirements becomes the main requirements hash and future_requirements becomes empty. After the transition, currently_due requirements may immediately become past_due, but the account may also be given a grace period depending on its enablement state prior to transitioning. Date and time in UTC.
future_requirements_disabled_reason	text	[en] This is typed as an enum for consistency with requirements.disabled_reason. Possible values: action_required.requested_capabilities = action required: request capabilities; listed = account on a restricted list; other = other reason; platform_paused = paused by the Connect platform; rejected.fraud = rejected for suspected fraud; rejected.incomplete_verification = rejected: incomplete verification; rejected.listed = rejected: on a restricted list; rejected.other = rejected for another reason; rejected.platform_fraud = rejected by platform for fraud; rejected.platform_other = rejected by platform, other reason; rejected.platform_terms_of_service = rejected by platform: terms violation; rejected.terms_of_service = rejected: terms of service violation; requirements.past_due = verification requirements past due; requirements.pending_verification = pending information verification; under_review = account under Stripe review.
groups_payments_pricing	text	[en] The group the account is in to determine their payments pricing, and null if the account is on customized pricing.
individual_id	text	[en] This is an object representing a person associated with a Stripe account.
payouts_enabled	boolean	[en] Whether the funds in this account can be paid out. Values: true (yes) or false (no).
requirements_current_deadline	timestamp	[en] Date by which the fields in currently_due must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. Date and time in UTC.
requirements_disabled_reason	text	[en] If the account is disabled, this enum describes why. Possible values: action_required.requested_capabilities = action required: request capabilities; listed = account on a restricted list; other = other reason; platform_paused = paused by the Connect platform; rejected.fraud = rejected for suspected fraud; rejected.incomplete_verification = rejected: incomplete verification; rejected.listed = rejected: on a restricted list; rejected.other = rejected for another reason; rejected.platform_fraud = rejected by platform for fraud; rejected.platform_other = rejected by platform, other reason; rejected.platform_terms_of_service = rejected by platform: terms violation; rejected.terms_of_service = rejected: terms of service violation; requirements.past_due = verification requirements past due; requirements.pending_verification = pending information verification; under_review = account under Stripe review.
settings_bacs_debit_payments_display_name	text	[en] The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business.
settings_bacs_debit_payments_service_user_number	text	[en] The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.
settings_branding_icon	text	[en] (ID of a file upload) An icon for the account. Must be square and at least 128px x 128px.
settings_branding_logo	text	[en] (ID of a file upload) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
settings_branding_primary_color	text	[en] A CSS hex color value representing the primary branding color for this account…
settings_branding_secondary_color	text	[en] A CSS hex color value representing the secondary branding color for this account…
settings_card_issuing_tos_acceptance_date	timestamp	[en] The date marking when the account representative accepted the service agreement. Date and time in UTC.
settings_card_issuing_tos_acceptance_ip	text	[en] The IP address from which the account representative accepted the service agreement.
settings_card_issuing_tos_acceptance_user_agent	text	[en] The user agent of the browser from which the account representative accepted the service agreement.
settings_card_payments_decline_on_avs_failure	boolean	[en] Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. Values: true (yes) or false (no).
settings_card_payments_decline_on_cvc_failure	boolean	[en] Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. Values: true (yes) or false (no).
settings_card_payments_statement_descriptor_prefix	text	[en] The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge. statement_descriptor_prefix is useful for maximizing descriptor space for the dynamic portion.
settings_card_payments_statement_descriptor_prefix_kana	text	[en] The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic statement_descriptor_suffix_kana specified on the charge.
settings_card_payments_statement_descriptor_prefix_kanji	text	[en] The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic statement_descriptor_suffix_kanji specified on the charge.
settings_dashboard_display_name	text	[en] The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.
settings_dashboard_timezone	text	[en] The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the IANA Time Zone Database.
settings_invoices_hosted_payment_method_save	text	[en] Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page. Possible values: always = always save the payment method; never = never save the payment method; offer = customer chooses whether to save it.
settings_payments_statement_descriptor	text	[en] The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge.
settings_payments_statement_descriptor_kana	text	[en] The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
settings_payments_statement_descriptor_kanji	text	[en] The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have special requirements.
settings_payouts_debit_negative_balances	boolean	[en] A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Understanding Connect account balances for details. The default value is false when controller.requirement_collection is application, which includes Custom accounts, otherwise true. Values: true (yes) or false (no).
settings_payouts_schedule_delay_days	int	[en] The number of days charges for the account will be held before being paid out.
settings_payouts_schedule_interval	text	[en] How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.
settings_payouts_schedule_monthly_anchor	int	[en] The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
settings_payouts_schedule_weekly_anchor	text	[en] The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if interval is weekly.
settings_payouts_statement_descriptor	text	[en] The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
settings_paypay_payments_goods_type	text	[en] The type of goods your business sells. Use digital_content if you sell digital content. Use other for all other types of goods or services. Possible values: digital_content = digital content; other = other goods or services.
settings_paypay_paymen_site_in_development_password_provided	boolean	[en] Field to indicate that the website password has been provided. Values: true (yes) or false (no).
settings_paypay_payments_site_in_development_username	text	[en] The username needed to access your business's website.
settings_paypay_payments_site_restricted_payment_flow_file	text	[en] File explaining the payment flow for your business.
settings_paypay_payments_site_type	text	[en] The status of your business's website. Possible values: accessible = website publicly accessible; in_development = website under development; restricted = website access restricted.
settings_sepa_debit_payments_creditor_id	text	[en] SEPA creditor identifier that identifies the company making the payment.
settings_treasury_tos_acceptance_date	timestamp	[en] The date marking when the account representative accepted the service agreement. Date and time in UTC.
settings_treasury_tos_acceptance_ip	text	[en] The IP address from which the account representative accepted the service agreement.
settings_treasury_tos_acceptance_user_agent	text	[en] The user agent of the browser from which the account representative accepted the service agreement.
tos_acceptance_date	timestamp	[en] The date marking when the account representative accepted their service agreement… Date and time in UTC.
tos_acceptance_ip	text	[en] The IP address from which the account representative accepted their service agreement…
tos_acceptance_service_agreement	text	[en] The user's service agreement type…
tos_acceptance_user_agent	text	[en] The user agent of the browser from which the account representative accepted their service agreement…
type	text	[en] The Stripe account type. Can be standard, express, custom, or none. Possible values: custom = custom payment method; express = Express Connect account; none = no account type; standard = Standard Connect account.

stripe_connected_accounts_bus_minority_owned_business_de

Connected accounts (Connect): business_profile.minority_owned_business_designation (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. Possible values: lgbtqi_owned_business = LGBTQI+-owned business; minority_owned_business = minority-owned business; none_of_these_apply = none of these apply; prefer_not_to_answer = prefer not to answer; women_owned_business = women-owned business.

stripe_connected_accounts_future_requiremen_alternatives

Connected accounts (Connect): future_requirements.alternatives (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

stripe_connected_accounts_fut_alt_alternative_fields_due

Connected accounts (Connect): future_requirements.alternatives.alternative_fields_due (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_connected_accounts_future_requiremen_alternatives, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Fields that can be provided to resolve all fields in original_fields_due.

stripe_connected_accounts_fut_altern_original_fields_due

Connected accounts (Connect): future_requirements.alternatives.original_fields_due (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_connected_accounts_future_requiremen_alternatives, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Fields that are due and can be resolved by providing all fields in alternative_fields_due.

stripe_connected_accounts_future_requireme_currently_due

Connected accounts (Connect): future_requirements.currently_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that need to be resolved to keep the account enabled. If not resolved by future_requirements[current_deadline], these fields will transition to the main requirements hash.

stripe_connected_accounts_future_requirements_errors

Connected accounts (Connect): future_requirements.errors (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
code	text	[en] The code for the type of error. Possible values: external_request = external verification request failed; information_missing = required information missing; invalid_address_city_state_postal_code = invalid city, state or postal code; invalid_address_cmra_address = commercial mail receiving agency address not allowed; invalid_address_highway_contract_box = highway contract box address not allowed; invalid_address_private_mailbox = private mailbox address not allowed; invalid_address_registered_agent_address = registered agent address not allowed; invalid_business_profile_name = invalid business profile name; invalid_business_profile_name_denylisted = business profile name is denylisted; invalid_company_name_denylisted = company name is denylisted; invalid_dob_age_over_maximum = date of birth over maximum age; invalid_dob_age_under_18 = person under 18 years old; invalid_dob_age_under_minimum = age under the required minimum; invalid_product_description_length = invalid product description length; invalid_product_description_url_match = product description matches the URL; invalid_representative_country = invalid representative country; invalid_signator = invalid signatory; invalid_statement_descriptor_business_mismatch = statement descriptor does not match business; invalid_statement_descriptor_denylisted = statement descriptor is denylisted; invalid_statement_descriptor_length = invalid statement descriptor length; invalid_statement_descriptor_prefix_denylisted = statement descriptor prefix is denylisted; invalid_statement_descriptor_prefix_mismatch = statement descriptor prefix mismatch; invalid_street_address = invalid street address; invalid_tax_id = invalid tax ID; invalid_tax_id_format = invalid tax ID format; invalid_tos_acceptance = invalid terms of service acceptance; invalid_url_denylisted = URL is denylisted; invalid_url_format = invalid URL format; invalid_url_web_presence_detected = web presence detected, URL required; invalid_url_website_business_information_mismatch = website does not match business info; invalid_url_website_empty = website is empty; invalid_url_website_inaccessible = website inaccessible; invalid_url_website_inaccessible_geoblocked = website geoblocked; invalid_url_website_inaccessible_password_protected = website password protected; invalid_url_website_incomplete = website incomplete; invalid_url_website_incomplete_cancellation_policy = website missing cancellation policy; invalid_url_website_incomplete_customer_service_details = website missing customer service details; invalid_url_website_incomplete_legal_restrictions = website missing legal restrictions; invalid_url_website_incomplete_refund_policy = website missing refund policy; invalid_url_website_incomplete_return_policy = website missing return policy; invalid_url_website_incomplete_terms_and_conditions = website missing terms and conditions; invalid_url_website_incomplete_under_construction = website under construction; invalid_url_website_other = website invalid (other reason); invalid_value_other = invalid value (other reason); unsupported_business_type = unsupported business type; verification_directors_mismatch = directors do not match registry; verification_document_address_mismatch = document address mismatch; verification_document_address_missing = document address missing; verification_document_corrupt = document file corrupt; verification_document_country_not_supported = document country not supported; verification_document_directors_mismatch = document directors mismatch; verification_document_dob_mismatch = document date of birth mismatch; verification_document_duplicate_type = duplicate document type submitted; verification_document_expired = document expired; verification_document_failed_copy = document is a copy; verification_document_failed_greyscale = document is greyscale; verification_document_failed_other = document failed (other reason); verification_document_failed_test_mode = document failed in test mode; verification_document_fraudulent = document fraudulent; verification_document_id_number_mismatch = document ID number mismatch; verification_document_id_number_missing = document ID number missing; verification_document_incomplete = document incomplete; verification_document_invalid = document invalid; verification_document_issue_or_expiry_date_missing = document issue or expiry date missing; verification_document_manipulated = document manipulated; verification_document_missing_back = document back side missing; verification_document_missing_front = document front side missing; verification_document_name_mismatch = document name mismatch; verification_document_name_missing = document name missing; verification_document_nationality_mismatch = document nationality mismatch; verification_document_not_readable = document not readable; verification_document_not_signed = document not signed; verification_document_not_uploaded = document not uploaded; verification_document_photo_mismatch = document photo mismatch; verification_document_too_large = document file too large; verification_document_type_not_supported = document type not supported; verification_extraneous_directors = extraneous directors provided; verification_failed_address_match = address match failed; verification_failed_authorizer_authority = authorizer authority not verified; verification_failed_business_iec_number = business IEC number not verified (India); verification_failed_document_match = document match failed; verification_failed_id_number_match = ID number match failed; verification_failed_keyed_identity = keyed-in identity not verified; verification_failed_keyed_match = keyed-in data match failed; verification_failed_name_match = name match failed; verification_failed_other = verification failed (other reason); verification_failed_representative_authority = representative authority not verified; verification_failed_residential_address = residential address not accepted; verification_failed_tax_id_match = tax ID match failed; verification_failed_tax_id_not_issued = tax ID not issued; verification_legal_entity_structure_mismatch = legal entity structure mismatch; verification_missing_directors = directors missing; verification_missing_executives = executives missing; verification_missing_owners = owners missing; verification_rejected_ownership_exemption_reason = ownership exemption reason rejected; verification_requires_additional_memorandum_of_associations = additional memorandum of association required; verification_requires_additional_proof_of_registration = additional proof of registration required; verification_supportability = business not supported by Stripe.
reason	text	[en] An informative message that indicates the error type and provides additional details about the error.
requirement	text	[en] The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

stripe_connected_accounts_future_requirem_eventually_due

Connected accounts (Connect): future_requirements.eventually_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well.

stripe_connected_accounts_future_requirements_past_due

Connected accounts (Connect): future_requirements.past_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that haven't been resolved by requirements.current_deadline. These fields need to be resolved to enable the capability on the account. future_requirements.past_due is a subset of requirements.past_due.

stripe_connected_accounts_future_re_pending_verification

Connected accounts (Connect): future_requirements.pending_verification (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives.

stripe_connected_accounts_metadata

Connected accounts (Connect): metadata (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_connected_accounts_requirements_alternatives

Connected accounts (Connect): requirements.alternatives (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

stripe_connected_accounts_req_alt_alternative_fields_due

Connected accounts (Connect): requirements.alternatives.alternative_fields_due (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_connected_accounts_requirements_alternatives, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Fields that can be provided to resolve all fields in original_fields_due.

stripe_connected_accounts_req_altern_original_fields_due

Connected accounts (Connect): requirements.alternatives.original_fields_due (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_connected_accounts_requirements_alternatives, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Fields that are due and can be resolved by providing all fields in alternative_fields_due.

stripe_connected_accounts_requirements_currently_due

Connected accounts (Connect): requirements.currently_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that need to be resolved to keep the account enabled. If not resolved by current_deadline, these fields will appear in past_due as well, and the account will be disabled.

stripe_connected_accounts_requirements_errors

Connected accounts (Connect): requirements.errors (one row per item; joins stripe_connected_accounts by column account_id).

Field	Type
account_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts). Connected accounts (Connect) > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
code	text	[en] The code for the type of error. Possible values: external_request = external verification request failed; information_missing = required information missing; invalid_address_city_state_postal_code = invalid city, state or postal code; invalid_address_cmra_address = commercial mail receiving agency address not allowed; invalid_address_highway_contract_box = highway contract box address not allowed; invalid_address_private_mailbox = private mailbox address not allowed; invalid_address_registered_agent_address = registered agent address not allowed; invalid_business_profile_name = invalid business profile name; invalid_business_profile_name_denylisted = business profile name is denylisted; invalid_company_name_denylisted = company name is denylisted; invalid_dob_age_over_maximum = date of birth over maximum age; invalid_dob_age_under_18 = person under 18 years old; invalid_dob_age_under_minimum = age under the required minimum; invalid_product_description_length = invalid product description length; invalid_product_description_url_match = product description matches the URL; invalid_representative_country = invalid representative country; invalid_signator = invalid signatory; invalid_statement_descriptor_business_mismatch = statement descriptor does not match business; invalid_statement_descriptor_denylisted = statement descriptor is denylisted; invalid_statement_descriptor_length = invalid statement descriptor length; invalid_statement_descriptor_prefix_denylisted = statement descriptor prefix is denylisted; invalid_statement_descriptor_prefix_mismatch = statement descriptor prefix mismatch; invalid_street_address = invalid street address; invalid_tax_id = invalid tax ID; invalid_tax_id_format = invalid tax ID format; invalid_tos_acceptance = invalid terms of service acceptance; invalid_url_denylisted = URL is denylisted; invalid_url_format = invalid URL format; invalid_url_web_presence_detected = web presence detected, URL required; invalid_url_website_business_information_mismatch = website does not match business info; invalid_url_website_empty = website is empty; invalid_url_website_inaccessible = website inaccessible; invalid_url_website_inaccessible_geoblocked = website geoblocked; invalid_url_website_inaccessible_password_protected = website password protected; invalid_url_website_incomplete = website incomplete; invalid_url_website_incomplete_cancellation_policy = website missing cancellation policy; invalid_url_website_incomplete_customer_service_details = website missing customer service details; invalid_url_website_incomplete_legal_restrictions = website missing legal restrictions; invalid_url_website_incomplete_refund_policy = website missing refund policy; invalid_url_website_incomplete_return_policy = website missing return policy; invalid_url_website_incomplete_terms_and_conditions = website missing terms and conditions; invalid_url_website_incomplete_under_construction = website under construction; invalid_url_website_other = website invalid (other reason); invalid_value_other = invalid value (other reason); unsupported_business_type = unsupported business type; verification_directors_mismatch = directors do not match registry; verification_document_address_mismatch = document address mismatch; verification_document_address_missing = document address missing; verification_document_corrupt = document file corrupt; verification_document_country_not_supported = document country not supported; verification_document_directors_mismatch = document directors mismatch; verification_document_dob_mismatch = document date of birth mismatch; verification_document_duplicate_type = duplicate document type submitted; verification_document_expired = document expired; verification_document_failed_copy = document is a copy; verification_document_failed_greyscale = document is greyscale; verification_document_failed_other = document failed (other reason); verification_document_failed_test_mode = document failed in test mode; verification_document_fraudulent = document fraudulent; verification_document_id_number_mismatch = document ID number mismatch; verification_document_id_number_missing = document ID number missing; verification_document_incomplete = document incomplete; verification_document_invalid = document invalid; verification_document_issue_or_expiry_date_missing = document issue or expiry date missing; verification_document_manipulated = document manipulated; verification_document_missing_back = document back side missing; verification_document_missing_front = document front side missing; verification_document_name_mismatch = document name mismatch; verification_document_name_missing = document name missing; verification_document_nationality_mismatch = document nationality mismatch; verification_document_not_readable = document not readable; verification_document_not_signed = document not signed; verification_document_not_uploaded = document not uploaded; verification_document_photo_mismatch = document photo mismatch; verification_document_too_large = document file too large; verification_document_type_not_supported = document type not supported; verification_extraneous_directors = extraneous directors provided; verification_failed_address_match = address match failed; verification_failed_authorizer_authority = authorizer authority not verified; verification_failed_business_iec_number = business IEC number not verified (India); verification_failed_document_match = document match failed; verification_failed_id_number_match = ID number match failed; verification_failed_keyed_identity = keyed-in identity not verified; verification_failed_keyed_match = keyed-in data match failed; verification_failed_name_match = name match failed; verification_failed_other = verification failed (other reason); verification_failed_representative_authority = representative authority not verified; verification_failed_residential_address = residential address not accepted; verification_failed_tax_id_match = tax ID match failed; verification_failed_tax_id_not_issued = tax ID not issued; verification_legal_entity_structure_mismatch = legal entity structure mismatch; verification_missing_directors = directors missing; verification_missing_executives = executives missing; verification_missing_owners = owners missing; verification_rejected_ownership_exemption_reason = ownership exemption reason rejected; verification_requires_additional_memorandum_of_associations = additional memorandum of association required; verification_requires_additional_proof_of_registration = additional proof of registration required; verification_supportability = business not supported by Stripe.
reason	text	[en] An informative message that indicates the error type and provides additional details about the error.
requirement	text	[en] The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

stripe_connected_accounts_requirements_eventually_due

Connected accounts (Connect): requirements.eventually_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and current_deadline becomes set.

stripe_connected_accounts_requirements_past_due

Connected accounts (Connect): requirements.past_due (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the account.

stripe_connected_accounts_requireme_pending_verification

Connected accounts (Connect): requirements.pending_verification (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives.

stripe_connected_accounts_set_inv_default_account_tax_id

Connected accounts (Connect): settings.invoices.default_account_tax_ids (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.

stripe_connected_accounts_set_pay_sch_monthly_payout_day

Connected accounts (Connect): settings.payouts.schedule.monthly_payout_days (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

int

[en] The days of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.

stripe_connected_accounts_set_pay_sch_weekly_payout_days

Connected accounts (Connect): settings.payouts.schedule.weekly_payout_days (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The days of the week when available funds are paid out, specified as an array, for example, [monday, tuesday]. Only shown if interval is weekly. Possible values: friday = Friday; monday = Monday; thursday = Thursday; tuesday = Tuesday; wednesday = Wednesday.

stripe_connected_accounts_settings_payp_additional_files

Connected accounts (Connect): settings.paypay_payments.additional_files (one row per item; joins stripe_connected_accounts by column account_id).

Field

Type

account_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_connected_accounts).

Connected accounts (Connect) > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Additional files that are required to support the onboarding process of your business.

Coupons

Replication type: Full

Relationships:

coupon_id > _coupons_applies_to_products → Coupons > id
coupon_id > _coupons_currency_options → Coupons > id
coupon_id > _coupons_metadata → Coupons > id

Main object

Discount coupons, with percentage or amount, duration and redemption limits.

Field	Type
id	text	[en] Unique identifier for the object.
amount_off	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
duration	text	[en] One of forever, once, or repeating. Describes how long a customer who applies this coupon will get the discount. Possible values: forever = discount applies forever; once = discount applies once; repeating = discount for a set number of months.
duration_in_months	int	[en] If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
max_redemptions	int	[en] Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
name	text	[en] Name of the coupon displayed to customers on for instance invoices or receipts.
percent_off	float	[en] 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 $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
redeem_by	timestamp	[en] Date after which the coupon can no longer be redeemed. Date and time in UTC.
times_redeemed	int	[en] Number of times this coupon has been applied to a customer.
valid	boolean	[en] Taking account of the above properties, whether this coupon can still be applied to a customer. Values: true (yes) or false (no).

stripe_coupons_applies_to_products

Coupons: applies_to.products (one row per item; joins stripe_coupons by column coupon_id).

Field

Type

coupon_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_coupons).

Coupons > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] A list of product IDs this coupon applies to…

stripe_coupons_currency_options

Coupons: currency_options (one row per item; joins stripe_coupons by column coupon_id).

Field

Type

coupon_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_coupons).

Coupons > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

amount_off

float

[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

stripe_coupons_metadata

Coupons: metadata (one row per item; joins stripe_coupons by column coupon_id).

Field

Type

coupon_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_coupons).

Coupons > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Credit notes

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
invoice → Invoices > id
credit_note_id > _credit_notes_discount_amounts → Credit notes > id
credit_note_id > _credit_notes_metadata → Credit notes > id
credit_note_id > _credit_notes_pretax_credit_amounts → Credit notes > id
credit_note_id > _credit_notes_refunds → Credit notes > id
credit_note_id > _credit_notes_shipping_cost_taxes → Credit notes > id
credit_note_id > _credit_notes_total_taxes → Credit notes > id

Main object

Credit notes issued against invoices, with amounts, reason and status.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the total amount of the credit note, including tax.
amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] ID of the customer. Customers > > id
customer_account	text	[en] ID of the account representing the customer.
customer_balance_transaction	text	[en] Customer balance transaction related to this credit note.
discount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the total amount of discount that was credited.
effective_at	timestamp	[en] The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. Date and time in UTC.
invoice	text	[en] ID of the invoice. Invoices > > id
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
memo	text	[en] Customer-facing text that appears on the credit note PDF.
number	text	[en] A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
out_of_band_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that was credited outside of Stripe.
pdf	text	[en] The link to download the PDF of the credit note.
post_payment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
pre_payment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
reason	text	[en] Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory… Possible values: duplicate = duplicate charge; fraudulent = fraudulent; order_change = order change; product_unsatisfactory = product unsatisfactory.
shipping_cost_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost before any taxes are applied.
shipping_cost_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
shipping_cost_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost after taxes are applied.
shipping_cost_shipping_rate	text	[en] The ID of the ShippingRate for this invoice.
status	text	[en] Status of this credit note, one of issued or void. Possible values: issued = issued; void = voided.
subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
subtotal_excluding_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the amount of the credit note, excluding all tax and invoice level discounts.
total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the total amount of the credit note, including tax and all discount.
total_excluding_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the total amount of the credit note, excluding tax, but including discounts.
type	text	[en] Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid. Possible values: mixed = both pre and post payment; post_payment = issued after invoice paid; pre_payment = issued before invoice paid.
voided_at	timestamp	[en] The time that the credit note was voided. Date and time in UTC.

stripe_credit_notes_discount_amounts

Credit notes: discount_amounts (one row per item; joins stripe_credit_notes by column credit_note_id).

Field	Type
credit_note_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes). Credit notes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the discount.
discount	text	[en] The discount that was applied to get this discount amount.

stripe_credit_notes_metadata

Credit notes: metadata (one row per item; joins stripe_credit_notes by column credit_note_id).

Field

Type

credit_note_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes).

Credit notes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_credit_notes_pretax_credit_amounts

Credit notes: pretax_credit_amounts (one row per item; joins stripe_credit_notes by column credit_note_id).

Field	Type
credit_note_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes). Credit notes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the pretax credit amount.
credit_balance_transaction	text	[en] The credit balance transaction that was applied to get this pretax credit amount.
discount	text	[en] The discount that was applied to get this pretax credit amount.
type	text	[en] Type of the pretax credit amount referenced. Possible values: credit_balance_transaction = credit balance transaction; discount = discount.

stripe_credit_notes_refunds

Credit notes: refunds (one row per item; joins stripe_credit_notes by column credit_note_id).

Field	Type
credit_note_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes). Credit notes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount_refunded	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the refund that applies to this credit note.
payment_record_refund_payment_record	text	[en] ID of the payment record.
payment_record_refund_refund_group	text	[en] ID of the refund group.
refund	text	[en] ID of the refund.
type	text	[en] Type of the refund, one of refund or payment_record_refund. Possible values: payment_record_refund = Payment Record refund; refund = refund.

stripe_credit_notes_shipping_cost_taxes

Credit notes: shipping_cost.taxes (one row per item; joins stripe_credit_notes by column credit_note_id).

Field	Type
credit_note_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes). Credit notes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_credit_notes_total_taxes

Credit notes: total_taxes (one row per item; joins stripe_credit_notes by column credit_note_id).

Field	Type
credit_note_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_notes). Credit notes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the tax.
tax_behavior	text	[en] Whether this tax is inclusive or exclusive. Possible values: exclusive = tax added on top of price; inclusive = tax included in price.
tax_rate_details_tax_rate	text	[en] ID of the tax rate…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_available = reason not available; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.
type	text	[en] The type of tax information. Possible values: tax_rate_details = tax rate details.

Credit notes - Details - Line items

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

credit_note_id → Credit notes > id
credit_note_id > _credit_note_lines_discount_amounts → Credit notes > id
credit_note_line_id > _credit_note_lines_discount_amounts → Credit notes - Details - Line items > id
credit_note_id > _credit_note_lines_metadata → Credit notes > id
credit_note_line_id > _credit_note_lines_metadata → Credit notes - Details - Line items > id
credit_note_id > _credit_note_lines_pretax_credit_amounts → Credit notes > id
credit_note_line_id > _credit_note_lines_pretax_credit_amounts → Credit notes - Details - Line items > id
credit_note_id > _credit_note_lines_tax_rates → Credit notes > id
credit_note_line_id > _credit_note_lines_tax_rates → Credit notes - Details - Line items > id
credit_note_id > _credit_note_lines_tax_rates_metadata → Credit notes > id
credit_note_line_id > _credit_note_lines_tax_rates_metadata → Credit notes - Details - Line items > id
credit_note_id > _credit_note_lines_taxes → Credit notes > id
credit_note_line_id > _credit_note_lines_taxes → Credit notes - Details - Line items > id

Main object

Line items of each credit note.

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
description	text	[en] Description of the item being credited.
discount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the discount being credited for this line item.
invoice_line_item	text	[en] ID of the invoice line item being credited…
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
quantity	int	[en] The number of units of product being credited.
type	text	[en] The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice. Possible values: custom_line_item = custom credit note line; invoice_line_item = refers to an invoice line.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The cost of each unit of product being credited.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.

stripe_credit_note_lines_discount_amounts

Credit notes - Details - Line items: discount_amounts (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the discount.
discount	text	[en] The discount that was applied to get this discount amount.

stripe_credit_note_lines_metadata

Credit notes - Details - Line items: metadata (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_credit_note_lines_pretax_credit_amounts

Credit notes - Details - Line items: pretax_credit_amounts (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the pretax credit amount.
credit_balance_transaction	text	[en] The credit balance transaction that was applied to get this pretax credit amount.
discount	text	[en] The discount that was applied to get this pretax credit amount.
type	text	[en] Type of the pretax credit amount referenced. Possible values: credit_balance_transaction = credit balance transaction; discount = discount.

stripe_credit_note_lines_tax_rates

Credit notes - Details - Line items: tax_rates (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_credit_note_lines_tax_rates_metadata

Credit notes - Details - Line items: tax_rates.metadata (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_credit_note_lines_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_credit_note_lines_taxes

Credit notes - Details - Line items: taxes (one row per item; joins stripe_credit_note_lines by column credit_note_line_id).

Field	Type
credit_note_id	text	[en] Identifier of the parent record (id column of table stripe_credit_notes). Credit notes > > id
credit_note_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_credit_note_lines). Credit notes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the tax.
tax_behavior	text	[en] Whether this tax is inclusive or exclusive. Possible values: exclusive = tax added on top of price; inclusive = tax included in price.
tax_rate_details_tax_rate	text	[en] ID of the tax rate…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_available = reason not available; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.
type	text	[en] The type of tax information. Possible values: tax_rate_details = tax rate details.

Current balance

Replication type: Full

Current Stripe account balance at read time: one row per balance type (available, pending, reserved, instant) and currency.

Field	Type
balance_type	text	[en] Balance type: available, pending, connect_reserved, instant_available, refund_and_dispute_prefunding_available / _pending and issuing_available.
currency	text	[en] Balance currency (three-letter ISO code, lowercase).
amount	float	[en] Balance amount in the currency's main unit, with decimals (e.g. 1234.56 = $1,234.56), already converted from Stripe's cents.
source_types_card	float	[en] Portion of the amount (in the currency's main unit) that came from cards.
source_types_bank_account	float	[en] Portion of the amount (in the currency's main unit) that came from bank accounts.
source_types_fpx	float	[en] Portion of the amount (in the currency's main unit) that came from FPX (Malaysia).
livemode	boolean	[en] true if the balance is from live mode; false if from test mode.
read_at	timestamp	[en] Date and time (UTC) when the balance was read.

Customers

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer_id > _customers_cash_balance_available → Customers > id
customer_id > _customers_invoice_credit_balance → Customers > id
customer_id > _customers_invoice_settings_custom_fields → Customers > id
customer_id > _customers_metadata → Customers > id
customer_id > _customers_preferred_locales → Customers > id

Main object

Customers registered in Stripe, with contact, address, balance, currency, invoice settings and delinquency. Customers change after creation: for an always-faithful copy, choose Full (Integral) replication.

Field	Type
id	text	[en] Unique identifier for the object.
address_city	text	[en] City, district, suburb, town, or village.
address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
address_postal_code	text	[en] ZIP or postal code.
address_state	text	[en] State, county, province, or region (ISO 3166-2).
balance	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The 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.
business_name	text	[en] The customer's business name.
cash_balance_customer	text	[en] The ID of the customer whose cash balance this object represents.
cash_balance_customer_account	text	[en] The ID of an Account representing a customer whose cash balance this object represents.
cash_balance_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
cash_balance_settings_reconciliation_mode	text	[en] The configuration for how funds that land in the customer cash balance are reconciled. Possible values: automatic = automatic reconciliation; manual = manual reconciliation.
cash_balance_settings_using_merchant_default	boolean	[en] A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance… Values: true (yes) or false (no).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes. Empty until the customer has a first subscription, invoice or balance.
customer_account	text	[en] The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.
default_source	text	[en] ID 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 field instead.
delinquent	boolean	[en] Tracks 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. Values: true (yes) or false (no).
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
discount_id	text	[en] The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.
discount_checkout_session	text	[en] The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
discount_customer	text	[en] The ID of the customer associated with this discount.
discount_customer_account	text	[en] The ID of the account representing the customer associated with this discount.
discount_end	timestamp	[en] If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. Date and time in UTC.
discount_invoice	text	[en] The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
discount_invoice_item	text	[en] The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
discount_promotion_code	text	[en] The promotion code applied to create this discount.
discount_source_coupon	text	[en] The coupon that was redeemed to create this discount.
discount_source_type	text	[en] The source type of the discount. Possible values: coupon = coupon.
discount_start	timestamp	[en] Date that the coupon was applied. Date and time in UTC.
discount_subscription	text	[en] The subscription that this coupon is applied to, if it is applied to a particular subscription.
discount_subscription_item	text	[en] The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
email	text	[en] The customer's email address.
individual_name	text	[en] The customer's individual name.
invoice_prefix	text	[en] The prefix for the customer used to generate unique invoice numbers.
invoice_settings_default_payment_method	text	[en] ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
invoice_settings_footer	text	[en] Default footer to be displayed on invoices for this customer.
invoice_settings_rendering_options_amount_tax_display	text	[en] How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
invoice_settings_rendering_options_template	text	[en] ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
name	text	[en] The customer's full name or business name.
next_invoice_sequence	int	[en] The 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.
phone	text	[en] The customer's phone number.
shipping_address_city	text	[en] City, district, suburb, town, or village.
shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
shipping_address_postal_code	text	[en] ZIP or postal code.
shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
shipping_carrier	text	[en] The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
shipping_name	text	[en] Recipient name.
shipping_phone	text	[en] Recipient phone (including extension).
shipping_tracking_number	text	[en] 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.
tax_automatic_tax	text	[en] Surfaces if automatic tax computation is possible given the current customer location information. Possible values: failed = automatic tax calculation failed; not_collecting = not collecting tax; supported = automatic tax supported; unrecognized_location = customer location not recognized.
tax_ip_address	text	[en] A recent IP address of the customer used for tax reporting and tax location inference.
tax_location_country	text	[en] The identified tax country of the customer.
tax_location_source	text	[en] The data source used to infer the customer's location. Possible values: billing_address = billing address; ip_address = IP address; payment_method = payment method details; shipping_destination = shipping destination.
tax_location_state	text	[en] The identified tax state, county, province, or region of the customer.
tax_provider	text	[en] The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider. Possible values: anrok = Anrok (tax provider); avalara = Avalara (tax provider); sphere = Sphere (tax provider); stripe = Stripe Tax (native calculation).
tax_exempt	text	[en] Describes 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". Possible values: exempt = customer tax exempt; none = customer not exempt; reverse = reverse charge: buyer accounts for the tax.
test_clock	text	[en] ID of the test clock that this customer belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.

stripe_customers_cash_balance_available

Customers: cash_balance.available (one row per item; joins stripe_customers by column customer_id).

Field

Type

customer_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_customers).

Customers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

float

[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented.

stripe_customers_invoice_credit_balance

Customers: invoice_credit_balance (one row per item; joins stripe_customers by column customer_id).

Field

Type

customer_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_customers).

Customers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

float

[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The 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.

stripe_customers_invoice_settings_custom_fields

Customers: invoice_settings.custom_fields (one row per item; joins stripe_customers by column customer_id).

Field	Type
customer_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customers). Customers > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_customers_metadata

Customers: metadata (one row per item; joins stripe_customers by column customer_id).

Field

Type

customer_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_customers).

Customers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_customers_preferred_locales

Customers: preferred_locales (one row per item; joins stripe_customers by column customer_id).

Field

Type

customer_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_customers).

Customers > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The customer's preferred locales (languages), ordered by preference.

Customers - Details - Customer balance transactions

Replication type: Full

Relationships:

customer_id → Customers > id
credit_note → Credit notes > id
customer → Customers > id
invoice → Invoices > id
customer_id > _customer_balance_transactions_metadata → Customers > id
customer_balance_transaction_id > _customer_balance_transactions_metadata → Customers - Details - Customer balance transactions > id

Main object

Transactions of each customer's credit balance (credits, debits and application to invoices).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's balance.
checkout_session	text	[en] The ID of the checkout session (if any) that created the transaction.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
credit_note	text	[en] The ID of the credit note (if any) related to the transaction. Credit notes > > id
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] The ID of the customer the transaction belongs to. Customers > > id
customer_account	text	[en] The ID of an Account representing a customer that the transaction belongs to.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
ending_balance	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
invoice	text	[en] The ID of the invoice (if any) related to the transaction. Invoices > > id
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
type	text	[en] Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. Possible values: adjustment = balance adjustment; applied_to_invoice = balance applied to an invoice; checkout_session_subscription_payment = Checkout subscription payment; checkout_session_subscription_payment_canceled = Checkout subscription payment canceled; credit_note = credit note; initial = initial balance; invoice_overpaid = invoice overpaid; invoice_too_large = invoice too large, credited back; invoice_too_small = invoice below chargeable minimum; migration = balance migration; unapplied_from_invoice = balance unapplied from invoice; unspent_receiver_credit = unspent receiver credit.

stripe_customer_balance_transactions_metadata

Customers - Details - Customer balance transactions: metadata (one row per item; joins stripe_customer_balance_transactions by column customer_balance_transaction_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
customer_balance_transaction_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_balance_transactions). Customers - Details - Customer balance transactions > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Customers - Details - Payment methods

Replication type: Full

Relationships:

customer_id → Customers > id
customer → Customers > id
customer_id > _customer_payment_methods_car_gen_payment_method_d → Customers > id
payment_method_id > _customer_payment_methods_car_gen_payment_method_d → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_car_gen_pay_preferred_lo → Customers > id
payment_method_id > _customer_payment_methods_car_gen_pay_preferred_lo → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_card_networks_available → Customers > id
payment_method_id > _customer_payment_methods_card_networks_available → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_card__networks_available → Customers > id
payment_method_id > _customer_payment_methods_card__networks_available → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_card_p_preferred_locales → Customers > id
payment_method_id > _customer_payment_methods_card_p_preferred_locales → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_inter_networks_available → Customers > id
payment_method_id > _customer_payment_methods_inter_networks_available → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_intera_preferred_locales → Customers > id
payment_method_id > _customer_payment_methods_intera_preferred_locales → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_metadata → Customers > id
payment_method_id > _customer_payment_methods_metadata → Customers - Details - Payment methods > id
customer_id > _customer_payment_methods_us_ba_networks_supported → Customers > id
payment_method_id > _customer_payment_methods_us_ba_networks_supported → Customers - Details - Payment methods > id

Main object

Payment methods saved on each customer (card, boleto, Pix, etc.), with billing details and, for cards, brand, last digits and expiry.

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
id	text	[en] Unique identifier for the object.
acss_debit_bank_name	text	[en] Name of the bank associated with the bank account.
acss_debit_fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
acss_debit_institution_number	text	[en] Institution number of the bank account.
acss_debit_last4	text	[en] Last four digits of the bank account number.
acss_debit_transit_number	text	[en] Transit number of the bank account.
allow_redisplay	text	[en] This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. Possible values: always = can always be redisplayed; limited = limited redisplay; unspecified = not specified.
au_becs_debit_bsb_number	text	[en] Six-digit number identifying bank and branch associated with this bank account.
au_becs_debit_fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
au_becs_debit_last4	text	[en] Last four digits of the bank account number.
bacs_debit_fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
bacs_debit_last4	text	[en] Last four digits of the bank account number.
bacs_debit_sort_code	text	[en] Sort code of the bank account. (e.g., 10-20-30)
billing_details_address_city	text	[en] City, district, suburb, town, or village.
billing_details_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
billing_details_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
billing_details_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
billing_details_address_postal_code	text	[en] ZIP or postal code.
billing_details_address_state	text	[en] State, county, province, or region (ISO 3166-2).
billing_details_email	text	[en] Email address.
billing_details_name	text	[en] Full name.
billing_details_phone	text	[en] Billing phone number (including extension).
billing_details_tax_id	text	[en] Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
bizum_buyer_id	text	[en] A unique identifier for the buyer as determined by the local payment processor.
blik_buyer_id	text	[en] A unique and immutable identifier assigned by BLIK to every buyer.
boleto_tax_id	text	[en] Uniquely identifies the customer tax id (CNPJ or CPF)
card_brand	text	[en] Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.
card_checks_address_line1_check	text	[en] If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.
card_checks_address_postal_code_check	text	[en] If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.
card_checks_cvc_check	text	[en] If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.
card_country	text	[en] 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.
card_display_brand	text	[en] The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.
card_exp_month	int	[en] Two-digit number representing the card's expiration month.
card_exp_year	int	[en] Four-digit number representing the card's expiration year.
card_fingerprint	text	[en] 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.
card_funding	text	[en] Card funding type. Can be credit, debit, prepaid, or unknown.
card_generated_from_charge	text	[en] The charge that created this object.
card_generated_from_payment_method_details_type	text	[en] The type of payment method transaction-specific details from the transaction that generated this card payment method. Always card_present.
card_generated_from_setup_attempt	text	[en] The ID of the SetupAttempt that generated this PaymentMethod, if any.
card_last4	text	[en] The last four digits of the card.
card_networks_preferred	text	[en] The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.
card_regulated_status	text	[en] Status of a card based on the card issuer. Possible values: regulated = regulated card (capped interchange); unregulated = unregulated card.
card_three_d_secure_usage_supported	boolean	[en] Whether 3D Secure is supported on this card. Values: true (yes) or false (no).
card_wallet_dynamic_last4	text	[en] (For tokenized numbers only.) The last four digits of the device account number.
card_wallet_masterpass_billing_address_city	text	[en] City, district, suburb, town, or village.
card_wallet_masterpass_billing_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
card_wallet_masterpass_billing_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
card_wallet_masterpass_billing_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
card_wallet_masterpass_billing_address_postal_code	text	[en] ZIP or postal code.
card_wallet_masterpass_billing_address_state	text	[en] State, county, province, or region (ISO 3166-2).
card_wallet_masterpass_email	text	[en] Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
card_wallet_masterpass_name	text	[en] Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
card_wallet_masterpass_shipping_address_city	text	[en] City, district, suburb, town, or village.
card_wallet_masterpass_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
card_wallet_masterpass_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
card_wallet_masterpass_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
card_wallet_masterpass_shipping_address_postal_code	text	[en] ZIP or postal code.
card_wallet_masterpass_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
card_wallet_type	text	[en] The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. Possible values: amex_express_checkout = Amex Express Checkout (wallet); apple_pay = Apple Pay (wallet); google_pay = Google Pay (wallet); link = Link (Stripe saved checkout); masterpass = Masterpass (wallet); samsung_pay = Samsung Pay (digital wallet); visa_checkout = Visa Checkout (wallet).
card_wallet_visa_checkout_billing_address_city	text	[en] City, district, suburb, town, or village.
card_wallet_visa_checkout_billing_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
card_wallet_visa_checkout_billing_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
card_wallet_visa_checkout_billing_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
card_wallet_visa_checkout_billing_address_postal_code	text	[en] ZIP or postal code.
card_wallet_visa_checkout_billing_address_state	text	[en] State, county, province, or region (ISO 3166-2).
card_wallet_visa_checkout_email	text	[en] Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
card_wallet_visa_checkout_name	text	[en] Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
card_wallet_visa_checkout_shipping_address_city	text	[en] City, district, suburb, town, or village.
card_wallet_visa_checkout_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
card_wallet_visa_checkout_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
card_wallet_visa_checkout_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
card_wallet_visa_checkout_shipping_address_postal_code	text	[en] ZIP or postal code.
card_wallet_visa_checkout_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
card_present_brand	text	[en] Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.
card_present_brand_product	text	[en] The product code that identifies the specific program or product associated with a card.
card_present_cardholder_name	text	[en] The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card.
card_present_country	text	[en] 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.
card_present_description	text	[en] A high-level description of the type of cards issued in this range.
card_present_exp_month	int	[en] Two-digit number representing the card's expiration month.
card_present_exp_year	int	[en] Four-digit number representing the card's expiration year.
card_present_fingerprint	text	[en] 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.
card_present_funding	text	[en] Card funding type. Can be credit, debit, prepaid, or unknown.
card_present_issuer	text	[en] The name of the card's issuing bank.
card_present_last4	text	[en] The last four digits of the card.
card_present_networks_preferred	text	[en] The preferred network for the card.
card_present_offline_stored_at	timestamp	[en] Time at which the payment was collected while offline… Date and time in UTC.
card_present_offline_type	text	[en] The method used to process this payment method offline. Only deferred is allowed. Possible values: deferred = deferred (offline) processing.
card_present_read_method	text	[en] How card details were read in this transaction. Possible values: contact_emv = chip inserted (EMV); contactless_emv = contactless (EMV); contactless_magstripe_mode = contactless magstripe mode; magnetic_stripe_fallback = magstripe fallback after chip failure; magnetic_stripe_track2 = magnetic stripe (track 2).
card_present_wallet_type	text	[en] The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown. Possible values: apple_pay = Apple Pay (wallet); google_pay = Google Pay (wallet); samsung_pay = Samsung Pay (digital wallet); unknown = unknown tax ID type.
cashapp_buyer_id	text	[en] A unique and immutable identifier assigned by Cash App to every buyer.
cashapp_cashtag	text	[en] A public identifier for buyers using Cash App.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
custom_display_name	text	[en] Display name of the Dashboard-only CustomPaymentMethodType.
custom_logo_content_type	text	[en] Content type of the Dashboard-only CustomPaymentMethodType logo.
custom_logo_url	text	[en] URL of the Dashboard-only CustomPaymentMethodType logo.
custom_type	text	[en] ID of the Dashboard-only CustomPaymentMethodType. Not expandable.
customer	text	[en] The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. Customers > > id
customer_account	text	[en] Identifier of the customer account (Accounts v2) this object belongs to, when the account uses Accounts v2.
eps_bank	text	[en] The customer's bank. Possible values: arzte_und_apotheker_bank; austrian_anadi_bank_ag; bank_austria; bankhaus_carl_spangler; bankhaus_schelhammer_und_schattera_ag; bawag_psk_ag; bks_bank_ag; brull_kallmus_bank_ag; btv_vier_lander_bank; capital_bank_grawe_gruppe_ag; deutsche_bank_ag; dolomitenbank; easybank_ag; erste_bank_und_sparkassen; hypo_alpeadriabank_international_ag; hypo_bank_burgenland_aktiengesellschaft; hypo_noe_lb_fur_niederosterreich_u_wien; hypo_oberosterreich_salzburg_steiermark; hypo_tirol_bank_ag; hypo_vorarlberg_bank_ag; marchfelder_bank; oberbank_ag; raiffeisen_bankengruppe_osterreich; schoellerbank_ag; sparda_bank_wien; volksbank_gruppe; volkskreditbank_ag; vr_bank_braunau.
fpx_bank	text	[en] The customer's bank, if provided. Possible values: affin_bank; agrobank; alliance_bank; ambank; bank_islam; bank_muamalat; bank_of_china; bank_rakyat; bnp_paribas; bsn; cimb; citibank; deutsche_bank; hong_leong_bank; hsbc; kfh; maybank2e; maybank2u; mbsb_bank; ocbc; pb_enterprise; public_bank; rhb; standard_chartered; uob.
ideal_bank	text	[en] The customer's bank, if provided. Can be one of abn_amro, adyen, asn_bank, bunq, buut, finom, handelsbanken, ing, knab, mollie, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe. Possible values: abn_amro; adyen; asn_bank; bunq; buut; finom; handelsbanken; ing; knab; mollie; moneyou; n26; nn; rabobank; regiobank; revolut; sns_bank; triodos_bank; van_lanschot; yoursafe.
ideal_bic	text	[en] The Bank Identifier Code of the customer's bank, if the bank was provided. Possible values: ABNANL2A; ADYBNL2A; ASNBNL21; BITSNL2A; BUNQNL2A; BUUTNL2A; FNOMNL22; FVLBNL22; HANDNL2A; INGBNL2A; KNABNL2H; MLLENL2A; MOYONL21; NNBANL2G; NTSBDEB1; RABONL2U; RBRBNL21; REVOIE23; REVOLT21; SNSBNL2A; TRIONL2U.
interac_present_brand	text	[en] Card brand. Can be interac, mastercard or visa.
interac_present_cardholder_name	text	[en] The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card.
interac_present_country	text	[en] 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.
interac_present_description	text	[en] A high-level description of the type of cards issued in this range.
interac_present_exp_month	int	[en] Two-digit number representing the card's expiration month.
interac_present_exp_year	int	[en] Four-digit number representing the card's expiration year.
interac_present_fingerprint	text	[en] 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.
interac_present_funding	text	[en] Card funding type. Can be credit, debit, prepaid, or unknown.
interac_present_issuer	text	[en] The name of the card's issuing bank.
interac_present_last4	text	[en] The last four digits of the card.
interac_present_networks_preferred	text	[en] The preferred network for the card.
interac_present_read_method	text	[en] How card details were read in this transaction. Possible values: contact_emv = chip inserted (EMV); contactless_emv = contactless (EMV); contactless_magstripe_mode = contactless magstripe mode; magnetic_stripe_fallback = magstripe fallback after chip failure; magnetic_stripe_track2 = magnetic stripe (track 2).
klarna_dob_day	int	[en] The day of birth, between 1 and 31.
klarna_dob_month	int	[en] The month of birth, between 1 and 12.
klarna_dob_year	int	[en] The four-digit year of birth.
kr_card_brand	text	[en] The local credit or debit card brand. Possible values: bc; citi; hana; hyundai; jeju; jeonbuk; kakaobank; kbank; kdbbank; kookmin; kwangju; lotte; mg; nh; post; samsung; savingsbank; shinhan; shinhyup; suhyup; tossbank; woori.
kr_card_last4	text	[en] The last four digits of the card. This may not be present for American Express cards.
link_email	text	[en] Account owner's email address.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
naver_pay_buyer_id	text	[en] Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
naver_pay_funding	text	[en] Whether to fund this transaction with Naver Pay points or a card. Possible values: card = funded by card; points = funded by Naver Pay points.
nz_bank_account_account_holder_name	text	[en] The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
nz_bank_account_bank_code	text	[en] The numeric code for the bank account's bank.
nz_bank_account_bank_name	text	[en] The name of the bank.
nz_bank_account_branch_code	text	[en] The numeric code for the bank account's bank branch.
nz_bank_account_last4	text	[en] Last four digits of the bank account number.
nz_bank_account_suffix	text	[en] The suffix of the bank account number.
p24_bank	text	[en] The customer's bank, if provided. Possible values: alior_bank; bank_millennium; bank_nowy_bfg_sa; bank_pekao_sa; banki_spbdzielcze; blik; bnp_paribas; boz; citi_handlowy; credit_agricole; envelobank; etransfer_pocztowy24; getin_bank; ideabank; ing; inteligo; mbank_mtransfer; nest_przelew; noble_pay; pbac_z_ipko; plus_bank; santander_przelew24; tmobile_usbugi_bankowe; toyota_bank; velobank; volkswagen_bank.
paypal_country	text	[en] Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
paypal_payer_email	text	[en] Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
paypal_payer_id	text	[en] PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
payto_bsb_number	text	[en] Bank-State-Branch number of the bank account.
payto_last4	text	[en] Last four digits of the bank account number.
payto_pay_id	text	[en] The PayID alias for the bank account.
pix_fingerprint	text	[en] Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same.
radar_options_session	text	[en] A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
sepa_debit_bank_code	text	[en] Bank code of bank associated with the bank account.
sepa_debit_branch_code	text	[en] Branch code of bank associated with the bank account.
sepa_debit_country	text	[en] Two-letter ISO code representing the country the bank account is located in.
sepa_debit_fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
sepa_debit_generated_from_charge	text	[en] The ID of the Charge that generated this PaymentMethod, if any.
sepa_debit_generated_from_setup_attempt	text	[en] The ID of the SetupAttempt that generated this PaymentMethod, if any.
sepa_debit_last4	text	[en] Last four characters of the IBAN.
sofort_country	text	[en] Two-letter ISO code representing the country the bank account is located in.
type	text	[en] The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Possible values: acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); card_present = in-person card (Terminal); cashapp = Cash App Pay (US); crypto = crypto (stablecoin); custom = custom payment method; customer_balance = customer cash balance (bank transfer); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); interac_present = in-person Interac card (Canada); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); kr_card = Korean card; link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); nz_bank_account = bank account debit (New Zealand); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); revolut_pay = Revolut Pay (digital wallet); samsung_pay = Samsung Pay (digital wallet); satispay = Satispay (mobile payment, Italy); scalapay = Scalapay (buy now pay later, Europe); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); sofort = Sofort (bank transfer, Europe); sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China); zip = Zip (buy now pay later).
upi_vpa	text	[en] Customer's unique Virtual Payment Address…
us_bank_account_account_holder_type	text	[en] Account holder type: individual or company. Possible values: company = company account holder; individual = individual account holder.
us_bank_account_account_type	text	[en] Account type: checkings or savings. Defaults to checking if omitted. Possible values: checking = checking account; savings = savings account.
us_bank_account_bank_name	text	[en] The name of the bank.
us_bank_account_financial_connections_account	text	[en] The ID of the Financial Connections Account used to create the payment method.
us_bank_account_fingerprint	text	[en] Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
us_bank_account_last4	text	[en] Last four digits of the bank account number.
us_bank_account_networks_preferred	text	[en] The preferred network.
us_bank_account_routing_number	text	[en] Routing number of the bank account.
us_bank_account_status_details_blocked_network_code	text	[en] The ACH network code that resulted in this block. Possible values: R02 = ACH R02: account closed; R03 = ACH R03: no account or unable to locate; R04 = ACH R04: invalid account number; R05 = ACH R05: unauthorized corporate debit; R07 = ACH R07: authorization revoked by customer; R08 = ACH R08: payment stopped; R10 = ACH R10: customer says unauthorized; R11 = ACH R11: entry not per authorization terms; R16 = ACH R16: account frozen; R20 = ACH R20: non-transaction account; R29 = ACH R29: corporate customer not authorized; R31 = ACH R31: permissible return, ODFI agrees.
us_bank_account_status_details_blocked_reason	text	[en] The reason why this PaymentMethod's fingerprint has been blocked… Possible values: bank_account_closed = bank account closed; bank_account_frozen = bank account frozen; bank_account_invalid_details = invalid bank account details; bank_account_restricted = bank account restricted; bank_account_unusable = bank account unusable; debit_not_authorized = debit not authorized by holder; tokenized_account_number_deactivated = tokenized account number deactivated.

stripe_customer_payment_methods_car_gen_payment_method_d

Customers - Details - Payment methods: card.generated_from.payment_method_details (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
amount_authorized	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The authorized amount…
brand	text	[en] Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.
brand_product	text	[en] The product code that identifies the specific program or product associated with a card.
capture_before	timestamp	[en] When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. Date and time in UTC.
cardholder_name	text	[en] The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card.
country	text	[en] 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.
description	text	[en] A high-level description of the type of cards issued in this range.
emv_auth_data	text	[en] Authorization response cryptogram.
exp_month	int	[en] Two-digit number representing the card's expiration month.
exp_year	int	[en] Four-digit number representing the card's expiration year.
fingerprint	text	[en] 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.
funding	text	[en] Card funding type. Can be credit, debit, prepaid, or unknown.
generated_card	text	[en] ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
incremental_authorization_supported	boolean	[en] Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support. Values: true (yes) or false (no).
issuer	text	[en] The name of the card's issuing bank.
last4	text	[en] The last four digits of the card.
location	text	[en] ID of the location that this transaction's reader is assigned to.
network	text	[en] Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.
network_transaction_id	text	[en] This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
offline_stored_at	timestamp	[en] Time at which the payment was collected while offline… Date and time in UTC.
offline_type	text	[en] The method used to process this payment method offline. Only deferred is allowed. Possible values: deferred = deferred (offline) processing.
overcapture_supported	boolean	[en] Defines whether the authorized amount can be over-captured or not… Values: true (yes) or false (no).
read_method	text	[en] How card details were read in this transaction. Possible values: contact_emv = chip inserted (EMV); contactless_emv = contactless (EMV); contactless_magstripe_mode = contactless magstripe mode; magnetic_stripe_fallback = magstripe fallback after chip failure; magnetic_stripe_track2 = magnetic stripe (track 2).
reader	text	[en] ID of the reader this transaction was made on.
receipt_account_type	text	[en] The type of account being debited or credited… Possible values: checking = checking account; credit = credit account; prepaid = prepaid account; unknown = unknown type.
receipt_application_cryptogram	text	[en] The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
receipt_application_preferred_name	text	[en] The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip.
receipt_authorization_code	text	[en] Identifier for this transaction.
receipt_authorization_response_code	text	[en] EMV tag 8A. A code returned by the card issuer.
receipt_cardholder_verification_method	text	[en] Describes the method used by the cardholder to verify ownership of the card. One of the following: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin, or signature.
receipt_dedicated_file_name	text	[en] Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
receipt_terminal_verification_results	text	[en] A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
receipt_transaction_status_information	text	[en] An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
wallet_type	text	[en] The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown. Possible values: apple_pay = Apple Pay (wallet); google_pay = Google Pay (wallet); samsung_pay = Samsung Pay (digital wallet); unknown = unknown tax ID type.

stripe_customer_payment_methods_car_gen_pay_preferred_lo

Customers - Details - Payment methods: card.generated_from.payment_method_details.preferred_locales (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_customer_payment_methods_car_gen_payment_method_d, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.

stripe_customer_payment_methods_card_networks_available

Customers - Details - Payment methods: card.networks.available (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] All networks available for selection via payment_method_options.card.network.

stripe_customer_payment_methods_card__networks_available

Customers - Details - Payment methods: card_present.networks.available (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] All networks available for selection via payment_method_options.card.network.

stripe_customer_payment_methods_card_p_preferred_locales

Customers - Details - Payment methods: card_present.preferred_locales (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.

stripe_customer_payment_methods_inter_networks_available

Customers - Details - Payment methods: interac_present.networks.available (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] All networks available for selection via payment_method_options.card.network.

stripe_customer_payment_methods_intera_preferred_locales

Customers - Details - Payment methods: interac_present.preferred_locales (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.

stripe_customer_payment_methods_metadata

Customers - Details - Payment methods: metadata (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_customer_payment_methods_us_ba_networks_supported

Customers - Details - Payment methods: us_bank_account.networks.supported (one row per item; joins stripe_customer_payment_methods by column payment_method_id).

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
payment_method_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_customer_payment_methods). Customers - Details - Payment methods > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] All supported networks. Possible values: ach = ACH (US); us_domestic_wire = US domestic wire.

Customers - Details - Tax IDs

Replication type: Full

Relationships:

customer_id → Customers > id
customer → Customers > id

Tax IDs (CNPJ, CPF, VAT, etc.) registered on each customer, with verification status.

Field	Type
customer_id	text	[en] Identifier of the parent record (id column of table stripe_customers). Customers > > id
id	text	[en] Unique identifier for the object.
country	text	[en] Two-letter ISO code representing the country of the tax ID.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
customer	text	[en] ID of the customer. Customers > > id
customer_account	text	[en] ID of the Account representing the customer.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
owner_account	text	[en] The account being referenced when type is account.
owner_application	text	[en] The Connect Application being referenced when type is application.
owner_customer	text	[en] The customer being referenced when type is customer.
owner_customer_account	text	[en] The Account representing the customer being referenced when type is customer.
owner_type	text	[en] Type of owner referenced. Possible values: account = the account itself; application = Connect application; customer = customer; self = self (the owner itself).
type	text	[en] Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_… Possible values: ad_nrt = NRT (Andorra); ae_trn = TRN (United Arab Emirates); al_tin = TIN (Albania); am_tin = TIN (Armenia); ao_tin = TIN (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Australia); au_arn = ARN (Australia); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijan); ba_tin = TIN (Bosnia and Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgaria); bh_vat = VAT (Bahrain); bj_ifu = IFU (Benin); bo_tin = TIN (Bolivia); br_cnpj = CNPJ (Brazil); br_cpf = CPF (Brazil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canada); ca_gst_hst = GST/HST (Canada); ca_pst_bc = PST British Columbia (Canada); ca_pst_mb = PST Manitoba (Canada); ca_pst_sk = PST Saskatchewan (Canada); ca_qst = QST Quebec (Canada); cd_nif = NIF (DR Congo); ch_uid = UID (Switzerland); ch_vat = VAT (Switzerland); cl_tin = TIN/RUT (Chile); cm_niu = NIU (Cameroon); cn_tin = TIN (China); co_nit = NIT (Colombia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cape Verde); de_stn = Steuernummer (Germany); do_rcn = RNC (Dominican Republic); ec_ruc = RUC (Ecuador); eg_tin = TIN (Egypt); es_cif = CIF/NIF (Spain); et_tin = TIN (Ethiopia); eu_oss_vat = OSS VAT (European Union); eu_vat = VAT (European Union); fo_vat = VAT (Faroe Islands); gb_vat = VAT (United Kingdom); ge_vat = VAT (Georgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guinea); hk_br = BR (Hong Kong); hr_oib = OIB (Croatia); hu_tin = TIN (Hungary); ic_nif = NIF (Canary Islands); id_npwp = NPWP (Indonesia); il_vat = VAT (Israel); in_gst = GSTIN (India); is_vat = VAT (Iceland); it_cf = Codice Fiscale (Italy); jp_cn = Corporate Number (Japan); jp_rn = Registered Foreign Business number (Japan); jp_trn = consumption tax TRN (Japan); ke_pin = KRA PIN (Kenya); kg_tin = TIN (Kyrgyzstan); kh_tin = TIN (Cambodia); kr_brn = BRN (South Korea); kz_bin = BIN (Kazakhstan); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT (Liechtenstein); lk_vat = VAT (Sri Lanka); ma_vat = VAT (Morocco); md_vat = VAT (Moldova); me_pib = PIB (Montenegro); mk_vat = VAT (North Macedonia); mr_nif = NIF (Mauritania); mx_rfc = RFC (Mexico); my_frp = FRP (Malaysia); my_itn = ITN (Malaysia); my_sst = SST (Malaysia); ng_tin = TIN (Nigeria); no_vat = VAT (Norway); no_voec = VOEC (Norway); np_pan = PAN (Nepal); nz_gst = GST (New Zealand); om_vat = VAT (Oman); pe_ruc = RUC (Peru); ph_tin = TIN (Philippines); pl_nip = NIP (Poland); py_ruc = RUC (Paraguay); ro_tin = TIN (Romania); rs_pib = PIB (Serbia); ru_inn = INN (Russia); ru_kpp = KPP (Russia); sa_vat = VAT (Saudi Arabia); sg_gst = GST (Singapore); sg_uen = UEN (Singapore); si_tin = TIN (Slovenia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT (Thailand); tj_tin = TIN (Tajikistan); tr_tin = TIN (Turkey); tw_vat = VAT (Taiwan); tz_vat = VAT (Tanzania); ua_vat = VAT (Ukraine); ug_tin = TIN (Uganda); unknown = unknown tax ID type; us_ein = EIN (US); uy_ruc = RUC (Uruguay); uz_tin = TIN (Uzbekistan); uz_vat = VAT (Uzbekistan); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnam); za_vat = VAT (South Africa); zm_tin = TIN (Zambia); zw_tin = TIN (Zimbabwe).
value	text	[en] Value of the tax ID.
verification_status	text	[en] Verification status, one of pending, verified, unverified, or unavailable. Possible values: pending = pending; unavailable = unavailable; unverified = unverified; verified = verified.
verification_verified_address	text	[en] Verified address.
verification_verified_name	text	[en] Verified name.

Disputes

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

charge → Charges > id
payment_intent → Payment intents > id
dispute_id > _disputes_balance_transactions → Disputes > id
dispute_id > _disputes_enhanced_eligibility_types → Disputes > id
dispute_id > _disputes_evi_enh_vis_prior_undisputed_transaction → Disputes > id
dispute_id > _disputes_evidence_detail_enh_vis_required_actions → Disputes > id
dispute_id > _disputes_metadata → Disputes > id
dispute_id > _disputes_payment_method_details → Disputes > id

Main object

Disputes (chargebacks) raised by cardholders, with amount, reason, status, evidence due date and submitted evidence. One row per dispute; joins the charge through the charge column.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
charge	text	[en] ID of the charge that's disputed. Charges > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
evidence_access_activity_log	text	[en] Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.
evidence_billing_address	text	[en] The billing address provided by the customer.
evidence_cancellation_policy	text	[en] (ID of a file upload) Your subscription cancellation policy, as shown to the customer.
evidence_cancellation_policy_disclosure	text	[en] An explanation of how and when the customer was shown your refund policy prior to purchase.
evidence_cancellation_rebuttal	text	[en] A justification for why the customer's subscription was not canceled.
evidence_customer_communication	text	[en] (ID of a file upload) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
evidence_customer_email_address	text	[en] The email address of the customer.
evidence_customer_name	text	[en] The name of the customer.
evidence_customer_purchase_ip	text	[en] The IP address that the customer used when making the purchase.
evidence_customer_signature	text	[en] (ID of a file upload) A relevant document or contract showing the customer's signature.
evidence_duplicate_charge_documentation	text	[en] (ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
evidence_duplicate_charge_explanation	text	[en] An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.
evidence_duplicate_charge_id	text	[en] The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
evidence_enhanced_evidence_mastercard_compl_fee_acknowledged	boolean	[en] A field acknowledging the fee incurred when countering a Mastercard compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Values: true (yes) or false (no).
evidence_enhanced_evidence_vis_disputed_customer_account_id	text	[en] User Account ID used to log into business platform. Must be recognizable by the user.
evidence_enhanced_eviden_vis_dis_customer_device_fingerprint	text	[en] Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
evidence_enhanced_evidence_vis_disputed_t_customer_device_id	text	[en] Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
evidence_enhanced_evidence_vis_disput_customer_email_address	text	[en] The email address of the customer.
evidence_enhanced_evidence_vis_disputed_customer_purchase_ip	text	[en] The IP address that the customer used when making the purchase.
evidence_enhanced_evidence_vis_dispu_merchandise_or_services	text	[en] Categorization of disputed payment. Possible values: merchandise = merchandise; services = services.
evidence_enhanced_evidence_vis_disputed_product_description	text	[en] A description of the product or service that was sold.
evidence_enhanced_evidence_vis_dispute_shipping_address_city	text	[en] City, district, suburb, town, or village.
evidence_enhanced_evidence_vis_disp_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
evidence_enhanced_evidence_vis_disput_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
evidence_enhanced_evidence_vis_disput_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
evidence_enhanced_evide_vis_dis_shipping_address_postal_code	text	[en] ZIP or postal code.
evidence_enhanced_evidence_vis_disput_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
evidence_enhanced_evidence_visa_compliance_fee_acknowledged	boolean	[en] A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Values: true (yes) or false (no).
evidence_product_description	text	[en] A description of the product or service that was sold.
evidence_receipt	text	[en] (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.
evidence_refund_policy	text	[en] (ID of a file upload) Your refund policy, as shown to the customer.
evidence_refund_policy_disclosure	text	[en] Documentation demonstrating that the customer was shown your refund policy prior to purchase.
evidence_refund_refusal_explanation	text	[en] A justification for why the customer is not entitled to a refund.
evidence_service_date	text	[en] The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
evidence_service_documentation	text	[en] (ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
evidence_shipping_address	text	[en] The address to which a physical product was shipped. You should try to include as complete address information as possible.
evidence_shipping_carrier	text	[en] 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.
evidence_shipping_date	text	[en] The date on which a physical product began its route to the shipping address, in a clear human-readable format.
evidence_shipping_documentation	text	[en] (ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
evidence_shipping_tracking_number	text	[en] 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.
evidence_uncategorized_file	text	[en] (ID of a file upload) Any additional evidence or statements.
evidence_uncategorized_text	text	[en] Any additional evidence or statements.
evidence_details_due_by	timestamp	[en] Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. Date and time in UTC.
evidence_details_enhanced_eligibility_mastercard_comp_status	text	[en] Mastercard compliance eligibility status. Possible values: fee_acknowledged = fee acknowledged by merchant; requires_fee_acknowledgement = requires fee acknowledgement.
evidence_details_enhanced_eligibility_visa_compelling_status	text	[en] Visa Compelling Evidence 3.0 eligibility status. Possible values: not_qualified = not qualified; qualified = qualified; requires_action = requires customer action (e.g. 3D Secure).
evidence_details_enhanced_eligibility_visa_compliance_status	text	[en] Visa compliance eligibility status. Possible values: fee_acknowledged = fee acknowledged by merchant; requires_fee_acknowledgement = requires fee acknowledgement.
evidence_details_has_evidence	boolean	[en] Whether evidence has been staged for this dispute. Values: true (yes) or false (no).
evidence_details_past_due	boolean	[en] 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. Values: true (yes) or false (no).
evidence_details_submission_count	int	[en] The number of times evidence has been submitted. Typically, you may only submit evidence once.
is_charge_refundable	boolean	[en] If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. Values: true (yes) or false (no).
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
payment_intent	text	[en] ID of the PaymentIntent that's disputed. Payment intents > > id
payment_method_details_type	text	[en] Payment method type. Possible values: amazon_pay = Amazon Pay (digital wallet); card = card (online); klarna = Klarna (payment method); paypal = PayPal (digital wallet).
reason	text	[en] Reason given by cardholder for dispute.
status	text	[en] The current status of a dispute. Possible values include:warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, lost, or prevented. Possible values: lost = lost by the merchant; needs_response = awaiting response with evidence; prevented = prevented before becoming a dispute; under_review = under review by the issuer; warning_closed = warning closed without escalation; warning_needs_response = inquiry awaiting response; warning_under_review = inquiry under review; won = won by the merchant.

stripe_disputes_balance_transactions

Disputes: balance_transactions (one row per item; joins stripe_disputes by column dispute_id).

Field

Type

dispute_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_disputes).

Disputes > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

id

text

[en] List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.

stripe_disputes_enhanced_eligibility_types

Disputes: enhanced_eligibility_types (one row per item; joins stripe_disputes by column dispute_id).

Field

Type

dispute_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_disputes).

Disputes > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] List of eligibility types that are included in enhanced_evidence. Possible values: mastercard_compliance = Mastercard compliance; visa_compelling_evidence_3 = Visa Compelling Evidence 3.0; visa_compliance = Visa compliance.

stripe_disputes_evi_enh_vis_prior_undisputed_transaction

Disputes: evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions (one row per item; joins stripe_disputes by column dispute_id).

Field	Type
dispute_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_disputes). Disputes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
charge	text	[en] Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
customer_account_id	text	[en] User Account ID used to log into business platform. Must be recognizable by the user.
customer_device_fingerprint	text	[en] Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
customer_device_id	text	[en] Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
customer_email_address	text	[en] The email address of the customer.
customer_purchase_ip	text	[en] The IP address that the customer used when making the purchase.
product_description	text	[en] A description of the product or service that was sold.
shipping_address_city	text	[en] City, district, suburb, town, or village.
shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
shipping_address_postal_code	text	[en] ZIP or postal code.
shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).

stripe_disputes_evidence_detail_enh_vis_required_actions

Disputes: evidence_details.enhanced_eligibility.visa_compelling_evidence_3.required_actions (one row per item; joins stripe_disputes by column dispute_id).

Field

Type

dispute_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_disputes).

Disputes > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission. Possible values: missing_customer_identifiers = missing customer identifiers; missing_disputed_transaction_description = missing disputed transaction description; missing_merchandise_or_services = missing merchandise or services; missing_prior_undisputed_transaction_description = missing prior undisputed transaction description; missing_prior_undisputed_transactions = missing prior undisputed transactions.

stripe_disputes_metadata

Disputes: metadata (one row per item; joins stripe_disputes by column dispute_id).

Field

Type

dispute_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_disputes).

Disputes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_disputes_payment_method_details

Disputes: payment_method_details (one row per item; joins stripe_disputes by column dispute_id).

Field	Type
dispute_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_disputes). Disputes > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
brand	text	[en] Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.
case_id	text	[en] The ID of the dispute in PayPal.
case_type	text	[en] The type of dispute opened. Different case types may have varying fees and financial impact. Possible values: block = block; chargeback = chargeback; compliance = card network compliance dispute; inquiry = issuer inquiry; resolution = resolution.
chargeback_loss_reason_code	text	[en] Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason…
dispute_type	text	[en] The AmazonPay dispute type, chargeback or claim… Possible values: chargeback = chargeback via bank; claim = Amazon A-to-z claim.
network	text	[en] Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.
network_reason_code	text	[en] The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The Network code map lists all available dispute reason codes by network.
reason_code	text	[en] The reason for the dispute as defined by Klarna…

Early fraud warnings

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

charge → Charges > id
payment_intent → Payment intents > id

Early fraud warnings sent by card networks (Radar), per charge.

Field	Type
id	text	[en] Unique identifier for the object.
actionable	boolean	[en] An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. Values: true (yes) or false (no).
charge	text	[en] ID of the charge this early fraud warning is for, optionally expanded. Charges > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
fraud_type	text	[en] The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
payment_intent	text	[en] ID of the Payment Intent this early fraud warning is for, optionally expanded. Payment intents > > id

Entitlement features

Replication type: Full

Relationships:

feature_id > _entitlements_features_metadata → Entitlement features > id

Main object

Features that can be granted to customers per product (Entitlements).

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Inactive features cannot be attached to new products and will not be returned from the features list endpoint. Values: true (yes) or false (no).
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
lookup_key	text	[en] A unique key you provide as your own system identifier. This may be up to 80 characters.
name	text	[en] The feature's name, for your own purpose, not meant to be displayable to the customer.

stripe_entitlements_features_metadata

Entitlement features: metadata (one row per item; joins stripe_entitlements_features by column feature_id).

Field

Type

feature_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_entitlements_features).

Entitlement features > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Events

Replication type: Incremental

Parameters:

Read start date: Stripe keeps only the last 30 days of events

Relationships:

event_id > _events_changes → Events > id

Main object

Account events (the same webhooks receive): type, date, the affected object's id and type, the full object and previous attributes as JSON (without secrets such as client_secret). Stripe keeps only the last 30 days, so this integration is always incremental and the table accumulates history; if the integration is stopped for more than 30 days, the gap no longer exists in Stripe.

Field	Type
id	text	[en] Unique identifier for the object.
account	text	[en] The connected account that originates the event.
api_version	text	[en] The Stripe API version used to render data when the event was created. The contents of data never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
context	text	[en] Authentication context needed to fetch the event or related object.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
pending_webhooks	int	[en] Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
request_id	text	[en] ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the dashboard, but currently not in the API.
request_idempotency_key	text	[en] The idempotency key transmitted during the request, if any. Note: This property is populated only for events on or after May 23, 2017.
type	text	[en] Description of the event (for example, invoice.created or charge.refunded).
data_object_id	text	[en] Identifier of the object the event is about.
data_object_object	text	[en] Type of the object the event is about (charge, invoice, customer...).

stripe_events_changes

Events: changes (one row per item; joins stripe_events by column event_id).

Field	Type
event_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_events). Events > > id
attribute	text	[en] Attribute that changed in this event, as a dotted path (e.g. status, items.data.0.quantity).
previous_value	text	[en] Value of the attribute before the event, as text.
new_value	text	[en] Value of the attribute after the event, as text.

Identity verification sessions

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

verification_session_id > _identity_verification_sessions_metadata → Identity verification sessions > id
verification_session_id > _identity_verification_sessions_opt_doc_allowed_ty → Identity verification sessions > id

Main object

Stripe Identity sessions (document and selfie verification), with status and outcome.

Field	Type
id	text	[en] Unique identifier for the object.
client_reference_id	text	[en] A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
last_error_code	text	[en] A short machine-readable string giving the reason for the verification or user-session failure. Possible values: abandoned = user abandoned the verification; consent_declined = user declined consent; country_not_supported = country not supported; device_not_supported = device not supported (no camera); document_expired = document expired; document_type_not_supported = document type not supported; document_unverified_other = document not verified (other reason); email_unverified_other = email not verified (other reason); email_verification_declined = user declined email verification; id_number_insufficient_document_data = insufficient data to verify ID number; id_number_mismatch = ID number mismatch; id_number_unverified_other = ID number not verified (other reason); phone_unverified_other = phone not verified (other reason); phone_verification_declined = user declined phone verification; selfie_document_missing_photo = document has no photo to match selfie; selfie_face_mismatch = selfie face does not match document; selfie_manipulated = selfie was manipulated; selfie_unverified_other = selfie not verified (other reason); under_supported_age = user under the supported age.
last_error_reason	text	[en] A message that explains the reason for verification or user-session failure.
last_verification_report	text	[en] ID of the most recent VerificationReport.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
options_document_require_id_number	boolean	[en] Collect an ID number and perform an ID number check with the document’s extracted name and date of birth. Values: true (yes) or false (no).
options_document_require_live_capture	boolean	[en] Disable image uploads, identity document images have to be captured using the device’s camera. Values: true (yes) or false (no).
options_document_require_matching_selfie	boolean	[en] Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Values: true (yes) or false (no).
options_email_require_verification	boolean	[en] Request one time password verification of provided_details.email. Values: true (yes) or false (no).
options_matching_dob	text	[en] Strictness of the DOB matching policy to apply. Possible values: none = no matching required; similar = similar match accepted.
options_matching_name	text	[en] Strictness of the name matching policy to apply. Possible values: none = no matching required; similar = similar match accepted.
options_phone_require_verification	boolean	[en] Request one time password verification of provided_details.phone. Values: true (yes) or false (no).
provided_details_email	text	[en] Email of user being verified…
provided_details_phone	text	[en] Phone number of user being verified…
redaction_status	text	[en] Indicates whether this object and its related objects have been redacted or not. Possible values: processing = processing; redacted = data redacted; validated = validated.
related_customer	text	[en] Customer ID…
related_customer_account	text	[en] The ID of the Account representing a customer.
related_person_account	text	[en] Token referencing the associated Account of the related Person resource.
related_person_person	text	[en] Token referencing the related Person resource.
status	text	[en] Status of this VerificationSession. Possible values: canceled = canceled; processing = processing; requires_input = requires further user input; verified = verified.
type	text	[en] The type of verification check to be performed. Possible values: document = document verification; id_number = ID number verification; verification_flow = configured verification flow.
verification_flow	text	[en] The configuration token of a verification flow from the dashboard.
verified_outputs_address_city	text	[en] City, district, suburb, town, or village.
verified_outputs_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
verified_outputs_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
verified_outputs_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
verified_outputs_address_postal_code	text	[en] ZIP or postal code.
verified_outputs_address_state	text	[en] State, county, province, or region (ISO 3166-2).
verified_outputs_dob_day	int	[en] Numerical day between 1 and 31.
verified_outputs_dob_month	int	[en] Numerical month between 1 and 12.
verified_outputs_dob_year	int	[en] The four-digit year.
verified_outputs_email	text	[en] The user's verified email address…
verified_outputs_first_name	text	[en] The user's verified first name.
verified_outputs_id_number	text	[en] The user's verified id number.
verified_outputs_id_number_type	text	[en] The user's verified id number type. Possible values: br_cpf = CPF (Brazil); sg_nric = NRIC (Singapore); us_ssn = SSN (US).
verified_outputs_last_name	text	[en] The user's verified last name.
verified_outputs_phone	text	[en] The user's verified phone number…
verified_outputs_sex	text	[en] The user's verified sex. Possible values: [redacted] = value redacted; female = female; male = male; unknown = unknown.
verified_outputs_unparsed_place_of_birth	text	[en] The user's verified place of birth as it appears in the document.
verified_outputs_unparsed_sex	text	[en] The user's verified sex as it appears in the document.

stripe_identity_verification_sessions_metadata

Identity verification sessions: metadata (one row per item; joins stripe_identity_verification_sessions by column verification_session_id).

Field

Type

verification_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_identity_verification_sessions).

Identity verification sessions > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_identity_verification_sessions_opt_doc_allowed_ty

Identity verification sessions: options.document.allowed_types (one row per item; joins stripe_identity_verification_sessions by column verification_session_id).

Field

Type

verification_session_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_identity_verification_sessions).

Identity verification sessions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. Possible values: driving_license = driving license; id_card = ID card; passport = passport.

Invoice items

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
invoice → Invoices > id
invoice_item_id > _invoice_items_discounts → Invoice items > id
invoice_item_id > _invoice_items_frozen_fields → Invoice items > id
invoice_item_id > _invoice_items_invoicing_rules → Invoice items > id
invoice_item_id > _invoice_items_metadata → Invoice items > id
invoice_item_id > _invoice_items_pro_credited_inv_invoice_line_items → Invoice items > id
invoice_item_id > _invoice_items_proration_details_discount_amounts → Invoice items > id
invoice_item_id > _invoice_items_tax_rates → Invoice items > id
invoice_item_id > _invoice_items_tax_rates_metadata → Invoice items > id

Main object

Invoice items added to customers, pending or already invoiced.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] The ID of the customer to bill for this invoice item. Customers > > id
customer_account	text	[en] The ID of the account to bill for this invoice item.
date	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
discountable	boolean	[en] If true, discounts will apply to this invoice item. Always false for prorations. Values: true (yes) or false (no).
invoice	text	[en] The ID of the invoice this invoice item belongs to. Invoices > > id
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
net_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount after discounts, but before credits and taxes. This field is null for discountable=true items.
parent_subscription_details_subscription	text	[en] The subscription that generated this invoice item…
parent_subscription_details_subscription_item	text	[en] The subscription item that generated this invoice item…
parent_type	text	[en] The type of parent that generated this invoice item… Possible values: subscription_details = generated by a subscription.
period_end	timestamp	[en] The end of the period, which must be greater than or equal to the start. This value is inclusive. Date and time in UTC.
period_start	timestamp	[en] The start of the period. This value is inclusive. Date and time in UTC.
pricing_price_details_price	text	[en] The ID of the price this item is associated with.
pricing_price_details_product	text	[en] The ID of the product this item is associated with.
pricing_type	text	[en] The type of the pricing details. Possible values: price_details = price details.
pricing_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
proration	boolean	[en] Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. Values: true (yes) or false (no).
proration_details_credited_items_invoice_item	text	[en] When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
proration_details_credited_items_invoice_line_item_d_invoice	text	[en] The invoice id for the debited line item(s).
proration_details_credited_items_type	text	[en] Whether the credit references a pending invoice item or one or more invoice line items on an invoice. Possible values: invoice_item = pending invoice item; invoice_line_items = invoice line items.
quantity	int	[en] Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version.
quantity_decimal	text	[en] Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
test_clock	text	[en] ID of the test clock this invoice item belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.

stripe_invoice_items_discounts

Invoice items: discounts (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field

Type

invoice_item_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items).

Invoice items > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

stripe_invoice_items_frozen_fields

Invoice items: frozen_fields (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field

Type

invoice_item_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items).

Invoice items > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Array of field names that can't be modified. Attempting to update a frozen field returns an error. Possible values: discounts = discounts frozen; pricing = pricing frozen; quantity = quantity frozen.

stripe_invoice_items_invoicing_rules

Invoice items: invoicing_rules (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field

Type

invoice_item_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items).

Invoice items > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

type

text

[en] The type of invoicing rule. Possible values: defer_until_credited_items_resolved = defer until credited items resolved.

stripe_invoice_items_metadata

Invoice items: metadata (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field

Type

invoice_item_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items).

Invoice items > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_invoice_items_pro_credited_inv_invoice_line_items

Invoice items: proration_details.credited_items.invoice_line_item_details.invoice_line_items (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field

Type

invoice_item_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items).

Invoice items > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.

stripe_invoice_items_proration_details_discount_amounts

Invoice items: proration_details.discount_amounts (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field	Type
invoice_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items). Invoice items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the discount.
discount	text	[en] The discount that was applied to get this discount amount.

stripe_invoice_items_tax_rates

Invoice items: tax_rates (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field	Type
invoice_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items). Invoice items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_invoice_items_tax_rates_metadata

Invoice items: tax_rates.metadata (one row per item; joins stripe_invoice_items by column invoice_item_id).

Field	Type
invoice_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_items). Invoice items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoice_items_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Invoice payments

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

invoice → Invoices > id

Payments applied to invoices, with amount paid, status and the originating payment.

Field	Type
id	text	[en] Unique identifier for the object.
amount_paid	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that was actually paid for this invoice. This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to.
amount_requested	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be paid toward this invoice.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
invoice	text	[en] The invoice that was paid. Invoices > > id
is_default	boolean	[en] Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly. Values: true (yes) or false (no).
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
payment_charge	text	[en] ID of the successful charge for this payment when type is charge. Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
payment_payment_intent	text	[en] ID of the PaymentIntent associated with this payment when type is payment_intent. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
payment_payment_record	text	[en] ID of the PaymentRecord associated with this payment when type is payment_record.
payment_type	text	[en] Type of payment object associated with this invoice payment. Possible values: charge = charge; payment_intent = PaymentIntent; payment_record = Payment Record.
status	text	[en] The status of the payment, one of open, paid, or canceled.
status_transitions_canceled_at	timestamp	[en] The time that the payment was canceled. Date and time in UTC.
status_transitions_paid_at	timestamp	[en] The time that the payment succeeded. Date and time in UTC.

Invoices

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
invoice_id > _invoices_account_tax_ids → Invoices > id
invoice_id > _invoices_custom_fields → Invoices > id
invoice_id > _invoices_customer_tax_ids → Invoices > id
invoice_id > _invoices_default_tax_rates → Invoices > id
invoice_id > _invoices_default_tax_rates_metadata → Invoices > id
invoice_id > _invoices_discounts → Invoices > id
invoice_id > _invoices_metadata → Invoices > id
invoice_id > _invoices_parent_subscription_details_metadata → Invoices > id
invoice_id > _invoices_payment_settings_payment_method_options → Invoices > id
invoice_id > _invoices_pay_pay_fin_filter_account_subcategories → Invoices > id
invoice_id > _invoices_payment_settings_pay_financi_permissions → Invoices > id
invoice_id > _invoices_payment_settings_pay_financial__prefetch → Invoices > id
invoice_id > _invoices_payment_settings_payment_method_types → Invoices > id
invoice_id > _invoices_shipping_cost_taxes → Invoices > id
invoice_id > _invoices_threshold_reason_item_reasons → Invoices > id
invoice_id > _invoices_threshold_rea_item_reasons_line_item_ids → Invoices > id
invoice_id > _invoices_total_discount_amounts → Invoices > id
invoice_id > _invoices_total_pretax_credit_amounts → Invoices > id
invoice_id > _invoices_total_taxes → Invoices > id

Main object

Invoices issued to customers, one-off or from subscriptions, with amounts, taxes, discounts, status and dates. For revenue use status = paid and amount_paid; for receivables use status = open and amount_remaining. Draft invoices were not charged and are not debt. Due date (due_date) only exists on invoices sent for payment (collection_method = send_invoice); with automatic charging it is empty.

Field	Type
id	text	[en] Unique identifier for the object. For preview invoices created using the create preview endpoint, this id will be prefixed with upcoming_in.
account_country	text	[en] The country of the business associated with this invoice, most often the business creating the invoice.
account_name	text	[en] The public name of the business associated with this invoice, most often the business creating the invoice.
amount_due	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. 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. Only a receivable when status = open; a draft invoice was not charged yet.
amount_overpaid	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
amount_paid	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount that was paid.
amount_paid_off_stripe	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that was paid on the invoice outside of Stripe.
amount_remaining	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The difference between amount_due and amount_paid. Only a receivable when status = open; a draft invoice was not charged yet and is not debt.
amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
application	text	[en] ID of the Connect Application that created the invoice.
attempt_count	int	[en] 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.
attempted	boolean	[en] Whether 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. Values: true (yes) or false (no).
auto_advance	boolean	[en] Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action. Values: true (yes) or false (no).
automatic_tax_disabled_reason	text	[en] If Stripe disabled automatic tax, this enum describes why. Possible values: finalization_requires_location_inputs = finalization requires location inputs; finalization_system_error = system error at finalization.
automatic_tax_enabled	boolean	[en] Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices. Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
automatic_tax_provider	text	[en] The tax provider powering automatic tax.
automatic_tax_status	text	[en] The status of the most recent automated tax calculation for this invoice. Possible values: complete = complete; failed = failed; requires_location_inputs = requires valid customer location.
automatically_finalizes_at	timestamp	[en] The 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. Date and time in UTC.
billing_reason	text	[en] Indicates 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. Possible values: automatic_pending_invoice_item_invoice = automatic pending invoice items invoice; manual = created manually, not from subscription; quote_accept = created by accepting a quote; subscription = subscription (legacy value); subscription_create = subscription creation; subscription_cycle = subscription cycle renewal; subscription_threshold = subscription usage threshold reached; subscription_update = subscription update; upcoming = preview of upcoming invoice.
collection_method	text	[en] Either 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. Possible values: charge_automatically = charged automatically to payment method; send_invoice = invoice emailed for customer to pay.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] The ID of the customer to bill. Customers > > id
customer_account	text	[en] The ID of the account representing the customer to bill.
customer_address_city	text	[en] City, district, suburb, town, or village.
customer_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
customer_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
customer_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
customer_address_postal_code	text	[en] ZIP or postal code.
customer_address_state	text	[en] State, county, province, or region (ISO 3166-2).
customer_email	text	[en] The 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.
customer_name	text	[en] The 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.
customer_phone	text	[en] The 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.
customer_shipping_address_city	text	[en] City, district, suburb, town, or village.
customer_shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
customer_shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
customer_shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
customer_shipping_address_postal_code	text	[en] ZIP or postal code.
customer_shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
customer_shipping_carrier	text	[en] The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
customer_shipping_name	text	[en] Recipient name.
customer_shipping_phone	text	[en] Recipient phone (including extension).
customer_shipping_tracking_number	text	[en] 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.
customer_tax_exempt	text	[en] The 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. Possible values: exempt = customer tax exempt; none = customer not exempt; reverse = reverse charge: buyer accounts for the tax.
default_payment_method	text	[en] ID 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.
default_source	text	[en] ID 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.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
due_date	timestamp	[en] The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically. Due date: only on invoices sent for payment (collection_method = send_invoice); empty with automatic charging. Date and time in UTC.
effective_at	timestamp	[en] The 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. Date and time in UTC.
ending_balance	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. 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.
footer	text	[en] Footer displayed on the invoice.
from_invoice_action	text	[en] The relation between this invoice and the cloned invoice…
from_invoice_invoice	text	[en] The invoice that was cloned.
hosted_invoice_url	text	[en] The 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.
invoice_pdf	text	[en] The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
issuer_account	text	[en] The connected account being referenced when type is account.
issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
last_finalization_error_advice_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
last_finalization_error_charge	text	[en] For card errors, the ID of the failed charge.
last_finalization_error_code	text	[en] For some errors that could be handled programmatically, a short string indicating the error code reported.
last_finalization_error_decline_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
last_finalization_error_doc_url	text	[en] A URL to more information about the error code reported.
last_finalization_error_message	text	[en] A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
last_finalization_error_network_advice_code	text	[en] For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
last_finalization_error_network_decline_code	text	[en] For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
last_finalization_error_param	text	[en] If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
last_finalization_error_payment_intent_id	text	[en] A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system.
last_finalization_error_payment_method_id	text	[en] PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.
last_finalization_error_payment_method_type	text	[en] If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
last_finalization_error_request_log_url	text	[en] A URL to the request log entry in your dashboard.
last_finalization_error_setup_intent_id	text	[en] A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
last_finalization_error_source_id	text	[en] The source object for errors returned on a request involving a source.
last_finalization_error_type	text	[en] The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error… Possible values: api_error = Stripe API internal error; card_error = card error (e.g. decline); idempotency_error = idempotency key error; invalid_request_error = invalid request.
latest_revision	text	[en] The ID of the most recent non-draft revision of this invoice…
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
next_payment_attempt	timestamp	[en] The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice. Date and time in UTC.
number	text	[en] A 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.
on_behalf_of	text	[en] The 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.
parent_quote_details_quote	text	[en] The quote that generated this invoice…
parent_subscription_details_subscription	text	[en] The subscription that generated this invoice…
parent_subscription_details_subscription_proration_date	timestamp	[en] Only set for upcoming invoices that preview prorations. The time used to calculate prorations. Date and time in UTC.
parent_type	text	[en] The type of parent that generated this invoice… Possible values: quote_details = generated by a quote; subscription_details = generated by a subscription.
payment_settings_default_mandate	text	[en] ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
period_end	timestamp	[en] The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price. Date and time in UTC.
period_start	timestamp	[en] The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price. Date and time in UTC.
post_payment_credit_notes_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total amount of all post-payment credit notes issued for this invoice.
pre_payment_credit_notes_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total amount of all pre-payment credit notes issued for this invoice.
receipt_number	text	[en] This is the transaction number that appears on email receipts sent for this invoice.
rendering_amount_tax_display	text	[en] How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
rendering_pdf_page_size	text	[en] Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. Possible values: a4 = A4 size; auto = automatic by customer locale; letter = US Letter size.
rendering_template	text	[en] ID of the rendering template that the invoice is formatted by.
rendering_template_version	int	[en] Version of the rendering template that the invoice is using.
shipping_cost_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost before any taxes are applied.
shipping_cost_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
shipping_cost_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total shipping cost after taxes are applied.
shipping_cost_shipping_rate	text	[en] The ID of the ShippingRate for this invoice.
shipping_details_address_city	text	[en] City, district, suburb, town, or village.
shipping_details_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
shipping_details_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
shipping_details_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
shipping_details_address_postal_code	text	[en] ZIP or postal code.
shipping_details_address_state	text	[en] State, county, province, or region (ISO 3166-2).
shipping_details_carrier	text	[en] The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
shipping_details_name	text	[en] Recipient name.
shipping_details_phone	text	[en] Recipient phone (including extension).
shipping_details_tracking_number	text	[en] 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.
starting_balance	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Starting 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.
statement_descriptor	text	[en] Extra information about an invoice for the customer's credit card statement.
status	text	[en] The status of the invoice, one of draft, open, paid, uncollectible, or void. For receivables: open = issued, awaiting payment; paid; uncollectible = written off; void = canceled, not to be charged; draft = not charged yet (not debt).
status_details_uncollectible_reason	text	[en] The reason why the invoice is uncollectible. Possible values: max_payment_attempts = max payment attempts reached; payment_not_received = payment not received; subscription_canceled = subscription canceled; subscription_paused = subscription paused; user_forgiven = debt forgiven by user.
status_transitions_finalized_at	timestamp	[en] The time that the invoice draft was finalized. Date and time in UTC.
status_transitions_marked_uncollectible_at	timestamp	[en] The time that the invoice was marked uncollectible. Date and time in UTC.
status_transitions_paid_at	timestamp	[en] The time that the invoice was paid. Date and time in UTC.
status_transitions_voided_at	timestamp	[en] The time that the invoice was voided. Date and time in UTC.
subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated…
subtotal_excluding_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated…
test_clock	text	[en] ID of the test clock this invoice belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.
threshold_reason_amount_gte	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The total invoice amount threshold boundary if it triggered the threshold invoice.
total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes.
total_excluding_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount representing the total amount of the invoice including all discounts but excluding all tax.
webhooks_delivered_at	timestamp	[en] Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. Date and time in UTC.

stripe_invoices_account_tax_ids

Invoices: account_tax_ids (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

stripe_invoices_custom_fields

Invoices: custom_fields (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_invoices_customer_tax_ids

Invoices: customer_tax_ids (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
type	text	[en] The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn,… Possible values: ad_nrt = NRT (Andorra); ae_trn = TRN (United Arab Emirates); al_tin = TIN (Albania); am_tin = TIN (Armenia); ao_tin = TIN (Angola); ar_cuit = CUIT (Argentina); au_abn = ABN (Australia); au_arn = ARN (Australia); aw_tin = TIN (Aruba); az_tin = TIN (Azerbaijan); ba_tin = TIN (Bosnia and Herzegovina); bb_tin = TIN (Barbados); bd_bin = BIN (Bangladesh); bf_ifu = IFU (Burkina Faso); bg_uic = UIC (Bulgaria); bh_vat = VAT (Bahrain); bj_ifu = IFU (Benin); bo_tin = TIN (Bolivia); br_cnpj = CNPJ (Brazil); br_cpf = CPF (Brazil); bs_tin = TIN (Bahamas); by_tin = TIN (Belarus); ca_bn = BN (Canada); ca_gst_hst = GST/HST (Canada); ca_pst_bc = PST British Columbia (Canada); ca_pst_mb = PST Manitoba (Canada); ca_pst_sk = PST Saskatchewan (Canada); ca_qst = QST Quebec (Canada); cd_nif = NIF (DR Congo); ch_uid = UID (Switzerland); ch_vat = VAT (Switzerland); cl_tin = TIN/RUT (Chile); cm_niu = NIU (Cameroon); cn_tin = TIN (China); co_nit = NIT (Colombia); cr_tin = TIN (Costa Rica); cv_nif = NIF (Cape Verde); de_stn = Steuernummer (Germany); do_rcn = RNC (Dominican Republic); ec_ruc = RUC (Ecuador); eg_tin = TIN (Egypt); es_cif = CIF/NIF (Spain); et_tin = TIN (Ethiopia); eu_oss_vat = OSS VAT (European Union); eu_vat = VAT (European Union); fo_vat = VAT (Faroe Islands); gb_vat = VAT (United Kingdom); ge_vat = VAT (Georgia); gi_tin = TIN (Gibraltar); gn_nif = NIF (Guinea); hk_br = BR (Hong Kong); hr_oib = OIB (Croatia); hu_tin = TIN (Hungary); ic_nif = NIF (Canary Islands); id_npwp = NPWP (Indonesia); il_vat = VAT (Israel); in_gst = GSTIN (India); is_vat = VAT (Iceland); it_cf = Codice Fiscale (Italy); jp_cn = Corporate Number (Japan); jp_rn = Registered Foreign Business number (Japan); jp_trn = consumption tax TRN (Japan); ke_pin = KRA PIN (Kenya); kg_tin = TIN (Kyrgyzstan); kh_tin = TIN (Cambodia); kr_brn = BRN (South Korea); kz_bin = BIN (Kazakhstan); la_tin = TIN (Laos); li_uid = UID (Liechtenstein); li_vat = VAT (Liechtenstein); lk_vat = VAT (Sri Lanka); ma_vat = VAT (Morocco); md_vat = VAT (Moldova); me_pib = PIB (Montenegro); mk_vat = VAT (North Macedonia); mr_nif = NIF (Mauritania); mx_rfc = RFC (Mexico); my_frp = FRP (Malaysia); my_itn = ITN (Malaysia); my_sst = SST (Malaysia); ng_tin = TIN (Nigeria); no_vat = VAT (Norway); no_voec = VOEC (Norway); np_pan = PAN (Nepal); nz_gst = GST (New Zealand); om_vat = VAT (Oman); pe_ruc = RUC (Peru); ph_tin = TIN (Philippines); pl_nip = NIP (Poland); py_ruc = RUC (Paraguay); ro_tin = TIN (Romania); rs_pib = PIB (Serbia); ru_inn = INN (Russia); ru_kpp = KPP (Russia); sa_vat = VAT (Saudi Arabia); sg_gst = GST (Singapore); sg_uen = UEN (Singapore); si_tin = TIN (Slovenia); sn_ninea = NINEA (Senegal); sr_fin = FIN (Suriname); sv_nit = NIT (El Salvador); th_vat = VAT (Thailand); tj_tin = TIN (Tajikistan); tr_tin = TIN (Turkey); tw_vat = VAT (Taiwan); tz_vat = VAT (Tanzania); ua_vat = VAT (Ukraine); ug_tin = TIN (Uganda); unknown = unknown tax ID type; us_ein = EIN (US); uy_ruc = RUC (Uruguay); uz_tin = TIN (Uzbekistan); uz_vat = VAT (Uzbekistan); ve_rif = RIF (Venezuela); vn_tin = TIN (Vietnam); za_vat = VAT (South Africa); zm_tin = TIN (Zambia); zw_tin = TIN (Zimbabwe).
value	text	[en] The value of the tax ID.

stripe_invoices_default_tax_rates

Invoices: default_tax_rates (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_invoices_default_tax_rates_metadata

Invoices: default_tax_rates.metadata (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoices_default_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_invoices_discounts

Invoices: discounts (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

stripe_invoices_metadata

Invoices: metadata (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_invoices_parent_subscription_details_metadata

Invoices: parent.subscription_details.metadata (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. *Note: This attribute is populated only for invoices created on or after June 29, 2023.*

stripe_invoices_payment_settings_payment_method_options

Invoices: payment_settings.payment_method_options (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
bank_transfer_eu_bank_transfer_country	text	[en] The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL. Possible values: BE = Belgium; DE = Germany; ES = Spain; FR = France; IE = Ireland; NL = Netherlands.
bank_transfer_type	text	[en] The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
company_details_registered_address_city	text	[en] City, district, suburb, town, or village.
company_details_registered_address_country	text	[en] Two-letter country code.
company_details_registered_address_line1	text	[en] Address line 1 (for example, street, PO Box, or company name).
company_details_registered_address_line2	text	[en] Address line 2 (for example, apartment, suite, unit, or building).
company_details_registered_address_postal_code	text	[en] ZIP or postal code.
company_details_registered_address_state	text	[en] State, county, province, or region.
company_details_registered_name	text	[en] Company or entity name.
company_details_registration_number	text	[en] The official registration number for the given registration type.
company_details_registration_type	text	[en] Type of registration the company or entity holds in their registered country. Possible values: ch_ein = company ID number (Switzerland); de_hrb = HRB commercial register (Germany); dk_cvr = CVR number (Denmark); es_cif = CIF tax code (Spain); fi_tunnus = Y-tunnus business ID (Finland); fr_siren = SIREN number (France); fr_siret = SIRET number (France); it_rea = REA register number (Italy); nl_kvk = KvK number (Netherlands); no_org_number = organization number (Norway); no_pno = personal number (Norway); se_org_number = organization number (Sweden); se_pno = personal number (Sweden); uk_crn = Companies House number (UK).
company_details_vat	text	[en] VAT ID number.
expires_after_seconds	int	[en] The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
funding_type	text	[en] The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible values: bank_transfer = bank transfer.
installments_enabled	boolean	[en] Whether Installments are enabled for this Invoice. Values: true (yes) or false (no).
mandate_options_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
mandate_options_amount_type	text	[en] Only maximum is supported. Possible values: fixed = exact amount to charge; maximum = maximum amount to charge.
mandate_options_description	text	[en] A description of the mandate or subscription that is meant to be displayed to the customer.
mandate_options_end_date	timestamp	[en] End date of the mandate or subscription. Date and time in UTC.
mandate_options_purpose	text	[en] The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support = dependant support; government = government payment; loan = loan; mortgage = mortgage; other = other purpose; pension = pension; personal = personal payment; retail = retail purchase; salary = salary; tax = tax payment; utility = utility bills.
mandate_options_transaction_type	text	[en] Transaction type of the mandate. Possible values: business = business transaction; personal = personal transaction.
preferred_language	text	[en] Preferred language of the Bancontact authorization page that the customer is redirected to. Possible values: de = German; en = English; fr = French; nl = Dutch.
reference	text	[en] An identifier or reference that this payment corresponds to.
request_three_d_secure	text	[en] We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Possible values: any = request 3D Secure whenever possible; automatic = Stripe decides when 3D Secure is required; challenge = force a 3D Secure challenge.
verification_method	text	[en] Bank account verification method. The default value is automatic. Possible values: automatic = automatic (instant or microdeposits); instant = instant verification; microdeposits = microdeposit verification.

stripe_invoices_pay_pay_fin_filter_account_subcategories

Invoices: payment_settings.payment_method_options.financial_connections.filters.account_subcategories (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoices_payment_settings_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible values: checking = checking account; savings = savings account.

stripe_invoices_payment_settings_pay_financi_permissions

Invoices: payment_settings.payment_method_options.financial_connections.permissions (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoices_payment_settings_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The list of permissions to request. The payment_method permission must be included. Possible values: balances = account balances; ownership = account ownership; payment_method = use as payment method; transactions = account transactions.

stripe_invoices_payment_settings_pay_financial__prefetch

Invoices: payment_settings.payment_method_options.financial_connections.prefetch (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoices_payment_settings_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Data features requested to be retrieved upon account creation. Possible values: balances = balances; ownership = ownership; transactions = transactions.

stripe_invoices_payment_settings_payment_method_types

Invoices: payment_settings.payment_method_types (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. Possible values: ach_credit_transfer = ACH credit transfer (US); ach_debit = ACH debit (US); acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); alipay = Alipay (digital wallet, China); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); cashapp = Cash App Pay (US); crypto = crypto (stablecoin); custom = custom payment method; customer_balance = customer cash balance (bank transfer); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); jp_credit_transfer = credit transfer (Japan); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); kr_card = Korean card; link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); nz_bank_account = bank account debit (New Zealand); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); revolut_pay = Revolut Pay (digital wallet); satispay = Satispay (mobile payment, Italy); sepa_credit_transfer = SEPA credit transfer; sepa_debit = SEPA Direct Debit (Europe); sofort = Sofort (bank transfer, Europe); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China).

stripe_invoices_shipping_cost_taxes

Invoices: shipping_cost.taxes (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_invoices_threshold_reason_item_reasons

Invoices: threshold_reason.item_reasons (one row per item; joins stripe_invoices by column invoice_id).

Field

Type

invoice_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_invoices).

Invoices > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

usage_gte

int

[en] The quantity threshold boundary that applied to the given line item.

stripe_invoices_threshold_rea_item_reasons_line_item_ids

Invoices: threshold_reason.item_reasons.line_item_ids (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_invoices_threshold_reason_item_reasons, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The IDs of the line items that triggered the threshold invoice.

stripe_invoices_total_discount_amounts

Invoices: total_discount_amounts (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the discount.
discount	text	[en] The discount that was applied to get this discount amount.

stripe_invoices_total_pretax_credit_amounts

Invoices: total_pretax_credit_amounts (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the pretax credit amount.
credit_balance_transaction	text	[en] The credit balance transaction that was applied to get this pretax credit amount.
discount	text	[en] The discount that was applied to get this pretax credit amount.
type	text	[en] Type of the pretax credit amount referenced. Possible values: credit_balance_transaction = credit balance transaction; discount = discount.

stripe_invoices_total_taxes

Invoices: total_taxes (one row per item; joins stripe_invoices by column invoice_id).

Field	Type
invoice_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoices). Invoices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the tax.
tax_behavior	text	[en] Whether this tax is inclusive or exclusive. Possible values: exclusive = tax added on top of price; inclusive = tax included in price.
tax_rate_details_tax_rate	text	[en] ID of the tax rate…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_available = reason not available; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.
type	text	[en] The type of tax information. Possible values: tax_rate_details = tax rate details.

Invoices - Details - Invoice line items

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

invoice_id → Invoices > id
invoice → Invoices > id
subscription → Subscriptions > id
invoice_id > _invoice_lines_discount_amounts → Invoices > id
invoice_line_id > _invoice_lines_discount_amounts → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_discounts → Invoices > id
invoice_line_id > _invoice_lines_discounts → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_metadata → Invoices > id
invoice_line_id > _invoice_lines_metadata → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_pare_inv_pro_cre_invoice_line_items → Invoices > id
invoice_line_id > _invoice_lines_pare_inv_pro_cre_invoice_line_items → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_pare_sub_pro_cre_invoice_line_items → Invoices > id
invoice_line_id > _invoice_lines_pare_sub_pro_cre_invoice_line_items → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_pretax_credit_amounts → Invoices > id
invoice_line_id > _invoice_lines_pretax_credit_amounts → Invoices - Details - Invoice line items > id
invoice_id > _invoice_lines_taxes → Invoices > id
invoice_line_id > _invoice_lines_taxes → Invoices - Details - Invoice line items > id

Main object

Line items of each invoice (all of them, not only the 10 embedded in the invoice), with amount, quantity, period and price.

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
discountable	boolean	[en] If true, discounts will apply to this line item. Always false for prorations. Values: true (yes) or false (no).
invoice	text	[en] The ID of the invoice that contains this line item. Invoices > > id
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
parent_invoice_item_details_invoice_item	text	[en] The invoice item that generated this line item…
parent_invoice_item_details_proration	boolean	[en] Whether this is a proration… Values: true (yes) or false (no).
parent_invoice_item_proration_details_credited_items_invoice	text	[en] Invoice containing the credited invoice line items…
parent_invoice_item_details_subscription	text	[en] The subscription that the invoice item belongs to…
parent_subscription_item_details_invoice_item	text	[en] The invoice item that generated this line item…
parent_subscription_item_details_proration	boolean	[en] Whether this is a proration… Values: true (yes) or false (no).
parent_subscription_proration_details_credited_items_invoice	text	[en] Invoice containing the credited invoice line items…
parent_subscription_item_details_subscription	text	[en] The subscription that the subscription item belongs to…
parent_subscription_item_details_subscription_item	text	[en] The subscription item that generated this line item…
parent_type	text	[en] The type of parent that generated this line item… Possible values: invoice_item_details = generated by an invoice item; subscription_item_details = generated by a subscription item.
period_end	timestamp	[en] The end of the period, which must be greater than or equal to the start. This value is inclusive. Date and time in UTC.
period_start	timestamp	[en] The start of the period. This value is inclusive. Date and time in UTC.
pricing_price_details_price	text	[en] The ID of the price this item is associated with.
pricing_price_details_product	text	[en] The ID of the product this item is associated with.
pricing_type	text	[en] The type of the pricing details. Possible values: price_details = price details.
pricing_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
quantity	int	[en] Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version.
quantity_decimal	text	[en] Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.
subscription	text	[en] Identifier of the subscription this line item belongs to, if any. Subscriptions > > id
subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The subtotal of the line item before any discounts or taxes.

stripe_invoice_lines_discount_amounts

Invoices - Details - Invoice line items: discount_amounts (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the discount.
discount	text	[en] The discount that was applied to get this discount amount.

stripe_invoice_lines_discounts

Invoices - Details - Invoice line items: discounts (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

stripe_invoice_lines_metadata

Invoices - Details - Invoice line items: metadata (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_invoice_lines_pare_inv_pro_cre_invoice_line_items

Invoices - Details - Invoice line items: parent.invoice_item_details.proration_details.credited_items.invoice_line_items (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Credited invoice line items…

stripe_invoice_lines_pare_sub_pro_cre_invoice_line_items

Invoices - Details - Invoice line items: parent.subscription_item_details.proration_details.credited_items.invoice_line_items (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Credited invoice line items…

stripe_invoice_lines_pretax_credit_amounts

Invoices - Details - Invoice line items: pretax_credit_amounts (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the pretax credit amount.
credit_balance_transaction	text	[en] The credit balance transaction that was applied to get this pretax credit amount.
discount	text	[en] The discount that was applied to get this pretax credit amount.
type	text	[en] Type of the pretax credit amount referenced. Possible values: credit_balance_transaction = credit balance transaction; discount = discount.

stripe_invoice_lines_taxes

Invoices - Details - Invoice line items: taxes (one row per item; joins stripe_invoice_lines by column invoice_line_id).

Field	Type
invoice_id	text	[en] Identifier of the parent record (id column of table stripe_invoices). Invoices > > id
invoice_line_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_invoice_lines). Invoices - Details - Invoice line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the tax.
tax_behavior	text	[en] Whether this tax is inclusive or exclusive. Possible values: exclusive = tax added on top of price; inclusive = tax included in price.
tax_rate_details_tax_rate	text	[en] ID of the tax rate…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_available = reason not available; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.
type	text	[en] The type of tax information. Possible values: tax_rate_details = tax rate details.

Payment intents

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
payment_intent_id > _payment_intents_allowed_payment_method_types → Payment intents > id
payment_intent_id > _payment_intents_excluded_payment_method_types → Payment intents > id
payment_intent_id > _payment_intents_metadata → Payment intents > id
payment_intent_id > _payment_intents_payment_method_options → Payment intents > id
payment_intent_id > _payment_intents_pay_bank__requested_address_types → Payment intents > id
payment_intent_id > _payment_intents_pay_fin_fil_account_subcategories → Payment intents > id
payment_intent_id > _payment_intents_pay_financial_connect_permissions → Payment intents > id
payment_intent_id > _payment_intents_pay_financial_connection_prefetch → Payment intents > id
payment_intent_id > _payment_intents_paym_installments_available_plans → Payment intents > id
payment_intent_id > _payment_intents_pay_mandate_optio_supported_types → Payment intents > id
payment_intent_id > _payment_intents_payment_method_types → Payment intents > id
payment_intent_id > _payment_intents_transfer_data_metadata → Payment intents > id
payment_intent_id > _payment_intents_transfer_da_payment_data_metadata → Payment intents > id

Main object

Payment intents: the payment request from start to finish (one intent can have several charge attempts). Status requires_payment_method after an attempt = payment declined, waiting for another card. For amounts received and failures, the Charges table is simpler.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this PaymentIntent. A value representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency.
amount_capturable	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that can be captured from this PaymentIntent.
amount_details_discount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The total discount applied on the transaction represented. An integer greater than 0. This field is mutually exclusive with the amount_details[line_items][#][discount_amount] field.
amount_details_error_code	text	[en] The code of the error that occurred when validating the current amount details. Possible values: amount_details_amount_mismatch = line item sum does not match amount; amount_details_tax_shipping_discount_greater_than_amount = tax/shipping/discount exceeds the amount.
amount_details_error_message	text	[en] A message providing more details about the error.
amount_details_shipping_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. If a physical good is being shipped, the cost of shipping represented. An integer greater than or equal to 0.
amount_details_shipping_from_postal_code	text	[en] If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed.
amount_details_shipping_to_postal_code	text	[en] If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed.
amount_details_tax_total_tax_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The total amount of tax on the transaction represented. Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the amount_details[line_items][#][tax][total_tax_amount] field.
amount_details_tip_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Portion of the amount that corresponds to a tip.
amount_received	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that this PaymentIntent collects.
application	text	[en] ID of the Connect application that created the PaymentIntent.
application_fee_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The 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.
automatic_payment_methods_allow_redirects	text	[en] Controls whether this PaymentIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. Possible values: always = accepts redirect-based methods; never = rejects redirect-based methods.
automatic_payment_methods_enabled	boolean	[en] Automatically calculates compatible payment methods… Values: true (yes) or false (no).
canceled_at	timestamp	[en] Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Date and time in UTC.
cancellation_reason	text	[en] Reason 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). Possible values: abandoned = abandoned by customer; automatic = automatically canceled by Stripe; duplicate = duplicate payment; expired = expired; failed_invoice = associated invoice failed; fraudulent = fraudulent; requested_by_customer = requested by customer; void_invoice = associated invoice voided.
capture_method	text	[en] Controls when the funds will be captured from the customer's account. Possible values: automatic = captured automatically on authorization; automatic_async = captured automatically, asynchronously; manual = captured manually later.
confirmation_method	text	[en] Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. Possible values: automatic = PaymentIntent confirmed automatically; manual = confirmed manually by the server.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. Customers > > id
customer_account	text	[en] ID 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.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
hooks_inputs_tax_calculation	text	[en] The TaxCalculation id…
last_payment_error_advice_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
last_payment_error_charge	text	[en] For card errors, the ID of the failed charge.
last_payment_error_code	text	[en] For some errors that could be handled programmatically, a short string indicating the error code reported.
last_payment_error_decline_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
last_payment_error_doc_url	text	[en] A URL to more information about the error code reported.
last_payment_error_message	text	[en] A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
last_payment_error_network_advice_code	text	[en] For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
last_payment_error_network_decline_code	text	[en] For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
last_payment_error_param	text	[en] If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
last_payment_error_payment_intent_id	text	[en] A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system.
last_payment_error_payment_method_id	text	[en] PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.
last_payment_error_payment_method_type	text	[en] If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
last_payment_error_request_log_url	text	[en] A URL to the request log entry in your dashboard.
last_payment_error_setup_intent_id	text	[en] A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
last_payment_error_source_id	text	[en] The source object for errors returned on a request involving a source.
last_payment_error_type	text	[en] The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error… Possible values: api_error = Stripe API internal error; card_error = card error (e.g. decline); idempotency_error = idempotency key error; invalid_request_error = invalid request.
latest_charge	text	[en] ID of the latest Charge object created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
managed_payments_enabled	boolean	[en] Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session. Values: true (yes) or false (no).
on_behalf_of	text	[en] You 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 for details.
payment_details_customer_reference	text	[en] A unique value to identify the customer. This field is available only for card payments. This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
payment_details_order_reference	text	[en] A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
payment_method	text	[en] ID of the payment method used in this PaymentIntent.
payment_method_configuration_details_id	text	[en] ID of the payment method configuration used.
payment_method_configuration_details_parent	text	[en] ID of the parent payment method configuration used.
payment_record	text	[en] ID of the Payment Record object created by this PaymentIntent.
presentment_details_presentment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this payment, denominated in presentment_currency.
presentment_details_presentment_currency	text	[en] Currency presented to the customer during payment.
processing_card_customer_notification_approval_requested	boolean	[en] Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. Values: true (yes) or false (no).
processing_card_customer_notification_completes_at	timestamp	[en] If customer approval is required, they need to provide approval before this time. Date and time in UTC.
processing_type	text	[en] Type of the payment method for which payment is in processing state, one of card. Possible values: card = card (online).
receipt_email	text	[en] Email 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.
review	text	[en] ID of the review associated with this PaymentIntent, if any.
setup_future_usage	text	[en] Indicates 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 to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. Possible values: off_session = future use without customer present; on_session = future use with customer present.
shipping_address_city	text	[en] City, district, suburb, town, or village.
shipping_address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
shipping_address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
shipping_address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
shipping_address_postal_code	text	[en] ZIP or postal code.
shipping_address_state	text	[en] State, county, province, or region (ISO 3166-2).
shipping_carrier	text	[en] The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
shipping_name	text	[en] Recipient name.
shipping_phone	text	[en] Recipient phone (including extension).
shipping_tracking_number	text	[en] 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.
statement_descriptor	text	[en] Text 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.
statement_descriptor_suffix	text	[en] Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.
status	text	[en] Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Possible values: canceled = canceled; processing = processing; requires_action = requires customer action (e.g. 3D Secure); requires_capture = authorized, awaiting capture; requires_confirmation = awaiting confirmation; requires_payment_method = awaiting a payment method; succeeded = succeeded. requires_payment_method after an attempt = payment declined, waiting for another card (the reason is in the Charges table).
transfer_data_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.
transfer_data_description	text	[en] An arbitrary string attached to the transfer. Often useful for displaying to users.
transfer_data_destination	text	[en] The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.
transfer_data_payment_data_description	text	[en] An arbitrary string attached to the destination payment. Often useful for displaying to users.
transfer_group	text	[en] A string that identifies the resulting payment as part of a group.

stripe_payment_intents_allowed_payment_method_types

Payment intents: allowed_payment_method_types (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The 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. Possible values: acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boku_promptpay = PromptPay via Boku (Thailand); boleto = boleto bank slip (Brazil); capchase_pay = Capchase Pay (B2B financing); card = card (online); card_present = in-person card (Terminal); cashapp = Cash App Pay (US); check_scan = check scan; click_to_pay = Click to Pay (card network wallet); crypto = crypto (stablecoin); customer_balance = customer cash balance (bank transfer); demo_pay = demo payment method (testing); duitnow = DuitNow (Malaysia); dummy_auth_push = dummy test method; dummy_passthrough_card = dummy test card; edenred = Edenred (benefit voucher); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); gcash = GCash (wallet, Philippines); getbalance = Balance (B2B payments); gift_card = gift card; giropay = giropay (bank transfer, Germany); gopay = GoPay (wallet, Indonesia); grabpay = GrabPay (digital wallet, Southeast Asia); id_bank_transfer = bank transfer (Indonesia); ideal = iDEAL (bank transfer, Netherlands); interac_present = in-person Interac card (Canada); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); knet = KNET (Kuwait); konbini = Konbini (convenience store, Japan); kr_card = Korean card; kr_market = South Korea local methods; kriya = Kriya (B2B pay later, UK); link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); momo = MoMo (wallet, Vietnam); mondu = Mondu (B2B pay later); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); netbanking = netbanking (India); ng_bank = bank (Nigeria); ng_bank_transfer = bank transfer (Nigeria); ng_card = card (Nigeria); ng_market = Nigeria local methods; ng_ussd = USSD (Nigeria); ng_wallet = wallet (Nigeria); nz_bank_account = bank account debit (New Zealand); octopus = Octopus (card, Hong Kong); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); paper_check = paper check; pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); qris = QRIS (QR, Indonesia); rechnung = Rechnung (invoice, Germany); revolut_pay = Revolut Pay (digital wallet); samsung_pay = Samsung Pay (digital wallet); satispay = Satispay (mobile payment, Italy); scalapay = Scalapay (buy now pay later, Europe); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); shop_pay = Shop Pay (Shopify); shopeepay = ShopeePay (wallet); sofort = Sofort (bank transfer, Europe); south_korea_market = South Korea local methods; stripe_balance = Stripe account balance; sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); tamara = Tamara (buy now pay later, Middle East); test_pay = test payment method; touch_n_go = Touch 'n Go (wallet, Malaysia); truemoney = TrueMoney (wallet, Thailand); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); us_cash_voucher = cash voucher (US); vipps = Vipps (wallet, Norway); wechat_pay = WeChat Pay (digital wallet, China); wero = Wero (wallet, Europe); zip = Zip (buy now pay later).

stripe_payment_intents_excluded_payment_method_types

Payment intents: excluded_payment_method_types (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types to exclude from use with this payment. Possible values: acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); cashapp = Cash App Pay (US); crypto = crypto (stablecoin); customer_balance = customer cash balance (bank transfer); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); kr_card = Korean card; mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); nz_bank_account = bank account debit (New Zealand); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); revolut_pay = Revolut Pay (digital wallet); samsung_pay = Samsung Pay (digital wallet); satispay = Satispay (mobile payment, Italy); scalapay = Scalapay (buy now pay later, Europe); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); sofort = Sofort (bank transfer, Europe); sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China); zip = Zip (buy now pay later).

stripe_payment_intents_metadata

Payment intents: metadata (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_payment_intents_payment_method_options

Payment intents: payment_method_options (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
app_id	text	[en] The app ID registered with WeChat Pay. Only required when client is ios, android, or mini_program.
bank_transfer_eu_bank_transfer_country	text	[en] The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL. Possible values: BE = Belgium; DE = Germany; ES = Spain; FR = France; IE = Ireland; NL = Netherlands.
bank_transfer_type	text	[en] The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. Possible values: eu_bank_transfer = bank transfer (Eurozone); gb_bank_transfer = bank transfer (UK); jp_bank_transfer = bank transfer (Japan); mx_bank_transfer = bank transfer (Mexico); us_bank_transfer = bank transfer (US).
capture_method	text	[en] Controls when the funds will be captured from the customer's account. Possible values: automatic_delayed = automatic capture, delayed; manual = captured manually later; manual_preferred = manual if supported, else automatic.
client	text	[en] The client type that the end customer will pay from… Possible values: android = Android app; ios = iOS app; web = web browser.
company_details_registered_address_city	text	[en] City, district, suburb, town, or village.
company_details_registered_address_country	text	[en] Two-letter country code.
company_details_registered_address_line1	text	[en] Address line 1 (e.g., street, PO Box, or company name).
company_details_registered_address_line2	text	[en] Address line 2 (e.g., apartment, suite, unit, or building).
company_details_registered_address_postal_code	text	[en] ZIP or postal code.
company_details_registered_address_state	text	[en] State, county, province, or region.
company_details_registered_name	text	[en] Company or entity name.
company_details_registration_number	text	[en] The official registration number for the given registration type.
company_details_registration_type	text	[en] Type of registration the company or entity holds in their registered country. Possible values: ch_ein = company ID number (Switzerland); de_hrb = HRB commercial register (Germany); dk_cvr = CVR number (Denmark); es_cif = CIF tax code (Spain); fi_tunnus = Y-tunnus business ID (Finland); fr_siren = SIREN number (France); fr_siret = SIRET number (France); it_rea = REA register number (Italy); nl_kvk = KvK number (Netherlands); no_org_number = organization number (Norway); no_pno = personal number (Norway); se_org_number = organization number (Sweden); se_pno = personal number (Sweden); uk_crn = Companies House number (UK).
company_details_vat	text	[en] VAT id number…
confirmation_number	text	[en] An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.
expires_after_days	int	[en] The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
expires_after_seconds	int	[en] The number of seconds (between 10 and 1209600) after which Pix payment will expire.
expires_at	text	[en] The timestamp at which the Konbini payment instructions will expire. Only one of expires_after_days or expires_at may be set.
financial_connections_return_url	text	[en] For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
funding_type	text	[en] The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible values: bank_transfer = bank transfer.
installments_enabled	boolean	[en] Whether installments are enabled for this payment method. Values: true (yes) or false (no).
installments_plan_count	int	[en] For fixed_count installment plans, this is the number of installment payments your customer will make to their credit card.
installments_plan_interval	text	[en] For fixed_count installment plans, this is the interval between installment payments your customer will make to their credit card. One of month. Possible values: month = monthly.
installments_plan_type	text	[en] Type of installment plan, one of fixed_count, bonus, or revolving. Possible values: bonus = bonus installment plan; fixed_count = fixed number of installments; revolving = revolving credit.
mandate_options_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that will be collected. It is required when amount_type is fixed.
mandate_options_amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
mandate_options_amount_type	text	[en] The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible values: fixed = exact amount to charge; maximum = maximum amount to charge.
mandate_options_collection_method	text	[en] Mandate collection method… Possible values: paper = paper mandate.
mandate_options_currency	text	[en] Three-letter ISO currency code, in lowercase.
mandate_options_custom_mandate_url	text	[en] A URL for custom mandate text…
mandate_options_description	text	[en] A description of the mandate or subscription that is meant to be displayed to the customer.
mandate_options_end_date	text	[en] Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
mandate_options_expires_at	timestamp	[en] Date at which the mandate expires. Date and time in UTC.
mandate_options_interval	text	[en] Specifies payment frequency. One of day, week, month, year, or sporadic. Possible values: day = daily; month = monthly; sporadic = sporadic; week = weekly; year = yearly.
mandate_options_interval_count	int	[en] The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.
mandate_options_interval_description	text	[en] Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
mandate_options_payment_schedule	text	[en] Payment schedule for the mandate. Possible values: combined = combined: interval and sporadic; interval = at fixed intervals; sporadic = sporadic, on demand.
mandate_options_payments_per_period	int	[en] The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.
mandate_options_purpose	text	[en] The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support = dependant support; government = government payment; loan = loan; mortgage = mortgage; other = other purpose; pension = pension; personal = personal payment; retail = retail purchase; salary = salary; tax = tax payment; utility = utility bills.
mandate_options_reference	text	[en] Unique identifier for the mandate or subscription.
mandate_options_reference_prefix	text	[en] Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
mandate_options_start_date	text	[en] Start date of the mandate or subscription. Start date should not be lesser than yesterday.
mandate_options_transaction_type	text	[en] Transaction type of the mandate. Possible values: business = business transaction; personal = personal transaction.
mandate_options_type	text	[en] Type of the mandate. Possible values: off_session = customer not present (off-session).
network	text	[en] Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. Possible values: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa.
preferred_language	text	[en] Preferred language of the Bancontact authorization page that the customer is redirected to. Possible values: de = German; en = English; fr = French; nl = Dutch.
preferred_locale	text	[en] Preferred language of the Affirm authorization page that the customer is redirected to.
product_description	text	[en] A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
reference	text	[en] An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name.
request_extended_authorization	text	[en] Request ability to capture beyond the standard authorization validity window for this PaymentIntent. Possible values: if_available = request extended authorization if available; never = never request extended authorization.
request_incremental_authorization	text	[en] Request ability to increment the authorization for this PaymentIntent. Possible values: if_available = request incremental auth if available; never = never request incremental auth.
request_incremental_authorization_support	boolean	[en] Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible. Check incremental_authorization_supported in the Confirm response to verify support. Values: true (yes) or false (no).
request_multicapture	text	[en] Request ability to make multiple captures for this PaymentIntent. Possible values: if_available = request multicapture if available; never = never request multicapture.
request_overcapture	text	[en] Request ability to overcapture for this PaymentIntent. Possible values: if_available = overcapture if available; never = never allow overcapture.
request_three_d_secure	text	[en] We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Possible values: any = request 3D Secure whenever possible; automatic = Stripe decides when 3D Secure is required; challenge = force a 3D Secure challenge.
require_cvc_recollection	boolean	[en] When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). Values: true (yes) or false (no).
routing_requested_priority	text	[en] Requested routing priority… Possible values: domestic = route via domestic network; international = route via international network.
setup_future_usage	text	[en] Indicates 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 to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. Possible values: none = not saved for future use; off_session = future use without customer present; on_session = future use with customer present.
statement_descriptor_suffix_kana	text	[en] Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters.
statement_descriptor_suffix_kanji	text	[en] Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters.
target_date	text	[en] Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
transaction_purpose	text	[en] The purpose of the transaction. Possible values: goods = purchase of goods; other = other purpose; services = purchase of services; unspecified = purpose unspecified.
verification_method	text	[en] Bank account verification method. The default value is automatic. Possible values: automatic = automatic (instant or microdeposits); instant = instant verification; microdeposits = microdeposit verification.

stripe_payment_intents_pay_bank__requested_address_types

Payment intents: payment_method_options.bank_transfer.requested_address_types (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. Permitted values include: sort_code, zengin, iban, or spei. Possible values: aba = ABA (US); iban = IBAN; sepa = SEPA (Europe); sort_code = sort code (UK); spei = SPEI (Mexico); swift = SWIFT (international); zengin = Zengin (Japan).

stripe_payment_intents_pay_fin_fil_account_subcategories

Payment intents: payment_method_options.financial_connections.filters.account_subcategories (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible values: checking = checking account; savings = savings account.

stripe_payment_intents_pay_financial_connect_permissions

Payment intents: payment_method_options.financial_connections.permissions (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The list of permissions to request. The payment_method permission must be included. Possible values: balances = account balances; ownership = account ownership; payment_method = use as payment method; transactions = account transactions.

stripe_payment_intents_pay_financial_connection_prefetch

Payment intents: payment_method_options.financial_connections.prefetch (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Data features requested to be retrieved upon account creation. Possible values: balances = balances; ownership = ownership; transactions = transactions.

stripe_payment_intents_paym_installments_available_plans

Payment intents: payment_method_options.installments.available_plans (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
count	int	[en] For fixed_count installment plans, this is the number of installment payments your customer will make to their credit card.
interval	text	[en] For fixed_count installment plans, this is the interval between installment payments your customer will make to their credit card. One of month. Possible values: month = monthly.
type	text	[en] Type of installment plan, one of fixed_count, bonus, or revolving. Possible values: bonus = bonus installment plan; fixed_count = fixed number of installments; revolving = revolving credit.

stripe_payment_intents_pay_mandate_optio_supported_types

Payment intents: payment_method_options.mandate_options.supported_types (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field	Type
payment_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents). Payment intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Specifies the type of mandates supported. Possible values are india. Possible values: india = India mandate.

stripe_payment_intents_payment_method_types

Payment intents: payment_method_types (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The 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.

stripe_payment_intents_transfer_data_metadata

Payment intents: transfer_data.metadata (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_payment_intents_transfer_da_payment_data_metadata

Payment intents: transfer_data.payment_data.metadata (one row per item; joins stripe_payment_intents by column payment_intent_id).

Field

Type

payment_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_intents).

Payment intents > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Payment links

Replication type: Full

Relationships:

payment_link_id > _payment_links_custom_fields → Payment links > id
payment_link_id > _payment_links_custom_fields_dropdown_options → Payment links > id
payment_link_id > _payment_links_invoic_invoice_data_account_tax_ids → Payment links > id
payment_link_id > _payment_links_invoice__invoice_data_custom_fields → Payment links > id
payment_link_id > _payment_links_invoice_creat_invoice_data_metadata → Payment links > id
payment_link_id > _payment_links_metadata → Payment links > id
payment_link_id > _payment_links_optional_items → Payment links > id
payment_link_id > _payment_links_payment_intent_data_metadata → Payment links > id
payment_link_id > _payment_links_payment_method_options → Payment links > id
payment_link_id > _payment_links_payment_restrictions_brands_blocked → Payment links > id
payment_link_id > _payment_links_payment_method_types → Payment links > id
payment_link_id > _payment_links_shipping_address__allowed_countries → Payment links > id
payment_link_id > _payment_links_shipping_options → Payment links > id
payment_link_id > _payment_links_subscription_data_metadata → Payment links > id

Main object

Payment links created in Stripe.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated. Values: true (yes) or false (no).
after_completion_hosted_confirmation_custom_message	text	[en] The custom message that is displayed to the customer after the purchase is complete.
after_completion_redirect_url	text	[en] The URL the customer will be redirected to after the purchase is complete.
after_completion_type	text	[en] The specified behavior after the purchase is complete. Possible values: hosted_confirmation = Stripe-hosted confirmation page; redirect = redirect to URL.
allow_promotion_codes	boolean	[en] Whether user redeemable promotion codes are enabled. Values: true (yes) or false (no).
application	text	[en] The ID of the Connect application that created the Payment Link.
application_fee_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The 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.
application_fee_percent	float	[en] This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
automatic_tax_enabled	boolean	[en] If true, tax will be calculated automatically using the customer's location. Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
billing_address_collection	text	[en] Configuration for collecting the customer's billing address. Defaults to auto. Possible values: auto = collect address only when needed; required = billing address required.
consent_collection_payment_method_reuse_agreement_position	text	[en] Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI. Possible values: auto = position chosen by Stripe; hidden = reuse agreement hidden.
consent_collection_promotions	text	[en] If set to auto, enables the collection of customer consent for promotional communications. Possible values: auto = collect promotional consent when applicable; none = promotional consent not collected.
consent_collection_terms_of_service	text	[en] If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service. Possible values: none = terms acceptance not required; required = terms acceptance required.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
custom_text_after_submit_message	text	[en] Text can be up to 1200 characters in length.
custom_text_shipping_address_message	text	[en] Text can be up to 1200 characters in length.
custom_text_submit_message	text	[en] Text can be up to 1200 characters in length.
custom_text_terms_of_service_acceptance_message	text	[en] Text can be up to 1200 characters in length.
customer_creation	text	[en] Configuration for Customer creation during checkout. Possible values: always = always creates a customer; if_required = creates customer only if required.
inactive_message	text	[en] The custom message to be displayed to a customer when a payment link is no longer active.
invoice_creation_enabled	boolean	[en] Enable creating an invoice on successful payment. Values: true (yes) or false (no).
invoice_creation_invoice_data_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
invoice_creation_invoice_data_footer	text	[en] Footer to be displayed on the invoice.
invoice_creation_invoice_data_issuer_account	text	[en] The connected account being referenced when type is account.
invoice_creation_invoice_data_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
invoice_creation_invoice_data_rendering_o_amount_tax_display	text	[en] How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
invoice_creation_invoice_data_rendering_options_template	text	[en] ID of the invoice rendering template to be used for the generated invoice.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
managed_payments_enabled	boolean	[en] Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session. Values: true (yes) or false (no).
name_collection_business_enabled	boolean	[en] Indicates whether business name collection is enabled for the payment link. Values: true (yes) or false (no).
name_collection_business_optional	boolean	[en] Whether the customer is required to complete the field before checking out. Defaults to false. Values: true (yes) or false (no).
name_collection_individual_enabled	boolean	[en] Indicates whether individual name collection is enabled for the payment link. Values: true (yes) or false (no).
name_collection_individual_optional	boolean	[en] Whether the customer is required to complete the field before checking out. Defaults to false. Values: true (yes) or false (no).
on_behalf_of	text	[en] The account on behalf of which to charge.
payment_intent_data_capture_method	text	[en] Indicates when the funds will be captured from the customer's account. Possible values: automatic = captured automatically on authorization; automatic_async = captured automatically, asynchronously; manual = captured manually later.
payment_intent_data_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
payment_intent_data_setup_future_usage	text	[en] Indicates that you intend to make future payments with the payment method collected during checkout. Possible values: off_session = future use without customer present; on_session = future use with customer present.
payment_intent_data_statement_descriptor	text	[en] For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
payment_intent_data_statement_descriptor_suffix	text	[en] For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
payment_intent_data_transfer_group	text	[en] A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
payment_method_collection	text	[en] Configuration for collecting a payment method during checkout. Defaults to always. Possible values: always = always collect a payment method; if_required = collect only if required.
phone_number_collection_enabled	boolean	[en] If true, a phone number will be collected during checkout. Values: true (yes) or false (no).
restrictions_completed_sessions_count	int	[en] The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
restrictions_completed_sessions_limit	int	[en] The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
submit_type	text	[en] Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. Possible values: auto = default button text (automatic); book = Book button; donate = Donate button; pay = Pay button; subscribe = Subscribe button.
subscription_data_description	text	[en] The 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.
subscription_data_invoice_settings_issuer_account	text	[en] The connected account being referenced when type is account.
subscription_data_invoice_settings_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
subscription_data_trial_period_days	int	[en] Integer representing the number of trial period days before the customer is charged for the first time.
subscription_data_trial_end_behavior_missing_payment_method	text	[en] Indicates how the subscription should change when the trial ends if the user did not provide a payment method. Possible values: cancel = cancel the subscription; create_invoice = create invoice anyway; pause = pause the subscription.
tax_id_collection_enabled	boolean	[en] Indicates whether tax ID collection is enabled for the session. Values: true (yes) or false (no).
tax_id_collection_required	text	[en] Whether collecting the customer's tax ID is required (always, never or if supported). Possible values: if_supported = required if supported; never = never required.
transfer_data_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
transfer_data_destination	text	[en] The connected account receiving the transfer.
url	text	[en] The public URL that can be shared with customers.

stripe_payment_links_custom_fields

Payment links: custom_fields (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
dropdown_default_value	text	[en] The value that pre-fills on the payment page.
key	text	[en] String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
label_custom	text	[en] Custom text for the label, displayed to the customer. Up to 100 characters.
label_type	text	[en] The type of the label. Possible values: custom = custom payment method.
numeric_default_value	text	[en] The value that pre-fills the field on the payment page.
numeric_maximum_length	int	[en] The maximum character length constraint for the customer's input.
numeric_minimum_length	int	[en] The minimum character length requirement for the customer's input.
optional	boolean	[en] Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false. Values: true (yes) or false (no).
text_default_value	text	[en] The value that pre-fills the field on the payment page.
text_maximum_length	int	[en] The maximum character length constraint for the customer's input.
text_minimum_length	int	[en] The minimum character length requirement for the customer's input.
type	text	[en] The type of the field. Possible values: dropdown = dropdown; numeric = numeric field; text = text field.

stripe_payment_links_custom_fields_dropdown_options

Payment links: custom_fields.dropdown.options (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_links_custom_fields, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
label	text	[en] The label for the option, displayed to the customer. Up to 100 characters.
value	text	[en] The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

stripe_payment_links_invoic_invoice_data_account_tax_ids

Payment links: invoice_creation.invoice_data.account_tax_ids (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The account tax IDs associated with the invoice.

stripe_payment_links_invoice__invoice_data_custom_fields

Payment links: invoice_creation.invoice_data.custom_fields (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_payment_links_invoice_creat_invoice_data_metadata

Payment links: invoice_creation.invoice_data.metadata (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_payment_links_metadata

Payment links: metadata (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_payment_links_optional_items

Payment links: optional_items (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
adjustable_quantity_enabled	boolean	[en] Set to true if the quantity can be adjusted to any non-negative integer. Values: true (yes) or false (no).
adjustable_quantity_maximum	int	[en] The maximum quantity of this item the customer can purchase. By default this value is 99.
adjustable_quantity_minimum	int	[en] The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
price	text	[en] Identifier of the price of the optional item offered in Checkout.
quantity	int	[en] Initial quantity of the optional item offered in Checkout.

stripe_payment_links_payment_intent_data_metadata

Payment links: payment_intent_data.metadata (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.

stripe_payment_links_payment_method_options

Payment links: payment_method_options (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

stripe_payment_links_payment_restrictions_brands_blocked

Payment links: payment_method_options.restrictions.brands_blocked (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_links_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment. Possible values: american_express = American Express (brand); discover_global_network = Discover Global Network (brand); mastercard = Mastercard (brand); visa = Visa (brand).

stripe_payment_links_payment_method_types

Payment links: payment_method_types (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types that customers can use. When null, Stripe will dynamically show relevant payment methods you've enabled in your payment method settings. Possible values: affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); cashapp = Cash App Pay (US); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); multibanco = Multibanco (bank reference, Portugal); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); satispay = Satispay (mobile payment, Italy); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); sofort = Sofort (bank transfer, Europe); sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China); zip = Zip (buy now pay later).

stripe_payment_links_shipping_address__allowed_countries

Payment links: shipping_address_collection.allowed_countries (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI. Possible values: ISO 3166-1 alpha-2 country code (e.g. BR = Brazil, US = United States, PT = Portugal), among the 238 countries and territories Stripe supports.

stripe_payment_links_shipping_options

Payment links: shipping_options (one row per item; joins stripe_payment_links by column payment_link_id).

Field	Type
payment_link_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_links). Payment links > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
shipping_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing how much to charge.
shipping_rate	text	[en] The ID of the Shipping Rate to use for this shipping option.

stripe_payment_links_subscription_data_metadata

Payment links: subscription_data.metadata (one row per item; joins stripe_payment_links by column payment_link_id).

Field

Type

payment_link_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payment_links).

Payment links > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.

Payment links - Details - Line items

Replication type: Full

Relationships:

payment_link_id → Payment links > id
payment_link_id > _payment_link_line_items_discounts → Payment links > id
payment_link_line_item_id > _payment_link_line_items_discounts → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_metadata → Payment links > id
payment_link_line_item_id > _payment_link_line_items_metadata → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_price_currency_options → Payment links > id
payment_link_line_item_id > _payment_link_line_items_price_currency_options → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_price_currency_opti_tiers → Payment links > id
payment_link_line_item_id > _payment_link_line_items_price_currency_opti_tiers → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_price_metadata → Payment links > id
payment_link_line_item_id > _payment_link_line_items_price_metadata → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_price_tiers → Payment links > id
payment_link_line_item_id > _payment_link_line_items_price_tiers → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_taxes → Payment links > id
payment_link_line_item_id > _payment_link_line_items_taxes → Payment links - Details - Line items > id
payment_link_id > _payment_link_line_items_taxes_rate_metadata → Payment links > id
payment_link_line_item_id > _payment_link_line_items_taxes_rate_metadata → Payment links - Details - Line items > id

Main object

Line items of each payment link.

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
id	text	[en] Unique identifier for the object.
adjustable_quantity_enabled	boolean	[en] Whether the customer can adjust the quantity of this item in Checkout. Values: true (yes) or false (no).
adjustable_quantity_maximum	int	[en] Maximum quantity the customer can choose for this item in Checkout.
adjustable_quantity_minimum	int	[en] Minimum quantity the customer can choose for this item in Checkout.
amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total discount amount applied. If no discounts were applied, defaults to 0.
amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied. If no tax was applied, defaults to 0.
amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
price_id	text	[en] Unique identifier for the object.
price_active	boolean	[en] Whether the price can be used for new purchases. Values: true (yes) or false (no).
price_billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
price_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
price_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
price_custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
price_custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
price_custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
price_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
price_lookup_key	text	[en] A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
price_nickname	text	[en] A brief description of the price, hidden from customers.
price_product	text	[en] The ID of the product this price is associated with.
price_recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
price_recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
price_recurring_meter	text	[en] The meter tracking the usage of a metered price…
price_recurring_usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.
price_tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
price_tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
price_transform_quantity_divide_by	int	[en] Divide usage by this number.
price_transform_quantity_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
price_type	text	[en] One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: one_time = one-time price; recurring = recurring price (subscription).
price_unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
price_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
quantity	int	[en] The quantity of products being purchased.

stripe_payment_link_line_items_discounts

Payment links - Details - Line items: discounts (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.
discount_checkout_session	text	[en] The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
discount_customer	text	[en] The ID of the customer associated with this discount.
discount_customer_account	text	[en] The ID of the account representing the customer associated with this discount.
discount_end	timestamp	[en] If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. Date and time in UTC.
discount_invoice	text	[en] The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
discount_invoice_item	text	[en] The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
discount_promotion_code	text	[en] The promotion code applied to create this discount.
discount_source_coupon	text	[en] The coupon that was redeemed to create this discount.
discount_source_type	text	[en] The source type of the discount. Possible values: coupon = coupon.
discount_start	timestamp	[en] Date that the coupon was applied. Date and time in UTC.
discount_subscription	text	[en] The subscription that this coupon is applied to, if it is applied to a particular subscription.
discount_subscription_item	text	[en] The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

stripe_payment_link_line_items_metadata

Payment links - Details - Line items: metadata (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_payment_link_line_items_price_currency_options

Payment links - Details - Line items: price.currency_options (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_payment_link_line_items_price_currency_opti_tiers

Payment links - Details - Line items: price.currency_options.tiers (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_link_line_items_price_currency_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_payment_link_line_items_price_metadata

Payment links - Details - Line items: price.metadata (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_payment_link_line_items_price_tiers

Payment links - Details - Line items: price.tiers (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_payment_link_line_items_taxes

Payment links - Details - Line items: taxes (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Unique identifier for the object.
rate_active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
rate_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
rate_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
rate_description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
rate_display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
rate_effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
rate_flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
rate_flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
rate_inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
rate_jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
rate_jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
rate_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
rate_percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
rate_state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
rate_tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_payment_link_line_items_taxes_rate_metadata

Payment links - Details - Line items: taxes.rate.metadata (one row per item; joins stripe_payment_link_line_items by column payment_link_line_item_id).

Field	Type
payment_link_id	text	[en] Identifier of the parent record (id column of table stripe_payment_links). Payment links > > id
payment_link_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payment_link_line_items). Payment links - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_payment_link_line_items_taxes, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Payouts

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
payout_id > _payouts_metadata → Payouts > id

Main object

Payouts from the Stripe balance to your bank account, with amount (positive), status, expected bank arrival date (arrival_date) and failures. To see which sales, fees and refunds make up each payout, use the Payouts - Details - Payout transactions integration.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount that transfers to your bank account or debit card. Positive here; in balance transactions the same payout is negative (it left the balance to the bank).
application_fee	text	[en] The application fee (if any) for the payout.
application_fee_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the application fee (if any) requested for the payout.
arrival_date	timestamp	[en] Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. Expected bank arrival date (the date is what matters; the time is 00:00 UTC).
automatic	boolean	[en] Returns true if the payout is created by an automated payout schedule and false if it's requested manually. Values: true (yes) or false (no).
balance_transaction	text	[en] ID of the balance transaction that describes the impact of this payout on your account balance. Balance transactions > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
destination	text	[en] ID of the bank account or card the payout is sent to.
failure_balance_transaction	text	[en] If 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.
failure_code	text	[en] Error code that provides a reason for a payout failure, if available. View our list of failure codes.
failure_message	text	[en] Message that provides the reason for a payout failure, if available.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
method	text	[en] The 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.
original_payout	text	[en] If the payout reverses another, this is the ID of the original payout.
payout_method	text	[en] ID of the v2 FinancialAccount the funds are sent to.
reconciliation_status	text	[en] If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. Possible values: completed = reconciliation completed; in_progress = reconciliation in progress; not_applicable = reconciliation not applicable (manual payout).
reversed_by	text	[en] If the payout reverses, this is the ID of the payout that reverses this payout.
source_type	text	[en] The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.
statement_descriptor	text	[en] Extra information about a payout that displays on the user's bank statement.
status	text	[en] Current 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).
trace_id_status	text	[en] Possible values are pending, supported, and unsupported. When payout.status is pending or in_transit, this will be pending. When the payout transitions to paid, failed, or canceled, this status will become supported or unsupported shortly after in most cases.
trace_id_value	text	[en] The trace ID value if trace_id.status is supported, otherwise nil.
type	text	[en] Can be bank_account or card. Possible values: bank_account = bank account; card = card (online).

stripe_payouts_metadata

Payouts: metadata (one row per item; joins stripe_payouts by column payout_id).

Field

Type

payout_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_payouts).

Payouts > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Plans

Replication type: Full

Relationships:

product → Products > id
plan_id > _plans_metadata → Plans > id
plan_id > _plans_tiers → Plans > id

Main object

Plans (Stripe's legacy recurring price model).

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the plan can be used for new purchases. Values: true (yes) or false (no).
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans with usage_type=metered). Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
meter	text	[en] The meter tracking the usage of a metered price…
nickname	text	[en] A brief description of the plan, hidden from customers.
product	text	[en] The product whose pricing this plan determines. Products > > id
tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
transform_usage_divide_by	int	[en] Divide usage by this number.
transform_usage_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
trial_period_days	int	[en] Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.

stripe_plans_metadata

Plans: metadata (one row per item; joins stripe_plans by column plan_id).

Field

Type

plan_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_plans).

Plans > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_plans_tiers

Plans: tiers (one row per item; joins stripe_plans by column plan_id).

Field	Type
plan_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_plans). Plans > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

Prices

Replication type: Full

Relationships:

product → Products > id
price_id > _prices_currency_options → Prices > id
price_id > _prices_currency_options_tiers → Prices > id
price_id > _prices_metadata → Prices > id
price_id > _prices_tiers → Prices > id

Main object

Product prices (one-time or recurring), with currency, amount, billing interval and tiers.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the price can be used for new purchases. Values: true (yes) or false (no).
billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
lookup_key	text	[en] A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
nickname	text	[en] A brief description of the price, hidden from customers.
product	text	[en] The ID of the product this price is associated with. Products > > id
recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
recurring_meter	text	[en] The meter tracking the usage of a metered price…
recurring_usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
transform_quantity_divide_by	int	[en] Divide usage by this number.
transform_quantity_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
type	text	[en] One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: one_time = one-time price; recurring = recurring price (subscription).
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_prices_currency_options

Prices: currency_options (one row per item; joins stripe_prices by column price_id).

Field	Type
price_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_prices). Prices > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_prices_currency_options_tiers

Prices: currency_options.tiers (one row per item; joins stripe_prices by column price_id).

Field	Type
price_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_prices). Prices > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_prices_currency_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_prices_metadata

Prices: metadata (one row per item; joins stripe_prices by column price_id).

Field

Type

price_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_prices).

Prices > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_prices_tiers

Prices: tiers (one row per item; joins stripe_prices by column price_id).

Field	Type
price_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_prices). Prices > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

Products

Replication type: Full

Relationships:

product_id > _products_images → Products > id
product_id > _products_marketing_features → Products > id
product_id > _products_metadata → Products > id

Main object

Products in the Stripe catalog.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the product is currently available for purchase. Values: true (yes) or false (no).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
default_price	text	[en] The ID of the Price object that is the default price for this product.
description	text	[en] The 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.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
name	text	[en] The product's name, meant to be displayable to the customer.
package_dimensions_height	float	[en] Height, in inches.
package_dimensions_length	float	[en] Length, in inches.
package_dimensions_weight	float	[en] Weight, in ounces.
package_dimensions_width	float	[en] Width, in inches.
shippable	boolean	[en] Whether this product is shipped (i.e., physical goods). Values: true (yes) or false (no).
statement_descriptor	text	[en] Extra 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.
tax_code	text	[en] A tax code ID.
tax_details_performance_location	text	[en] The ID of a tax location with type performance, representing where the performance takes place.
tax_details_tax_code	text	[en] A tax code ID.
unit_label	text	[en] A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
updated	timestamp	[en] Time at which the object was last updated. Date and time in UTC.
url	text	[en] A URL of a publicly-accessible webpage for this product.

stripe_products_images

Products: images (one row per item; joins stripe_products by column product_id).

Field

Type

product_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_products).

Products > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

stripe_products_marketing_features

Products: marketing_features (one row per item; joins stripe_products by column product_id).

Field

Type

product_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_products).

Products > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

name

text

[en] The marketing feature name. Up to 80 characters long.

stripe_products_metadata

Products: metadata (one row per item; joins stripe_products by column product_id).

Field

Type

product_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_products).

Products > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Promotion codes

Replication type: Full

Relationships:

customer → Customers > id
promotion_code_id > _promotion_codes_metadata → Promotion codes > id
promotion_code_id > _promotion_codes_restrictions_currency_options → Promotion codes > id

Main object

Promotion codes customers enter to redeem a coupon.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. Values: true (yes) or false (no).
code	text	[en] The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
customer	text	[en] The customer who can use this promotion code. Customers > > id
customer_account	text	[en] The account representing the customer who can use this promotion code.
expires_at	timestamp	[en] Date at which the promotion code can no longer be redeemed. Date and time in UTC.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
max_redemptions	int	[en] Maximum number of times this promotion code can be redeemed.
promotion_coupon	text	[en] If promotion type is coupon, the coupon for this promotion.
promotion_type	text	[en] The type of promotion. Possible values: coupon = coupon.
restrictions_first_time_transaction	boolean	[en] A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices… Values: true (yes) or false (no).
restrictions_minimum_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
restrictions_minimum_amount_currency	text	[en] Three-letter ISO code for minimum_amount…
times_redeemed	int	[en] Number of times this promotion code has been used.

stripe_promotion_codes_metadata

Promotion codes: metadata (one row per item; joins stripe_promotion_codes by column promotion_code_id).

Field

Type

promotion_code_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_promotion_codes).

Promotion codes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_promotion_codes_restrictions_currency_options

Promotion codes: restrictions.currency_options (one row per item; joins stripe_promotion_codes by column promotion_code_id).

Field

Type

promotion_code_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_promotion_codes).

Promotion codes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

minimum_amount

float

[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

Quotes

Replication type: Full

Relationships:

customer → Customers > id
invoice → Invoices > id
subscription → Subscriptions > id
quote_id > _quotes_computed_recurring_tot_breakdown_discounts → Quotes > id
quote_id > _quotes_computed_recurring_total_d_breakdown_taxes → Quotes > id
quote_id > _quotes_computed_upfront_total_breakdown_discounts → Quotes > id
quote_id > _quotes_computed_upfront_total_det_breakdown_taxes → Quotes > id
quote_id > _quotes_default_tax_rates → Quotes > id
quote_id > _quotes_discounts → Quotes > id
quote_id > _quotes_invoice_settings_custom_fields → Quotes > id
quote_id > _quotes_metadata → Quotes > id
quote_id > _quotes_subscription_data_metadata → Quotes > id
quote_id > _quotes_total_details_breakdown_discounts → Quotes > id
quote_id > _quotes_total_details_breakdown_taxes → Quotes > id

Main object

Quotes sent to customers, with amounts, expiry and status.

Field	Type
id	text	[en] Unique identifier for the object.
amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes are applied.
application	text	[en] ID of the Connect Application that created the quote.
application_fee_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The 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. Only applicable if there are no line items with recurring prices on the quote.
application_fee_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
automatic_tax_enabled	boolean	[en] Automatically calculate taxes… Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
automatic_tax_provider	text	[en] The tax provider powering automatic tax.
automatic_tax_status	text	[en] The status of the most recent automated tax calculation for this quote. Possible values: complete = complete; failed = failed; requires_location_inputs = requires valid customer location.
collection_method	text	[en] Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. Possible values: charge_automatically = charged automatically to payment method; send_invoice = invoice emailed for customer to pay.
computed_recurring_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
computed_recurring_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes are applied.
computed_recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
computed_recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
computed_recurring_total_details_amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the discounts.
computed_recurring_total_details_amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
computed_recurring_total_details_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the tax amounts.
computed_upfront_amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
computed_upfront_amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes are applied.
computed_upfront_total_details_amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the discounts.
computed_upfront_total_details_amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
computed_upfront_total_details_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the tax amounts.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. Customers > > id
customer_account	text	[en] The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it.
description	text	[en] A description that will be displayed on the quote PDF.
expires_at	timestamp	[en] The date on which the quote will be canceled if in open or draft status. Date and time in UTC.
footer	text	[en] A footer that will be displayed on the quote PDF.
from_quote_is_revision	boolean	[en] Whether this quote is a revision of a different quote. Values: true (yes) or false (no).
from_quote_quote	text	[en] The quote that was cloned.
header	text	[en] A header that will be displayed on the quote PDF.
invoice	text	[en] The invoice that was created from this quote. Invoices > > id
invoice_settings_days_until_due	int	[en] Number of days within which a customer must pay invoices generated by this quote. This value will be null for quotes where collection_method=charge_automatically.
invoice_settings_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
invoice_settings_footer	text	[en] Footer to be displayed on the invoice.
invoice_settings_issuer_account	text	[en] The connected account being referenced when type is account.
invoice_settings_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
number	text	[en] A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
on_behalf_of	text	[en] The account on behalf of which to charge.
status	text	[en] The status of the quote. Possible values: accepted = accepted by the customer; canceled = canceled; draft = draft, not yet finalized; open = open, awaiting completion.
status_transitions_accepted_at	timestamp	[en] The time that the quote was accepted. Measured in seconds since Unix epoch. Date and time in UTC.
status_transitions_canceled_at	timestamp	[en] The time that the quote was canceled. Measured in seconds since Unix epoch. Date and time in UTC.
status_transitions_finalized_at	timestamp	[en] The time that the quote was finalized. Measured in seconds since Unix epoch. Date and time in UTC.
subscription	text	[en] The subscription that was created or updated from this quote. Subscriptions > > id
subscription_data_billing_mode_flexible_proration_discounts	text	[en] Controls how invoices and invoice items display proration amounts and discount amounts. Possible values: included = discounts included in proration amounts; itemized = discounts shown as separate items.
subscription_data_billing_mode_type	text	[en] Controls how prorations and invoices for subscriptions are calculated and orchestrated. Possible values: classic = classic billing mode; flexible = flexible billing mode.
subscription_data_description	text	[en] The 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.
subscription_data_effective_date	timestamp	[en] When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Date and time in UTC.
subscription_data_trial_period_days	int	[en] Integer representing the number of trial period days before the customer is charged for the first time.
subscription_schedule	text	[en] The subscription schedule that was created or updated from this quote.
test_clock	text	[en] ID of the test clock this quote belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.
total_details_amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the discounts.
total_details_amount_shipping	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the shipping amounts.
total_details_amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This is the sum of all the tax amounts.
transfer_data_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
transfer_data_amount_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.
transfer_data_destination	text	[en] The account where funds from the payment will be transferred to upon payment success.

stripe_quotes_computed_recurring_tot_breakdown_discounts

Quotes: computed.recurring.total_details.breakdown.discounts (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to. Related guide: Applying discounts to subscriptions…

stripe_quotes_computed_recurring_total_d_breakdown_taxes

Quotes: computed.recurring.total_details.breakdown.taxes (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_quotes_computed_upfront_total_breakdown_discounts

Quotes: computed.upfront.total_details.breakdown.discounts (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to. Related guide: Applying discounts to subscriptions…

stripe_quotes_computed_upfront_total_det_breakdown_taxes

Quotes: computed.upfront.total_details.breakdown.taxes (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_quotes_default_tax_rates

Quotes: default_tax_rates (one row per item; joins stripe_quotes by column quote_id).

Field

Type

quote_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_quotes).

Quotes > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The tax rates applied to this quote.

stripe_quotes_discounts

Quotes: discounts (one row per item; joins stripe_quotes by column quote_id).

Field

Type

quote_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_quotes).

Quotes > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The discounts applied to this quote.

stripe_quotes_invoice_settings_custom_fields

Quotes: invoice_settings.custom_fields (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_quotes_metadata

Quotes: metadata (one row per item; joins stripe_quotes by column quote_id).

Field

Type

quote_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_quotes).

Quotes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_quotes_subscription_data_metadata

Quotes: subscription_data.metadata (one row per item; joins stripe_quotes by column quote_id).

Field

Type

quote_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_quotes).

Quotes > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field.

stripe_quotes_total_details_breakdown_discounts

Quotes: total_details.breakdown.discounts (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to. Related guide: Applying discounts to subscriptions…

stripe_quotes_total_details_breakdown_taxes

Quotes: total_details.breakdown.taxes (one row per item; joins stripe_quotes by column quote_id).

Field	Type
quote_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quotes). Quotes > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates…
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

Quotes - Details - Line items

Replication type: Full

Relationships:

quote_id → Quotes > id
quote_id > _quote_line_items_discounts → Quotes > id
quote_line_item_id > _quote_line_items_discounts → Quotes - Details - Line items > id
quote_id > _quote_line_items_metadata → Quotes > id
quote_line_item_id > _quote_line_items_metadata → Quotes - Details - Line items > id
quote_id > _quote_line_items_price_currency_options → Quotes > id
quote_line_item_id > _quote_line_items_price_currency_options → Quotes - Details - Line items > id
quote_id > _quote_line_items_price_currency_options_tiers → Quotes > id
quote_line_item_id > _quote_line_items_price_currency_options_tiers → Quotes - Details - Line items > id
quote_id > _quote_line_items_price_metadata → Quotes > id
quote_line_item_id > _quote_line_items_price_metadata → Quotes - Details - Line items > id
quote_id > _quote_line_items_price_tiers → Quotes > id
quote_line_item_id > _quote_line_items_price_tiers → Quotes - Details - Line items > id
quote_id > _quote_line_items_taxes → Quotes > id
quote_line_item_id > _quote_line_items_taxes → Quotes - Details - Line items > id
quote_id > _quote_line_items_taxes_rate_metadata → Quotes > id
quote_line_item_id > _quote_line_items_taxes_rate_metadata → Quotes - Details - Line items > id

Main object

Line items of each quote.

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
id	text	[en] Unique identifier for the object.
adjustable_quantity_enabled	boolean	[en] Whether the customer can adjust the quantity of this item in Checkout. Values: true (yes) or false (no).
adjustable_quantity_maximum	int	[en] Maximum quantity the customer can choose for this item in Checkout.
adjustable_quantity_minimum	int	[en] Minimum quantity the customer can choose for this item in Checkout.
amount_discount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total discount amount applied. If no discounts were applied, defaults to 0.
amount_subtotal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total before any discounts or taxes are applied.
amount_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total tax amount applied. If no tax was applied, defaults to 0.
amount_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total after discounts and taxes.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
price_id	text	[en] Unique identifier for the object.
price_active	boolean	[en] Whether the price can be used for new purchases. Values: true (yes) or false (no).
price_billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
price_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
price_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
price_custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
price_custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
price_custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
price_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
price_lookup_key	text	[en] A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
price_nickname	text	[en] A brief description of the price, hidden from customers.
price_product	text	[en] The ID of the product this price is associated with.
price_recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
price_recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
price_recurring_meter	text	[en] The meter tracking the usage of a metered price…
price_recurring_usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.
price_tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
price_tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
price_transform_quantity_divide_by	int	[en] Divide usage by this number.
price_transform_quantity_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
price_type	text	[en] One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: one_time = one-time price; recurring = recurring price (subscription).
price_unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
price_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
quantity	int	[en] The quantity of products being purchased.

stripe_quote_line_items_discounts

Quotes - Details - Line items: discounts (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount discounted.
discount_id	text	[en] The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.
discount_checkout_session	text	[en] The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
discount_customer	text	[en] The ID of the customer associated with this discount.
discount_customer_account	text	[en] The ID of the account representing the customer associated with this discount.
discount_end	timestamp	[en] If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. Date and time in UTC.
discount_invoice	text	[en] The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
discount_invoice_item	text	[en] The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
discount_promotion_code	text	[en] The promotion code applied to create this discount.
discount_source_coupon	text	[en] The coupon that was redeemed to create this discount.
discount_source_type	text	[en] The source type of the discount. Possible values: coupon = coupon.
discount_start	timestamp	[en] Date that the coupon was applied. Date and time in UTC.
discount_subscription	text	[en] The subscription that this coupon is applied to, if it is applied to a particular subscription.
discount_subscription_item	text	[en] The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

stripe_quote_line_items_metadata

Quotes - Details - Line items: metadata (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_quote_line_items_price_currency_options

Quotes - Details - Line items: price.currency_options (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_quote_line_items_price_currency_options_tiers

Quotes - Details - Line items: price.currency_options.tiers (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_quote_line_items_price_currency_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_quote_line_items_price_metadata

Quotes - Details - Line items: price.metadata (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_quote_line_items_price_tiers

Quotes - Details - Line items: price.tiers (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_quote_line_items_taxes

Quotes - Details - Line items: taxes (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of tax applied for this rate.
rate_id	text	[en] Unique identifier for the object.
rate_active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
rate_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
rate_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
rate_description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
rate_display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
rate_effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
rate_flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
rate_flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
rate_inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
rate_jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
rate_jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
rate_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
rate_percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
rate_state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
rate_tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).
taxability_reason	text	[en] The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt = customer is tax exempt; not_collecting = not registered to collect tax; not_subject_to_tax = not subject to tax; not_supported = jurisdiction not supported; portion_product_exempt = portion of product exempt; portion_reduced_rated = portion at reduced rate; portion_standard_rated = portion at standard rate; product_exempt = product exempt; product_exempt_holiday = product exempt due to tax holiday; proportionally_rated = proportionally rated; reduced_rated = reduced rate; reverse_charge = reverse charge: buyer accounts for the tax; standard_rated = standard rate; taxable_basis_reduced = reduced taxable basis; zero_rated = zero rated.
taxable_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount on which tax is calculated.

stripe_quote_line_items_taxes_rate_metadata

Quotes - Details - Line items: taxes.rate.metadata (one row per item; joins stripe_quote_line_items by column quote_line_item_id).

Field	Type
quote_id	text	[en] Identifier of the parent record (id column of table stripe_quotes). Quotes > > id
quote_line_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_quote_line_items). Quotes - Details - Line items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_quote_line_items_taxes, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Radar reviews

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

charge → Charges > id
payment_intent → Payment intents > id

Reviews of payments flagged by Radar for manual review, with reason and outcome.

Field	Type
id	text	[en] Unique identifier for the object.
billing_zip	text	[en] The ZIP or postal code of the card used, if applicable.
charge	text	[en] The charge associated with this review. Charges > > id
closed_reason	text	[en] The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged. Possible values: acknowledged = review acknowledged and closed; approved = payment approved; canceled = payment canceled; disputed = payment disputed; payment_never_settled = payment never settled; redacted = data redacted; refunded = payment refunded; refunded_as_fraud = refunded as fraud.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
ip_address	text	[en] The IP address where the payment originated.
ip_address_location_city	text	[en] The city where the payment originated.
ip_address_location_country	text	[en] Two-letter ISO code representing the country where the payment originated.
ip_address_location_latitude	float	[en] The geographic latitude where the payment originated.
ip_address_location_longitude	float	[en] The geographic longitude where the payment originated.
ip_address_location_region	text	[en] The state/county/province/region where the payment originated.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
open	boolean	[en] If true, the review needs action. Values: true (yes) or false (no).
opened_reason	text	[en] The reason the review was opened. One of rule or manual. Possible values: manual = opened manually; rule = opened by a Radar rule.
payment_intent	text	[en] The PaymentIntent ID associated with this review, if one exists. Payment intents > > id
reason	text	[en] The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.
session_browser	text	[en] The browser used in this browser session (e.g., Chrome).
session_device	text	[en] Information about the device used for the browser session (e.g., Samsung SM-G930T).
session_platform	text	[en] The platform for the browser session (e.g., Macintosh).
session_version	text	[en] The version for the browser session (e.g., 61.0.3163.100).

Radar value lists

Replication type: Full

Relationships:

value_list_id > _radar_value_lists_metadata → Radar value lists > id

Main object

Radar value lists (block/allow lists of emails, cards, IPs...) used in fraud rules.

Field	Type
id	text	[en] Unique identifier for the object.
alias	text	[en] The name of the value list for use in rules.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
created_by	text	[en] The name or email address of the user who created this value list.
item_type	text	[en] The type of items in the value list. One of card_fingerprint, card_bin, crypto_fingerprint, email, ip_address, country, string, case_sensitive_string, customer_id, account, sepa_debit_fingerprint, or us_bank_account_fingerprint. Possible values: account = account ID; card_bin = card BIN (first digits); card_fingerprint = card fingerprint; case_sensitive_string = case-sensitive string; country = country; crypto_fingerprint = crypto wallet fingerprint; customer_id = customer ID; email = email address; ip_address = IP address; sepa_debit_fingerprint = SEPA Debit account fingerprint; string = string (case-insensitive); us_bank_account_fingerprint = US bank account fingerprint.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
name	text	[en] The name of the value list.

stripe_radar_value_lists_metadata

Radar value lists: metadata (one row per item; joins stripe_radar_value_lists by column value_list_id).

Field

Type

value_list_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_radar_value_lists).

Radar value lists > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Radar value lists - Details - Items

Replication type: Full

Relationships:

value_list_id → Radar value lists > id
value_list → Radar value lists > id

Values of each Radar list.

Field	Type
value_list_id	text	[en] Identifier of the parent record (id column of table stripe_radar_value_lists). Radar value lists > > id
id	text	[en] Unique identifier for the object.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
created_by	text	[en] The name or email address of the user who added this item to the value list.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
value	text	[en] The value of the item.
value_list	text	[en] The identifier of the value list this item belongs to. Radar value lists > > id

Refunds

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
charge → Charges > id
customer → Customers > id
payment_intent → Payment intents > id
refund_id > _refunds_metadata → Refunds > id

Main object

Refunds of charges, with amount (positive, in the charge currency), reason, status and the same amount in your balance currency (balance_transaction_* columns, negative there because it left the balance). Empty reason = not given (refund made in the Dashboard without a reason).

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount. Positive here; in balance transactions the same refund is negative (it left the balance). In the charge currency; in your balance currency: balance_transaction_amount.
balance_transaction	text	[en] Balance transaction that describes the impact on your account balance. Balance transactions > > id
charge	text	[en] ID of the charge that's refunded. Charges > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] ID of the customer of this refund. Customers > > id
customer_account	text	[en] ID of the account of this refund.
description	text	[en] An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).
destination_details_blik_network_decline_code	text	[en] For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
destination_details_blik_reference	text	[en] The reference assigned to the refund.
destination_details_blik_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_br_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_br_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_card_reference	text	[en] Value of the reference number assigned to the refund.
destination_details_card_reference_status	text	[en] Status of the reference number on the refund. This can be pending, available or unavailable.
destination_details_card_reference_type	text	[en] Type of the reference number assigned to the refund.
destination_details_card_type	text	[en] The type of refund. This can be refund, reversal, or pending. Possible values: pending = resume pending; refund = refund; reversal = reversal.
destination_details_crypto_reference	text	[en] The transaction hash of the refund.
destination_details_eu_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_eu_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_gb_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_gb_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_jp_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_jp_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_mb_way_reference	text	[en] The reference assigned to the refund.
destination_details_mb_way_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_multibanco_reference	text	[en] The reference assigned to the refund.
destination_details_multibanco_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_mx_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_mx_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_p24_reference	text	[en] The reference assigned to the refund.
destination_details_p24_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_paypal_network_decline_code	text	[en] For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
destination_details_swish_network_decline_code	text	[en] For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
destination_details_swish_reference	text	[en] The reference assigned to the refund.
destination_details_swish_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_th_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_th_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
destination_details_type	text	[en] The type of transaction-specific details of the payment method used in the refund (e.g., card). An additional hash is included on destination_details with a name matching this value. It contains information specific to the refund transaction.
destination_details_us_bank_transfer_reference	text	[en] The reference assigned to the refund.
destination_details_us_bank_transfer_reference_status	text	[en] Status of the reference on the refund. This can be pending, available or unavailable.
failure_balance_transaction	text	[en] After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
failure_reason	text	[en] Provides 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.
instructions_email	text	[en] For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
next_action_display_details_email_sent_email_sent_at	timestamp	[en] The timestamp when the email was sent. Date and time in UTC.
next_action_display_details_email_sent_email_sent_to	text	[en] The recipient's email address.
next_action_display_details_expires_at	timestamp	[en] The expiry timestamp. Date and time in UTC.
next_action_type	text	[en] Type of the next action to perform.
payment_intent	text	[en] ID of the PaymentIntent that's refunded. Payment intents > > id
payment_method	text	[en] ID of the payment method associated with this refund.
pending_reason	text	[en] Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending. Possible values: charge_pending = original charge still pending; insufficient_funds = insufficient balance for refund; processing = refund being processed.
presentment_details_presentment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount intended to be collected by this payment, denominated in presentment_currency.
presentment_details_presentment_currency	text	[en] Currency presented to the customer during payment.
reason	text	[en] Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge). Possible values: duplicate = duplicate charge; expired_uncaptured_charge = uncaptured charge expired; fraudulent = fraudulent; requested_by_customer = requested by customer. Empty = reason not given (refund made in the Dashboard without choosing a reason).
receipt_number	text	[en] This is the transaction number that appears on email receipts sent for this refund.
source_transfer_reversal	text	[en] The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
status	text	[en] Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled.
transfer_reversal	text	[en] This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
balance_transaction_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. This amount converted to the currency of your Stripe balance (e.g. BRL), as recorded in the balance.
balance_transaction_fee	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Stripe fee for this transaction, in the currency of your Stripe balance.
balance_transaction_net	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Net amount (amount minus Stripe fee), in the currency of your Stripe balance.
balance_transaction_currency	text	[en] Currency of your Stripe balance in which balance_transaction_amount, balance_transaction_fee and balance_transaction_net are expressed.
balance_transaction_exchange_rate	float	[en] Exchange rate used to convert this amount to the balance currency (amount x exchange_rate = balance_transaction_amount). Empty when there was no conversion.
balance_transaction_available_on	timestamp	[en] Date the money becomes available in your Stripe balance for payout. Date and time in UTC.
balance_transaction_status	text	[en] Whether the money is already available in your Stripe balance (available) or not yet (pending).

stripe_refunds_metadata

Refunds: metadata (one row per item; joins stripe_refunds by column refund_id).

Field

Type

refund_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_refunds).

Refunds > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Setup intents

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
setup_intent_id > _setup_intents_allowed_payment_method_types → Setup intents > id
setup_intent_id > _setup_intents_excluded_payment_method_types → Setup intents > id
setup_intent_id > _setup_intents_flow_directions → Setup intents > id
setup_intent_id > _setup_intents_metadata → Setup intents > id
setup_intent_id > _setup_intents_payment_method_options → Setup intents > id
setup_intent_id > _setup_intents_pay_fin_filte_account_subcategories → Setup intents > id
setup_intent_id > _setup_intents_pay_financial_connectio_permissions → Setup intents > id
setup_intent_id > _setup_intents_paym_financial_connections_prefetch → Setup intents > id
setup_intent_id > _setup_intents_payment_mandate_options_default_for → Setup intents > id
setup_intent_id > _setup_intents_pay_mandate_options_supported_types → Setup intents > id
setup_intent_id > _setup_intents_payment_method_types → Setup intents > id

Main object

Setup intents: only saving cards or other payment methods to charge later. No money moves; a failure here is a failure to SAVE the card, not a declined payment.

Field	Type
id	text	[en] Unique identifier for the object.
application	text	[en] ID of the Connect application that created the SetupIntent.
attach_to_self	boolean	[en] If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. Values: true (yes) or false (no).
automatic_payment_methods_allow_redirects	text	[en] Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. Possible values: always = accepts redirect-based methods; never = rejects redirect-based methods.
automatic_payment_methods_enabled	boolean	[en] Automatically calculates compatible payment methods… Values: true (yes) or false (no).
cancellation_reason	text	[en] Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate. Possible values: abandoned = abandoned by customer; duplicate = duplicate payment; requested_by_customer = requested by customer.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
customer	text	[en] ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. Customers > > id
customer_account	text	[en] ID of the Account this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
last_setup_error_advice_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
last_setup_error_charge	text	[en] For card errors, the ID of the failed charge.
last_setup_error_code	text	[en] For some errors that could be handled programmatically, a short string indicating the error code reported.
last_setup_error_decline_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
last_setup_error_doc_url	text	[en] A URL to more information about the error code reported.
last_setup_error_message	text	[en] A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
last_setup_error_network_advice_code	text	[en] For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
last_setup_error_network_decline_code	text	[en] For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
last_setup_error_param	text	[en] If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
last_setup_error_payment_intent_id	text	[en] A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system.
last_setup_error_payment_method_id	text	[en] PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.
last_setup_error_payment_method_type	text	[en] If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
last_setup_error_request_log_url	text	[en] A URL to the request log entry in your dashboard.
last_setup_error_setup_intent_id	text	[en] A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
last_setup_error_source_id	text	[en] The source object for errors returned on a request involving a source.
last_setup_error_type	text	[en] The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error… Possible values: api_error = Stripe API internal error; card_error = card error (e.g. decline); idempotency_error = idempotency key error; invalid_request_error = invalid request.
latest_attempt	text	[en] The most recent SetupAttempt for this SetupIntent.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
managed_payments_enabled	boolean	[en] Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session. Values: true (yes) or false (no).
mandate	text	[en] ID of the multi use Mandate generated by the SetupIntent.
on_behalf_of	text	[en] The account (if any) for which the setup is intended.
payment_method	text	[en] ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
payment_method_configuration_details_id	text	[en] ID of the payment method configuration used.
payment_method_configuration_details_parent	text	[en] ID of the parent payment method configuration used.
single_use_mandate	text	[en] ID of the single_use Mandate generated by the SetupIntent.
status	text	[en] Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded. Possible values: canceled = canceled; processing = processing; requires_action = requires customer action (e.g. 3D Secure); requires_confirmation = awaiting confirmation; requires_payment_method = awaiting a payment method; succeeded = succeeded.
usage	text	[en] Indicates how the payment method is intended to be used in the future. Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow.

stripe_setup_intents_allowed_payment_method_types

Setup intents: allowed_payment_method_types (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field

Type

setup_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents).

Setup intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. Possible values: acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boku_promptpay = PromptPay via Boku (Thailand); boleto = boleto bank slip (Brazil); capchase_pay = Capchase Pay (B2B financing); card = card (online); card_present = in-person card (Terminal); cashapp = Cash App Pay (US); check_scan = check scan; click_to_pay = Click to Pay (card network wallet); crypto = crypto (stablecoin); customer_balance = customer cash balance (bank transfer); demo_pay = demo payment method (testing); duitnow = DuitNow (Malaysia); dummy_auth_push = dummy test method; dummy_passthrough_card = dummy test card; edenred = Edenred (benefit voucher); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); gcash = GCash (wallet, Philippines); getbalance = Balance (B2B payments); gift_card = gift card; giropay = giropay (bank transfer, Germany); gopay = GoPay (wallet, Indonesia); grabpay = GrabPay (digital wallet, Southeast Asia); id_bank_transfer = bank transfer (Indonesia); ideal = iDEAL (bank transfer, Netherlands); interac_present = in-person Interac card (Canada); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); knet = KNET (Kuwait); konbini = Konbini (convenience store, Japan); kr_card = Korean card; kr_market = South Korea local methods; kriya = Kriya (B2B pay later, UK); link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); momo = MoMo (wallet, Vietnam); mondu = Mondu (B2B pay later); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); netbanking = netbanking (India); ng_bank = bank (Nigeria); ng_bank_transfer = bank transfer (Nigeria); ng_card = card (Nigeria); ng_market = Nigeria local methods; ng_ussd = USSD (Nigeria); ng_wallet = wallet (Nigeria); nz_bank_account = bank account debit (New Zealand); octopus = Octopus (card, Hong Kong); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); paper_check = paper check; pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); qris = QRIS (QR, Indonesia); rechnung = Rechnung (invoice, Germany); revolut_pay = Revolut Pay (digital wallet); samsung_pay = Samsung Pay (digital wallet); satispay = Satispay (mobile payment, Italy); scalapay = Scalapay (buy now pay later, Europe); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); shop_pay = Shop Pay (Shopify); shopeepay = ShopeePay (wallet); sofort = Sofort (bank transfer, Europe); south_korea_market = South Korea local methods; stripe_balance = Stripe account balance; sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); tamara = Tamara (buy now pay later, Middle East); test_pay = test payment method; touch_n_go = Touch 'n Go (wallet, Malaysia); truemoney = TrueMoney (wallet, Thailand); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); us_cash_voucher = cash voucher (US); vipps = Vipps (wallet, Norway); wechat_pay = WeChat Pay (digital wallet, China); wero = Wero (wallet, Europe); zip = Zip (buy now pay later).

stripe_setup_intents_excluded_payment_method_types

Setup intents: excluded_payment_method_types (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field

Type

setup_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents).

Setup intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Payment method types that are excluded from this SetupIntent. Possible values: acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); afterpay_clearpay = Afterpay/Clearpay (buy now pay later); alipay = Alipay (digital wallet, China); alma = Alma (installments, France); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); bizum = Bizum (mobile payment, Spain); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); cashapp = Cash App Pay (US); crypto = crypto (stablecoin); customer_balance = customer cash balance (bank transfer); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); kr_card = Korean card; mb_way = MB WAY (mobile payment, Portugal); mobilepay = MobilePay (digital wallet, Nordics); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); nz_bank_account = bank account debit (New Zealand); oxxo = OXXO (cash voucher, Mexico); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); paypay = PayPay (digital wallet, Japan); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); revolut_pay = Revolut Pay (digital wallet); samsung_pay = Samsung Pay (digital wallet); satispay = Satispay (mobile payment, Italy); scalapay = Scalapay (buy now pay later, Europe); sepa_debit = SEPA Direct Debit (Europe); sequra = SeQura (buy now pay later, Spain); sofort = Sofort (bank transfer, Europe); sunbit = Sunbit (buy now pay later, US); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China); zip = Zip (buy now pay later).

stripe_setup_intents_flow_directions

Setup intents: flow_directions (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field

Type

setup_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents).

Setup intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] Indicates the directions of money movement for which this payment method is intended to be used. Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. Possible values: inbound = inbound; outbound = outbound.

stripe_setup_intents_metadata

Setup intents: metadata (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field

Type

setup_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents).

Setup intents > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_setup_intents_payment_method_options

Setup intents: payment_method_options (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
billing_agreement_id	text	[en] The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
currency	text	[en] Currency supported by the bank account… Possible values: cad = Canadian dollar; usd = US dollar.
financial_connections_return_url	text	[en] For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
mandate_options_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount that will be collected. It is required when amount_type is fixed.
mandate_options_amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
mandate_options_amount_type	text	[en] The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible values: fixed = exact amount to charge; maximum = maximum amount to charge.
mandate_options_collection_method	text	[en] Mandate collection method… Possible values: paper = paper mandate.
mandate_options_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
mandate_options_custom_mandate_url	text	[en] A URL for custom mandate text…
mandate_options_description	text	[en] A description of the mandate or subscription that is meant to be displayed to the customer.
mandate_options_end_date	text	[en] Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
mandate_options_expires_at	timestamp	[en] Date at which the mandate expires. Date and time in UTC.
mandate_options_interval	text	[en] Specifies payment frequency. One of day, week, month, year, or sporadic. Possible values: day = daily; month = monthly; sporadic = sporadic; week = weekly; year = yearly.
mandate_options_interval_count	int	[en] The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.
mandate_options_interval_description	text	[en] Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
mandate_options_payment_schedule	text	[en] Payment schedule for the mandate. Possible values: combined = combined: interval and sporadic; interval = at fixed intervals; sporadic = sporadic, on demand.
mandate_options_payments_per_period	int	[en] The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.
mandate_options_purpose	text	[en] The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support = dependant support; government = government payment; loan = loan; mortgage = mortgage; other = other purpose; pension = pension; personal = personal payment; retail = retail purchase; salary = salary; tax = tax payment; utility = utility bills.
mandate_options_reference	text	[en] Unique identifier for the mandate or subscription.
mandate_options_reference_prefix	text	[en] Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
mandate_options_start_date	text	[en] Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
mandate_options_transaction_type	text	[en] Transaction type of the mandate. Possible values: business = business transaction; personal = personal transaction.
mandate_options_type	text	[en] Type of the mandate. Possible values: off_session = customer not present (off-session).
network	text	[en] Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. Possible values: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa.
preferred_locale	text	[en] Preferred locale of the Klarna checkout page that the customer is redirected to.
request_three_d_secure	text	[en] We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Possible values: any = request 3D Secure whenever possible; automatic = Stripe decides when 3D Secure is required; challenge = force a 3D Secure challenge.
verification_method	text	[en] Bank account verification method. The default value is automatic. Possible values: automatic = automatic (instant or microdeposits); instant = instant verification; microdeposits = microdeposit verification.

stripe_setup_intents_pay_fin_filte_account_subcategories

Setup intents: payment_method_options.financial_connections.filters.account_subcategories (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_setup_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible values: checking = checking account; savings = savings account.

stripe_setup_intents_pay_financial_connectio_permissions

Setup intents: payment_method_options.financial_connections.permissions (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_setup_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The list of permissions to request. The payment_method permission must be included. Possible values: balances = account balances; ownership = account ownership; payment_method = use as payment method; transactions = account transactions.

stripe_setup_intents_paym_financial_connections_prefetch

Setup intents: payment_method_options.financial_connections.prefetch (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_setup_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Data features requested to be retrieved upon account creation. Possible values: balances = balances; ownership = ownership; transactions = transactions.

stripe_setup_intents_payment_mandate_options_default_for

Setup intents: payment_method_options.mandate_options.default_for (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_setup_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] List of Stripe products where this mandate can be selected automatically. Possible values: invoice = default for invoices; subscription = default for subscriptions.

stripe_setup_intents_pay_mandate_options_supported_types

Setup intents: payment_method_options.mandate_options.supported_types (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field	Type
setup_intent_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents). Setup intents > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_setup_intents_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Specifies the type of mandates supported. Possible values are india. Possible values: india = India mandate.

stripe_setup_intents_payment_method_types

Setup intents: payment_method_types (one row per item; joins stripe_setup_intents by column setup_intent_id).

Field

Type

setup_intent_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_setup_intents).

Setup intents > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.

Shipping rates

Replication type: Full

Relationships:

shipping_rate_id > _shipping_rates_fixed_amount_currency_options → Shipping rates > id
shipping_rate_id > _shipping_rates_metadata → Shipping rates > id

Main object

Shipping rates offered in Checkout and invoices.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Whether the shipping rate can be used for new purchases. Defaults to true. Values: true (yes) or false (no).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
delivery_estimate_maximum_unit	text	[en] A unit of time. Possible values: business_day = business day; day = day; hour = hour; month = month; week = week.
delivery_estimate_maximum_value	int	[en] Must be greater than 0.
delivery_estimate_minimum_unit	text	[en] A unit of time. Possible values: business_day = business day; day = day; hour = hour; month = month; week = week.
delivery_estimate_minimum_value	int	[en] Must be greater than 0.
display_name	text	[en] The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
fixed_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing how much to charge.
fixed_amount_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
tax_behavior	text	[en] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
tax_code	text	[en] A tax code ID. The Shipping tax code is txcd_92010001.
type	text	[en] The type of calculation to use on the shipping rate. Possible values: fixed_amount = fixed shipping amount.

stripe_shipping_rates_fixed_amount_currency_options

Shipping rates: fixed_amount.currency_options (one row per item; joins stripe_shipping_rates by column shipping_rate_id).

Field	Type
shipping_rate_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_shipping_rates). Shipping rates > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. A value representing how much to charge.
tax_behavior	text	[en] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.

stripe_shipping_rates_metadata

Shipping rates: metadata (one row per item; joins stripe_shipping_rates by column shipping_rate_id).

Field

Type

shipping_rate_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_shipping_rates).

Shipping rates > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Subscription schedules

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
subscription → Subscriptions > id
subscription_schedule_id > _subscription_schedules_def_invoic_account_tax_ids → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_def_invoice__custom_fields → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_metadata → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_pause_schedules → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_add_invoice_items → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_add_invoi_discounts → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_add_invoic_metadata → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_add_invoi_tax_rates → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_default_tax_rates → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_default_ta_metadata → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_discounts → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_inv_account_tax_ids → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_invoi_custom_fields → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_items → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_items_discounts → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_items_metadata → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_items_tax_rates → Subscription schedules > id
subscription_schedule_id > _subscription_schedules_phases_metadata → Subscription schedules > id

Main object

Subscription schedules: planned changes (phases) of a subscription.

Field	Type
id	text	[en] Unique identifier for the object.
application	text	[en] ID of the Connect Application that created the schedule.
billing_mode_flexible_proration_discounts	text	[en] Controls how invoices and invoice items display proration amounts and discount amounts. Possible values: included = discounts included in proration amounts; itemized = discounts shown as separate items.
billing_mode_type	text	[en] Controls how prorations and invoices for subscriptions are calculated and orchestrated. Possible values: classic = classic billing mode; flexible = flexible billing mode.
billing_mode_updated_at	timestamp	[en] Details on when the current billing_mode was adopted. Date and time in UTC.
canceled_at	timestamp	[en] Time at which the subscription schedule was canceled. Date and time in UTC.
completed_at	timestamp	[en] Time at which the subscription schedule was completed. Date and time in UTC.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
current_phase_end_date	timestamp	[en] The end of this phase of the subscription schedule. Date and time in UTC.
current_phase_start_date	timestamp	[en] The start of this phase of the subscription schedule. Date and time in UTC.
customer	text	[en] ID of the customer who owns the subscription schedule. Customers > > id
customer_account	text	[en] ID of the account who owns the subscription schedule.
default_settings_application_fee_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
default_settings_automatic_tax_disabled_reason	text	[en] If Stripe disabled automatic tax, this enum describes why. Possible values: requires_location_inputs = requires customer location inputs.
default_settings_automatic_tax_enabled	boolean	[en] Whether Stripe automatically computes tax on invoices created during this phase. Values: true (yes) or false (no).
default_settings_automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
default_settings_automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
default_settings_billing_cycle_anchor	text	[en] Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. Possible values: automatic = billing anchor kept automatically; phase_start = anchor reset at phase start.
default_settings_billing_thresholds_amount_gte	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Monetary threshold that triggers the subscription to create an invoice…
default_settings_billing_threshol_reset_billing_cycle_anchor	boolean	[en] Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. Values: true (yes) or false (no).
default_settings_collection_method	text	[en] Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. Possible values: charge_automatically = charged automatically to payment method; send_invoice = invoice emailed for customer to pay.
default_settings_default_payment_method	text	[en] ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
default_settings_description	text	[en] Subscription 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.
default_settings_invoice_settings_days_until_due	int	[en] Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
default_settings_invoice_settings_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
default_settings_invoice_settings_footer	text	[en] Footer to be displayed on the invoice.
default_settings_invoice_settings_issuer_account	text	[en] The connected account being referenced when type is account.
default_settings_invoice_settings_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
default_settings_on_behalf_of	text	[en] The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription.
default_settings_transfer_data_amount_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
default_settings_transfer_data_destination	text	[en] The account where funds from the payment will be transferred to upon payment success.
end_behavior	text	[en] Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. Possible values: cancel = cancels subscription at end; none = no action at end; release = releases subscription from schedule; renew = renews the schedule.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
released_at	timestamp	[en] Time at which the subscription schedule was released. Date and time in UTC.
released_subscription	text	[en] ID of the subscription once managed by the subscription schedule (if it is released).
status	text	[en] The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide. Possible values: active = active, in effect; canceled = canceled; completed = completed; not_started = not started yet; released = released: subscription continues unscheduled.
subscription	text	[en] ID of the subscription managed by the subscription schedule. Subscriptions > > id
test_clock	text	[en] ID of the test clock this subscription schedule belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.

stripe_subscription_schedules_def_invoic_account_tax_ids

Subscription schedules: default_settings.invoice_settings.account_tax_ids (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field

Type

subscription_schedule_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules).

Subscription schedules > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.

stripe_subscription_schedules_def_invoice__custom_fields

Subscription schedules: default_settings.invoice_settings.custom_fields (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_subscription_schedules_metadata

Subscription schedules: metadata (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field

Type

subscription_schedule_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules).

Subscription schedules > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_subscription_schedules_pause_schedules

Subscription schedules: pause_schedules (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
key	text	[en] A unique identifier for this pause schedule.
pause_pause_at	timestamp	[en] Time at which the subscription pauses. Date and time in UTC.
pause_settings_bill_for_outstanding_usage_through_type	text	[en] The type of outstanding usage billing behavior. Possible values: none = no account type; pause_at = from the pause date.
pause_settings_bill_for_unused_time_from_type	text	[en] The type of unused time credit behavior. Possible values: item_current_period_start = item current period start; none = no account type; pause_at = from the pause date.
pause_settings_invoicing_behavior	text	[en] Determines how to handle debits and credits when pausing. Possible values: invoice = invoice debits and credits immediately; pending_invoice_item = leave as pending invoice items.
pause_settings_type	text	[en] The type of pause settings. Possible values: subscription = subscription pause.
pause_status_error_code	text	[en] A machine-readable error code.
pause_status_error_message	text	[en] A description of the error.
pause_status_type	text	[en] The lifecycle state of the pause operation. Possible values: error = resume errored; scheduled = resume scheduled; succeeded = resume succeeded.
resume_resume_at	timestamp	[en] Time at which the subscription resumes. Date and time in UTC.
resume_settings_billing_cycle_anchor	text	[en] The billing cycle anchor that applies when the subscription is resumed. Possible values: resume_at = anchor reset at resume time; unchanged = billing anchor unchanged.
resume_settings_payment_behavior	text	[en] Controls whether Stripe attempts payment on the resumption invoice and how that affects the subscription's status. Possible values: resume_on_payment_attempt = resumes on payment attempt; resume_on_payment_success = resumes only on payment success.
resume_settings_proration_behavior	text	[en] Determines how to handle prorations resulting from the billing_cycle_anchor change on resume. Possible values: always_invoice = create prorations and invoice immediately; create_prorations = create prorations for next invoice; none = no prorations.
resume_status_error_code	text	[en] A machine-readable error code.
resume_status_error_message	text	[en] A description of the error.
resume_status_type	text	[en] The lifecycle state of the resume operation. Possible values: error = resume errored; pending = resume pending; requires_action = resume requires action; scheduled = resume scheduled; succeeded = resume succeeded.

stripe_subscription_schedules_phases

Subscription schedules: phases (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
application_fee_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
automatic_tax_disabled_reason	text	[en] If Stripe disabled automatic tax, this enum describes why. Possible values: requires_location_inputs = requires customer location inputs.
automatic_tax_enabled	boolean	[en] Whether Stripe automatically computes tax on invoices created during this phase. Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
billing_cycle_anchor	text	[en] Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. Possible values: automatic = billing anchor kept automatically; phase_start = anchor reset at phase start.
billing_thresholds_amount_gte	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Monetary threshold that triggers the subscription to create an invoice…
billing_thresholds_reset_billing_cycle_anchor	boolean	[en] Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. Values: true (yes) or false (no).
collection_method	text	[en] Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. Possible values: charge_automatically = charged automatically to payment method; send_invoice = invoice emailed for customer to pay.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
default_payment_method	text	[en] ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
description	text	[en] Subscription 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.
end_date	timestamp	[en] The end of this phase of the subscription schedule. Date and time in UTC.
invoice_settings_days_until_due	int	[en] Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
invoice_settings_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
invoice_settings_footer	text	[en] Footer to be displayed on the invoice.
invoice_settings_issuer_account	text	[en] The connected account being referenced when type is account.
invoice_settings_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
on_behalf_of	text	[en] The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription.
proration_behavior	text	[en] When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice. Possible values: always_invoice = create prorations and invoice immediately; create_prorations = create prorations for next invoice; none = no prorations.
start_date	timestamp	[en] The start of this phase of the subscription schedule. Date and time in UTC.
transfer_data_amount_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
transfer_data_destination	text	[en] The account where funds from the payment will be transferred to upon payment success.
trial	boolean	[en] If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. Values: true (yes) or false (no).
trial_end	timestamp	[en] When the trial ends within the phase. Date and time in UTC.

stripe_subscription_schedules_phases_add_invoice_items

Subscription schedules: phases.add_invoice_items (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
discountable	boolean	[en] Controls whether discounts apply to this invoice item. Defaults to true if no value is provided. Values: true (yes) or false (no).
period_end_timestamp	timestamp	[en] A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start. Date and time in UTC.
period_end_type	text	[en] Select how to calculate the end of the invoice item period. Possible values: min_item_period_end = earliest item period end; phase_end = phase end; timestamp = ends at a specific date.
period_start_timestamp	timestamp	[en] A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end. Date and time in UTC.
period_start_type	text	[en] Select how to calculate the start of the invoice item period. Possible values: max_item_period_start = latest item period start; phase_start = phase start; timestamp = ends at a specific date.
price	text	[en] ID of the price used to generate the invoice item.
quantity	int	[en] The quantity of the invoice item.

stripe_subscription_schedules_phases_add_invoi_discounts

Subscription schedules: phases.add_invoice_items.discounts (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_add_invoice_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
coupon	text	[en] ID of the coupon to create a new discount for.
discount	text	[en] ID of an existing discount on the object (or one of its ancestors) to reuse.
promotion_code	text	[en] ID of the promotion code to create a new discount for.

stripe_subscription_schedules_phases_add_invoic_metadata

Subscription schedules: phases.add_invoice_items.metadata (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_add_invoice_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_subscription_schedules_phases_add_invoi_tax_rates

Subscription schedules: phases.add_invoice_items.tax_rates (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_add_invoice_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.

stripe_subscription_schedules_phases_default_tax_rates

Subscription schedules: phases.default_tax_rates (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_subscription_schedules_phases_default_ta_metadata

Subscription schedules: phases.default_tax_rates.metadata (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_default_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_subscription_schedules_phases_discounts

Subscription schedules: phases.discounts (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
coupon	text	[en] ID of the coupon to create a new discount for.
discount	text	[en] ID of an existing discount on the object (or one of its ancestors) to reuse.
promotion_code	text	[en] ID of the promotion code to create a new discount for.

stripe_subscription_schedules_phases_inv_account_tax_ids

Subscription schedules: phases.invoice_settings.account_tax_ids (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.

stripe_subscription_schedules_phases_invoi_custom_fields

Subscription schedules: phases.invoice_settings.custom_fields (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_subscription_schedules_phases_items

Subscription schedules: phases.items (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
billing_thresholds_usage_gte	int	[en] Usage threshold that triggers the subscription to create an invoice…
price	text	[en] ID of the price to which the customer should be subscribed.
quantity	int	[en] Quantity of the plan to which the customer should be subscribed.

stripe_subscription_schedules_phases_items_discounts

Subscription schedules: phases.items.discounts (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
coupon	text	[en] ID of the coupon to create a new discount for.
discount	text	[en] ID of an existing discount on the object (or one of its ancestors) to reuse.
promotion_code	text	[en] ID of the promotion code to create a new discount for.

stripe_subscription_schedules_phases_items_metadata

Subscription schedules: phases.items.metadata (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.

stripe_subscription_schedules_phases_items_tax_rates

Subscription schedules: phases.items.tax_rates (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases_items, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.

stripe_subscription_schedules_phases_metadata

Subscription schedules: phases.metadata (one row per item; joins stripe_subscription_schedules by column subscription_schedule_id).

Field	Type
subscription_schedule_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_schedules). Subscription schedules > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_schedules_phases, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.

Subscriptions

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

customer → Customers > id
schedule → Subscription schedules > id
subscription_id > _subscriptions_billing_schedules → Subscriptions > id
subscription_id > _subscriptions_billing_schedules_applies_to → Subscriptions > id
subscription_id > _subscriptions_default_tax_rates → Subscriptions > id
subscription_id > _subscriptions_default_tax_rates_metadata → Subscriptions > id
subscription_id > _subscriptions_discounts → Subscriptions > id
subscription_id > _subscriptions_invoice_settings_account_tax_ids → Subscriptions > id
subscription_id > _subscriptions_invoice_settings_custom_fields → Subscriptions > id
subscription_id > _subscriptions_metadata → Subscriptions > id
subscription_id > _subscriptions_payment_sett_payment_method_options → Subscriptions > id
subscription_id > _subscriptions_pay_pay_fin_fil_account_subcategori → Subscriptions > id
subscription_id > _subscriptions_payment_setting_pay_fin_permissions → Subscriptions > id
subscription_id > _subscriptions_payment_settings_pay_finan_prefetch → Subscriptions > id
subscription_id > _subscriptions_payment_settin_payment_method_types → Subscriptions > id
subscription_id > _subscriptions_pending_update_discounts → Subscriptions > id
subscription_id > _subscriptions_pending_update_metadata → Subscriptions > id
subscription_id > _subscriptions_pending_update_subscription_items → Subscriptions > id

Main object

Subscriptions in every status (active, trialing, past due, canceled...), with billing cycle, periods, cancellation and discounts. Subscriptions change status after creation: for an always-faithful copy, choose Full (Integral) replication.

Field	Type
id	text	[en] Unique identifier for the object.
application	text	[en] ID of the Connect Application that created the subscription.
application_fee_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
automatic_tax_disabled_reason	text	[en] If Stripe disabled automatic tax, this enum describes why. Possible values: requires_location_inputs = requires customer location inputs.
automatic_tax_enabled	boolean	[en] Whether Stripe automatically computes tax on this subscription. Values: true (yes) or false (no).
automatic_tax_liability_account	text	[en] The connected account being referenced when type is account.
automatic_tax_liability_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
billing_cycle_anchor	timestamp	[en] The reference point that aligns future 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. Date and time in UTC.
billing_cycle_anchor_config_day_of_month	int	[en] The day of the month of the billing_cycle_anchor.
billing_cycle_anchor_config_hour	int	[en] The hour of the day of the billing_cycle_anchor.
billing_cycle_anchor_config_minute	int	[en] The minute of the hour of the billing_cycle_anchor.
billing_cycle_anchor_config_month	int	[en] The month to start full cycle billing periods.
billing_cycle_anchor_config_second	int	[en] The second of the minute of the billing_cycle_anchor.
billing_mode_flexible_proration_discounts	text	[en] Controls how invoices and invoice items display proration amounts and discount amounts. Possible values: included = discounts included in proration amounts; itemized = discounts shown as separate items.
billing_mode_type	text	[en] Controls how prorations and invoices for subscriptions are calculated and orchestrated. Possible values: classic = classic billing mode; flexible = flexible billing mode.
billing_mode_updated_at	timestamp	[en] Details on when the current billing_mode was adopted. Date and time in UTC.
billing_thresholds_amount_gte	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Monetary threshold that triggers the subscription to create an invoice…
billing_thresholds_reset_billing_cycle_anchor	boolean	[en] Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. Values: true (yes) or false (no).
cancel_at	timestamp	[en] A date in the future at which the subscription will automatically get canceled… Date and time in UTC.
cancel_at_period_end	boolean	[en] Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period. Values: true (yes) or false (no).
canceled_at	timestamp	[en] If the subscription has been canceled, the date of that cancellation. Date and time in UTC.
cancellation_details_comment	text	[en] Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
cancellation_details_feedback	text	[en] The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. Possible values: customer_service = unhappy with customer service; low_quality = quality was too low; missing_features = missing features; other = other reason; switched_service = switched to another service; too_complex = too complex; too_expensive = too expensive; unused = not using it enough.
cancellation_details_feedback_option	text	[en] Customized feedback options that provide deeper insight into why the subscription was canceled, if the subscription was canceled explicitly by the user.
cancellation_details_reason	text	[en] Why this subscription was canceled. Possible values: canceled_by_retention_policy = canceled by retention policy; cancellation_requested = cancellation requested; payment_disputed = payment disputed; payment_failed = payment failed.
collection_method	text	[en] Either 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. Possible values: charge_automatically = charged automatically to payment method; send_invoice = invoice emailed for customer to pay.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer	text	[en] ID of the customer who owns the subscription. Customers > > id
customer_account	text	[en] ID of the account representing the customer who owns the subscription.
days_until_due	int	[en] Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
default_payment_method	text	[en] ID 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 or default_source.
default_source	text	[en] ID 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.
description	text	[en] The 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.
ended_at	timestamp	[en] If the subscription has ended, the date the subscription ended. Date and time in UTC.
invoice_settings_description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
invoice_settings_footer	text	[en] Footer to be displayed on the invoice.
invoice_settings_issuer_account	text	[en] The connected account being referenced when type is account.
invoice_settings_issuer_type	text	[en] Type of the account referenced. Possible values: account = the account itself; self = self (the owner itself).
latest_invoice	text	[en] The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
managed_payments_enabled	boolean	[en] Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session. Values: true (yes) or false (no).
next_pending_invoice_item_invoice	timestamp	[en] Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval. Date and time in UTC.
on_behalf_of	text	[en] The account (if any) the charge was made on behalf of for charges associated with this subscription.
pause_collection_behavior	text	[en] The payment collection behavior for this subscription while paused. Possible values: keep_as_draft = invoices kept as draft; mark_uncollectible = invoices marked uncollectible; void = invoices voided.
pause_collection_resumes_at	timestamp	[en] The time after which the subscription will resume collecting payments. Date and time in UTC.
payment_settings_save_default_payment_method	text	[en] Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off. Possible values: off = do not update default payment method; on_subscription = set as subscription default.
pending_invoice_item_interval_interval	text	[en] Specifies invoicing frequency. Either day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
pending_invoice_item_interval_interval_count	int	[en] The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
pending_setup_intent	text	[en] You can use this SetupIntent 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.
pending_update_billing_cycle_anchor	timestamp	[en] If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. Date and time in UTC.
pending_update_cancel_at_period_end	boolean	[en] Indicates whether this subscription should cancel at the end of the current period if the update is applied. Values: true (yes) or false (no).
pending_update_discount_id	text	[en] The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.
pending_update_discount_checkout_session	text	[en] The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
pending_update_discount_customer	text	[en] The ID of the customer associated with this discount.
pending_update_discount_customer_account	text	[en] The ID of the account representing the customer associated with this discount.
pending_update_discount_end	timestamp	[en] If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. Date and time in UTC.
pending_update_discount_invoice	text	[en] The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
pending_update_discount_invoice_item	text	[en] The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
pending_update_discount_promotion_code	text	[en] The promotion code applied to create this discount.
pending_update_discount_source_coupon	text	[en] The coupon that was redeemed to create this discount.
pending_update_discount_source_type	text	[en] The source type of the discount. Possible values: coupon = coupon.
pending_update_discount_start	timestamp	[en] Date that the coupon was applied. Date and time in UTC.
pending_update_discount_subscription	text	[en] The subscription that this coupon is applied to, if it is applied to a particular subscription.
pending_update_discount_subscription_item	text	[en] The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
pending_update_expires_at	timestamp	[en] The point after which the changes reflected by this update will be discarded and no longer applied. Date and time in UTC.
pending_update_trial_end	timestamp	[en] Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. Date and time in UTC.
pending_update_trial_from_plan	boolean	[en] Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more. Values: true (yes) or false (no).
presentment_details_presentment_currency	text	[en] Currency used for customer payments.
schedule	text	[en] The schedule attached to the subscription… Subscription schedules > > id
start_date	timestamp	[en] Date when the subscription was first created. The date might differ from the created date due to backdating. Date and time in UTC.
status	text	[en] Possible 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. Possible values: active = active, in effect; canceled = canceled; incomplete = incomplete: first payment pending; incomplete_expired = expired without first payment; past_due = past due: payment failed; paused = paused; trialing = in trial period; unpaid = unpaid: invoices left unpaid. active does not guarantee the customer is paying (e.g. paused collection creates draft invoices): check paid invoices (status = paid).
status_details_paused_subscription_type	text	[en] The reason that the subscription was paused. Possible values: final_payment_failure = final payment failed; first_payment_failure = first payment failed; pause_requested = pause requested; system = paused by the system; trial_end_without_payment_method = trial ended without payment method.
status_details_paused_transitioned_at	timestamp	[en] Unix timestamp in seconds of when the subscription status transitioned to paused. Date and time in UTC.
status_details_paused_type	text	[en] The type of pause. Possible values: subscription = subscription pause.
test_clock	text	[en] ID of the test clock this subscription belongs to. Only filled in test mode (sk_test_/rk_test_ key), when the record was created attached to a test clock that simulates the passage of time; always empty in live mode.
transfer_data_amount_percent	float	[en] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
transfer_data_destination	text	[en] The account where funds from the payment will be transferred to upon payment success.
trial_end	timestamp	[en] If the subscription has a trial, the end of that trial. Date and time in UTC.
trial_settings_end_behavior_billing_cycle_anchor	text	[en] Indicates how the subscription's billing cycle anchor is reset when a trial ends. If not set, the default is now. Possible values: now = anchor reset when trial ends; unchanged = billing anchor unchanged.
trial_settings_end_behavior_missing_payment_method	text	[en] Indicates how the subscription should change when the trial ends if the user did not provide a payment method. Possible values: cancel = cancel the subscription; create_invoice = create invoice anyway; pause = pause the subscription.
trial_start	timestamp	[en] If the subscription has a trial, the beginning of that trial. Date and time in UTC.

stripe_subscriptions_billing_schedules

Subscriptions: billing_schedules (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
bill_until_computed_timestamp	timestamp	[en] The timestamp the billing schedule will apply until. Date and time in UTC.
bill_until_duration_interval	text	[en] Specifies billing duration. Either day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
bill_until_duration_interval_count	int	[en] The multiplier applied to the interval.
bill_until_timestamp	timestamp	[en] If specified, the billing schedule will apply until the specified timestamp. Date and time in UTC.
bill_until_type	text	[en] Describes how the billing schedule will determine the end date. Either duration or timestamp. Possible values: duration = ends after a duration; timestamp = ends at a specific date.
key	text	[en] Unique identifier for the billing schedule.

stripe_subscriptions_billing_schedules_applies_to

Subscriptions: billing_schedules.applies_to (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscriptions_billing_schedules, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
price	text	[en] The billing schedule will apply to the subscription item with the given price ID.
type	text	[en] Controls which subscription items the billing schedule applies to. Possible values: price = applies to specific prices.

stripe_subscriptions_default_tax_rates

Subscriptions: default_tax_rates (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_subscriptions_default_tax_rates_metadata

Subscriptions: default_tax_rates.metadata (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscriptions_default_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_subscriptions_discounts

Subscriptions: discounts (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

stripe_subscriptions_invoice_settings_account_tax_ids

Subscriptions: invoice_settings.account_tax_ids (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.

stripe_subscriptions_invoice_settings_custom_fields

Subscriptions: invoice_settings.custom_fields (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
name	text	[en] The name of the custom field.
value	text	[en] The value of the custom field.

stripe_subscriptions_metadata

Subscriptions: metadata (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_subscriptions_payment_sett_payment_method_options

Subscriptions: payment_settings.payment_method_options (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
bank_transfer_eu_bank_transfer_country	text	[en] The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL. Possible values: BE = Belgium; DE = Germany; ES = Spain; FR = France; IE = Ireland; NL = Netherlands.
bank_transfer_type	text	[en] The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
company_details_registered_address_city	text	[en] City, district, suburb, town, or village.
company_details_registered_address_country	text	[en] Two-letter country code.
company_details_registered_address_line1	text	[en] Address line 1 (for example, street, PO Box, or company name).
company_details_registered_address_line2	text	[en] Address line 2 (for example, apartment, suite, unit, or building).
company_details_registered_address_postal_code	text	[en] ZIP or postal code.
company_details_registered_address_state	text	[en] State, county, province, or region.
company_details_registered_name	text	[en] Company or entity name.
company_details_registration_number	text	[en] The official registration number for the given registration type.
company_details_registration_type	text	[en] Type of registration the company or entity holds in their registered country. Possible values: ch_ein = company ID number (Switzerland); de_hrb = HRB commercial register (Germany); dk_cvr = CVR number (Denmark); es_cif = CIF tax code (Spain); fi_tunnus = Y-tunnus business ID (Finland); fr_siren = SIREN number (France); fr_siret = SIRET number (France); it_rea = REA register number (Italy); nl_kvk = KvK number (Netherlands); no_org_number = organization number (Norway); no_pno = personal number (Norway); se_org_number = organization number (Sweden); se_pno = personal number (Sweden); uk_crn = Companies House number (UK).
company_details_vat	text	[en] VAT ID number.
expires_after_seconds	int	[en] The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
funding_type	text	[en] The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible values: bank_transfer = bank transfer.
mandate_options_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount to be charged for future payments, specified in the presentment currency.
mandate_options_amount_includes_iof	text	[en] Determines if the amount includes the IOF tax. Possible values: always = amount always includes IOF; never = amount never includes IOF.
mandate_options_amount_type	text	[en] One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param. Possible values: fixed = exact amount to charge; maximum = maximum amount to charge.
mandate_options_description	text	[en] A description of the mandate or subscription that is meant to be displayed to the customer.
mandate_options_end_date	text	[en] Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
mandate_options_expires_at	timestamp	[en] Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite. Date and time in UTC.
mandate_options_payment_schedule	text	[en] Schedule at which the future payments will be charged. Possible values: halfyearly = half-yearly; monthly = monthly; quarterly = quarterly; weekly = weekly; yearly = yearly.
mandate_options_purpose	text	[en] The purpose for which payments are made. Has a default value based on your merchant category code. Possible values: dependant_support = dependant support; government = government payment; loan = loan; mortgage = mortgage; other = other purpose; pension = pension; personal = personal payment; retail = retail purchase; salary = salary; tax = tax payment; utility = utility bills.
mandate_options_transaction_type	text	[en] Transaction type of the mandate. Possible values: business = business transaction; personal = personal transaction.
network	text	[en] Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. Possible values: amex; cartes_bancaires; diners; discover; eftpos_au; girocard; interac; jcb; link; mastercard; unionpay; unknown; visa.
preferred_language	text	[en] Preferred language of the Bancontact authorization page that the customer is redirected to. Possible values: de = German; en = English; fr = French; nl = Dutch.
request_three_d_secure	text	[en] We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Possible values: any = request 3D Secure whenever possible; automatic = Stripe decides when 3D Secure is required; challenge = force a 3D Secure challenge.
verification_method	text	[en] Bank account verification method. The default value is automatic. Possible values: automatic = automatic (instant or microdeposits); instant = instant verification; microdeposits = microdeposit verification.

stripe_subscriptions_pay_pay_fin_fil_account_subcategori

Subscriptions: payment_settings.payment_method_options.financial_connections.filters.account_subcategories (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscriptions_payment_sett_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible values: checking = checking account; savings = savings account.

stripe_subscriptions_payment_setting_pay_fin_permissions

Subscriptions: payment_settings.payment_method_options.financial_connections.permissions (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscriptions_payment_sett_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The list of permissions to request. The payment_method permission must be included. Possible values: balances = account balances; ownership = account ownership; payment_method = use as payment method; transactions = account transactions.

stripe_subscriptions_payment_settings_pay_finan_prefetch

Subscriptions: payment_settings.payment_method_options.financial_connections.prefetch (one row per item; joins stripe_subscriptions by column subscription_id).

Field	Type
subscription_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions). Subscriptions > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscriptions_payment_sett_payment_method_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] Data features requested to be retrieved upon account creation. Possible values: balances = balances; ownership = ownership; transactions = transactions.

stripe_subscriptions_payment_settin_payment_method_types

Subscriptions: payment_settings.payment_method_types (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The list of payment method types to provide to every invoice created by the subscription. Possible values: ach_credit_transfer = ACH credit transfer (US); ach_debit = ACH debit (US); acss_debit = ACSS pre-authorized debit (Canada); affirm = Affirm (buy now pay later, US); alipay = Alipay (digital wallet, China); amazon_pay = Amazon Pay (digital wallet); au_becs_debit = BECS Direct Debit (Australia); bacs_debit = Bacs Direct Debit (UK); bancontact = Bancontact (Belgium); billie = Billie (B2B pay later); blik = BLIK (mobile payment, Poland); boleto = boleto bank slip (Brazil); card = card (online); cashapp = Cash App Pay (US); crypto = crypto (stablecoin); custom = custom payment method; customer_balance = customer cash balance (bank transfer); eps = EPS (bank transfer, Austria); fpx = FPX (bank transfer, Malaysia); giropay = giropay (bank transfer, Germany); grabpay = GrabPay (digital wallet, Southeast Asia); ideal = iDEAL (bank transfer, Netherlands); jp_credit_transfer = credit transfer (Japan); kakao_pay = Kakao Pay (digital wallet, Korea); klarna = Klarna (payment method); konbini = Konbini (convenience store, Japan); kr_card = Korean card; link = Link (Stripe saved checkout); mb_way = MB WAY (mobile payment, Portugal); multibanco = Multibanco (bank reference, Portugal); naver_pay = Naver Pay (digital wallet, Korea); nz_bank_account = bank account debit (New Zealand); p24 = Przelewy24 (bank transfer, Poland); pay_by_bank = pay by bank (open banking); payco = PAYCO (digital wallet, Korea); paynow = PayNow (QR code, Singapore); paypal = PayPal (digital wallet); payto = PayTo (account debit, Australia); pix = Pix (instant payment, Brazil); promptpay = PromptPay (QR code, Thailand); revolut_pay = Revolut Pay (digital wallet); satispay = Satispay (mobile payment, Italy); sepa_credit_transfer = SEPA credit transfer; sepa_debit = SEPA Direct Debit (Europe); sofort = Sofort (bank transfer, Europe); swish = Swish (mobile payment, Sweden); twint = TWINT (mobile payment, Switzerland); upi = UPI (instant payment, India); us_bank_account = ACH bank account debit (US); wechat_pay = WeChat Pay (digital wallet, China).

stripe_subscriptions_pending_update_discounts

Subscriptions: pending_update.discounts (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

value

text

[en] The discounts that will be applied to the subscription when the pending update is applied. Use expand[]=discounts to expand each discount.

stripe_subscriptions_pending_update_metadata

Subscriptions: pending_update.metadata (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_subscriptions_pending_update_subscription_items

Subscriptions: pending_update.subscription_items (one row per item; joins stripe_subscriptions by column subscription_id).

Field

Type

subscription_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_subscriptions).

Subscriptions > > id

item_index

int

[en] Position of the item in the list (0 = first), as returned by Stripe.

id

text

[en] List of subscription items, each with an attached plan, that will be set if the update is applied.

Subscriptions - Details - Subscription items

Replication type: Full

Relationships:

subscription_id → Subscriptions > id
subscription → Subscriptions > id
subscription_id > _subscription_items_discounts → Subscriptions > id
subscription_item_id > _subscription_items_discounts → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_metadata → Subscriptions > id
subscription_item_id > _subscription_items_metadata → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_price_currency_options → Subscriptions > id
subscription_item_id > _subscription_items_price_currency_options → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_price_currency_options_tiers → Subscriptions > id
subscription_item_id > _subscription_items_price_currency_options_tiers → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_price_metadata → Subscriptions > id
subscription_item_id > _subscription_items_price_metadata → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_price_tiers → Subscriptions > id
subscription_item_id > _subscription_items_price_tiers → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_tax_rates → Subscriptions > id
subscription_item_id > _subscription_items_tax_rates → Subscriptions - Details - Subscription items > id
subscription_id > _subscription_items_tax_rates_metadata → Subscriptions > id
subscription_item_id > _subscription_items_tax_rates_metadata → Subscriptions - Details - Subscription items > id

Main object

Items of each subscription (price, quantity and current period of each item).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
id	text	[en] Unique identifier for the object.
billed_until	timestamp	[en] The time period the subscription item has been billed for. Date and time in UTC.
billing_thresholds_usage_gte	int	[en] Usage threshold that triggers the subscription to create an invoice…
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
current_period_end	timestamp	[en] The end time of this subscription item's current billing period. Date and time in UTC.
current_period_start	timestamp	[en] The start time of this subscription item's current billing period. Date and time in UTC.
current_trial_end_date	timestamp	[en] End date (UTC) of the current trial of this subscription item. Date and time in UTC.
current_trial_start_date	timestamp	[en] Start date (UTC) of the current trial of this subscription item. Date and time in UTC.
current_trial_trial_offer	text	[en] Identifier of the trial offer applied to the current trial of this subscription item.
price_id	text	[en] Unique identifier for the object.
price_active	boolean	[en] Whether the price can be used for new purchases. Values: true (yes) or false (no).
price_billing_scheme	text	[en] Describes how to compute the price per period. Either per_unit or tiered. Possible values: per_unit = fixed price per unit; tiered = tiered pricing.
price_created	timestamp	[en] Time at which the object was created. Date and time in UTC.
price_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
price_custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
price_custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
price_custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
price_livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
price_lookup_key	text	[en] A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
price_nickname	text	[en] A brief description of the price, hidden from customers.
price_product	text	[en] The ID of the product this price is associated with.
price_recurring_interval	text	[en] The frequency at which a subscription is billed. One of day, week, month or year. Possible values: day = daily; month = monthly; week = weekly; year = yearly.
price_recurring_interval_count	int	[en] The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
price_recurring_meter	text	[en] The meter tracking the usage of a metered price…
price_recurring_usage_type	text	[en] Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed. Possible values: licensed = bills the subscribed quantity; metered = bills by metered usage.
price_tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
price_tiers_mode	text	[en] Defines 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. Possible values: graduated = graduated: each tier priced separately; volume = volume: total quantity sets unit price.
price_transform_quantity_divide_by	int	[en] Divide usage by this number.
price_transform_quantity_round	text	[en] After division, either round the result up or down. Possible values: down = round down; up = round up.
price_type	text	[en] One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: one_time = one-time price; recurring = recurring price (subscription).
price_unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
price_unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
quantity	int	[en] The quantity of the plan to which the customer should be subscribed.
subscription	text	[en] The subscription this subscription_item belongs to. Subscriptions > > id

stripe_subscription_items_discounts

Subscriptions - Details - Subscription items: discounts (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
value	text	[en] The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

stripe_subscription_items_metadata

Subscriptions - Details - Subscription items: metadata (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_subscription_items_price_currency_options

Subscriptions - Details - Subscription items: price.currency_options (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
custom_unit_amount_maximum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The maximum unit amount the customer can specify for this item.
custom_unit_amount_minimum	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
custom_unit_amount_preset	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The starting unit amount which can be updated by the customer.
tax_behavior	text	[en] Only required if a default tax behavior) 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. Possible values: exclusive = tax added on top of price; inclusive = tax included in price; unspecified = tax behavior not specified.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged. Only set if billing_scheme=per_unit.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The unit amount to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

stripe_subscription_items_price_currency_options_tiers

Subscriptions - Details - Subscription items: price.currency_options.tiers (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_items_price_currency_options, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_subscription_items_price_metadata

Subscriptions - Details - Subscription items: price.metadata (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

stripe_subscription_items_price_tiers

Subscriptions - Details - Subscription items: price.tiers (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
flat_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Price for the entire tier.
flat_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as flat_amount, but contains a decimal value with at most 12 decimal places.
unit_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Per unit price for units relevant to the tier.
unit_amount_decimal	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Same as unit_amount, but contains a decimal value with at most 12 decimal places.
up_to	int	[en] Up to and including to this quantity will be contained in the tier.

stripe_subscription_items_tax_rates

Subscriptions - Details - Subscription items: tax_rates (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_subscription_items_tax_rates_metadata

Subscriptions - Details - Subscription items: tax_rates.metadata (one row per item; joins stripe_subscription_items by column subscription_item_id).

Field	Type
subscription_id	text	[en] Identifier of the parent record (id column of table stripe_subscriptions). Subscriptions > > id
subscription_item_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_subscription_items). Subscriptions - Details - Subscription items > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_subscription_items_tax_rates, joined by dots when nested deeper (e.g. 2, usd, 0.3).
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Tax rates

Replication type: Full

Relationships:

tax_rate_id > _tax_rates_metadata → Tax rates > id

Main object

Tax rates set up for invoices and subscriptions.

Field	Type
id	text	[en] Unique identifier for the object.
active	boolean	[en] Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. Values: true (yes) or false (no).
country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
description	text	[en] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name	text	[en] The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effective_percentage	float	[en] Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
flat_amount_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the tax when the rate_type is flat_amount.
flat_amount_currency	text	[en] Three-letter ISO currency code, in lowercase.
inclusive	boolean	[en] This specifies if the tax rate is inclusive or exclusive. Values: true (yes) or false (no).
jurisdiction	text	[en] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
jurisdiction_level	text	[en] The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible values: city = city; country = country; county = county; district = district; multiple = multiple jurisdictions; state = state.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
percentage	float	[en] Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
rate_type	text	[en] Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible values: flat_amount = flat tax amount; percentage = percentage tax rate.
state	text	[en] ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type	text	[en] The high-level tax type, such as vat or sales_tax. Possible values: amusement_tax = amusement tax; communications_tax = communications tax; digital_excise_tax = digital excise tax; gst = goods and services tax (GST); hst = harmonized sales tax (HST, Canada); igst = integrated GST (IGST, India); jct = Japanese consumption tax (JCT); lease_tax = lease tax; mass_transit_parking_tax = mass transit parking tax; parking_tax = parking tax; pst = provincial sales tax (PST, Canada); qst = Quebec sales tax (QST); retail_delivery_fee = retail delivery fee; rst = retail sales tax (RST); sales_tax = sales tax; service_tax = service tax; utility_users_tax = utility users tax; vat = value-added tax (VAT).

stripe_tax_rates_metadata

Tax rates: metadata (one row per item; joins stripe_tax_rates by column tax_rate_id).

Field

Type

tax_rate_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_tax_rates).

Tax rates > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Terminal locations

Replication type: Full

Relationships:

location_id > _terminal_locations_metadata → Terminal locations > id

Main object

Physical locations set up for Stripe Terminal readers.

Field	Type
id	text	[en] Unique identifier for the object.
address_city	text	[en] City, district, suburb, town, or village.
address_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
address_line1	text	[en] Address line 1, such as the street, PO Box, or company name.
address_line2	text	[en] Address line 2, such as the apartment, suite, unit, or building.
address_postal_code	text	[en] ZIP or postal code.
address_state	text	[en] State, county, province, or region (ISO 3166-2).
address_kana_city	text	[en] City/Ward.
address_kana_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
address_kana_line1	text	[en] Block/Building number.
address_kana_line2	text	[en] Building details.
address_kana_postal_code	text	[en] ZIP or postal code.
address_kana_state	text	[en] Prefecture.
address_kana_town	text	[en] Town/cho-me.
address_kanji_city	text	[en] City/Ward.
address_kanji_country	text	[en] Two-letter country code (ISO 3166-1 alpha-2).
address_kanji_line1	text	[en] Block/Building number.
address_kanji_line2	text	[en] Building details.
address_kanji_postal_code	text	[en] ZIP or postal code.
address_kanji_state	text	[en] Prefecture.
address_kanji_town	text	[en] Town/cho-me.
configuration_overrides	text	[en] The ID of a configuration that will be used to customize all readers in this location.
display_name	text	[en] The display name of the location.
display_name_kana	text	[en] The Kana variation of the display name of the location.
display_name_kanji	text	[en] The Kanji variation of the display name of the location.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
phone	text	[en] The phone number of the location.

stripe_terminal_locations_metadata

Terminal locations: metadata (one row per item; joins stripe_terminal_locations by column location_id).

Field

Type

location_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_terminal_locations).

Terminal locations > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Terminal readers

Replication type: Full

Relationships:

reader_id > _terminal_readers_action_collect_inputs_inputs → Terminal readers > id
reader_id > _terminal_readers_action_col_inputs_select_choices → Terminal readers > id
reader_id > _terminal_readers_action_collect_in_inputs_toggles → Terminal readers > id
reader_id > _terminal_readers_action_collect_inputs_metadata → Terminal readers > id
reader_id > _terminal_readers_action_refund_payment_metadata → Terminal readers > id
reader_id > _terminal_readers_action_set_reade_cart_line_items → Terminal readers > id
reader_id > _terminal_readers_metadata → Terminal readers > id

Main object

Stripe Terminal card readers, with status and location.

Field	Type
id	text	[en] Unique identifier for the object.
action_api_error_advice_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
action_api_error_charge	text	[en] For card errors, the ID of the failed charge.
action_api_error_code	text	[en] For some errors that could be handled programmatically, a short string indicating the error code reported.
action_api_error_decline_code	text	[en] For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
action_api_error_doc_url	text	[en] A URL to more information about the error code reported.
action_api_error_message	text	[en] A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
action_api_error_network_advice_code	text	[en] For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
action_api_error_network_decline_code	text	[en] For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
action_api_error_param	text	[en] If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
action_api_error_payment_intent_id	text	[en] A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system.
action_api_error_payment_method_id	text	[en] PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.
action_api_error_payment_method_type	text	[en] If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
action_api_error_request_log_url	text	[en] A URL to the request log entry in your dashboard.
action_api_error_setup_intent_id	text	[en] A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
action_api_error_source_id	text	[en] The source object for errors returned on a request involving a source.
action_api_error_type	text	[en] The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error… Possible values: api_error = Stripe API internal error; card_error = card error (e.g. decline); idempotency_error = idempotency key error; invalid_request_error = invalid request.
action_collect_p_collect_config_enable_customer_cancellation	boolean	[en] Enable customer-initiated cancellation when processing this payment. Values: true (yes) or false (no).
action_collect_payment_method_collect_config_skip_tipping	boolean	[en] Override showing a tipping selection screen on this transaction. Values: true (yes) or false (no).
action_collect_paymen_collect_config_tipping_amount_eligible	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer.
action_collect_payment_method_payment_intent	text	[en] Most recent PaymentIntent processed by the reader.
action_collect_payment_method_payment_method_id	text	[en] PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: Payment Methods and More Payment Scenarios.
action_confirm_payment_intent_confirm_config_return_url	text	[en] If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
action_confirm_payment_intent_payment_intent	text	[en] Most recent PaymentIntent processed by the reader.
action_failure_code	text	[en] Failure code, only set if status is failed.
action_failure_message	text	[en] Detailed failure message, only set if status is failed.
action_print_content_image_created_at	timestamp	[en] Creation time of the object. Date and time in UTC.
action_print_content_image_filename	text	[en] The original name of the uploaded file (e.g. receipt.png).
action_print_content_image_size	int	[en] The size (in bytes) of the uploaded file.
action_print_content_image_type	text	[en] The format of the uploaded file.
action_print_content_type	text	[en] The type of content to print. Currently supports image. Possible values: image = image.
action_process_payment_intent_payment_intent	text	[en] Most recent PaymentIntent processed by the reader.
action_process_p_process_config_enable_customer_cancellation	boolean	[en] Enable customer-initiated cancellation when processing this payment. Values: true (yes) or false (no).
action_process_payment_intent_process_config_return_url	text	[en] If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion.
action_process_payment_intent_process_config_skip_tipping	boolean	[en] Override showing a tipping selection screen on this transaction. Values: true (yes) or false (no).
action_process_paymen_process_config_tipping_amount_eligible	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer.
action_process_setup_intent_generated_card	text	[en] ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
action_process_s_process_config_enable_customer_cancellation	boolean	[en] Enable customer-initiated cancellation when processing this SetupIntent. Values: true (yes) or false (no).
action_process_setup_intent_setup_intent	text	[en] Most recent SetupIntent processed by the reader.
action_refund_payment_amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount being refunded.
action_refund_payment_charge	text	[en] Charge that is being refunded.
action_refund_payment_payment_intent	text	[en] Payment intent that is being refunded.
action_refund_payment_reason	text	[en] The reason for the refund. Possible values: duplicate = duplicate charge; fraudulent = fraudulent; requested_by_customer = requested by customer.
action_refund_payment_refund	text	[en] Unique identifier for the refund object.
action_refund_payment_refund_application_fee	boolean	[en] Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. Values: true (yes) or false (no).
action_refund_payment_refund_pa_enable_customer_cancellation	boolean	[en] Enable customer-initiated cancellation when refunding this payment. Values: true (yes) or false (no).
action_refund_payment_reverse_transfer	boolean	[en] Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. Values: true (yes) or false (no).
action_set_reader_display_cart_currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
action_set_reader_display_cart_tax	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Tax amount for the entire cart.
action_set_reader_display_cart_total	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Total amount for the entire cart, including tax.
action_set_reader_display_type	text	[en] Type of information to be displayed by the reader. Only cart is currently supported. Possible values: cart = shopping cart.
action_status	text	[en] Status of the action performed by the reader. Possible values: failed = failed; in_progress = in progress; succeeded = succeeded.
action_type	text	[en] Type of action performed by the reader. Possible values: collect_inputs = collect inputs on reader; collect_payment_method = collect payment method; confirm_payment_intent = confirm PaymentIntent; print_content = print content; process_payment_intent = process PaymentIntent; process_setup_intent = process SetupIntent; refund_payment = refund payment; set_reader_display = set reader display.
device_sw_version	text	[en] The current software version of the reader.
device_type	text	[en] Device type of the reader. Possible values: bbpos_chipper2x; bbpos_wisepad3; bbpos_wisepos_e; mobile_phone_reader; simulated_stripe_s700; simulated_stripe_s710; simulated_verifone_m425; simulated_verifone_p630; simulated_verifone_ux700; simulated_verifone_v660p; simulated_wisepos_e; stripe_m2; stripe_s700; stripe_s710; verifone_P400; verifone_m425; verifone_p630; verifone_ux700; verifone_v660p.
ip_address	text	[en] The local IP address of the reader.
label	text	[en] Custom label given to the reader for easier identification.
last_seen_at	timestamp	[en] The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds. Date and time in UTC.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
location	text	[en] The location identifier of the reader.
serial_number	text	[en] Serial number of the reader.
status	text	[en] The networking status of the reader. This value is null for mobile readers. We do not recommend using this field in flows that may block taking payments. Possible values: offline = reader offline; online = reader online.

stripe_terminal_readers_action_collect_inputs_inputs

Terminal readers: action.collect_inputs.inputs (one row per item; joins stripe_terminal_readers by column reader_id).

Field	Type
reader_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers). Terminal readers > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
custom_text_description	text	[en] Customize the default description for this input…
custom_text_skip_button	text	[en] Customize the default label for this input's skip button…
custom_text_submit_button	text	[en] Customize the default label for this input's submit button…
custom_text_title	text	[en] Customize the default title for this input…
email_value	text	[en] The collected email address…
numeric_value	text	[en] The collected number…
phone_value	text	[en] The collected phone number…
required	boolean	[en] Indicate that this input is required, disabling the skip button. Values: true (yes) or false (no).
selection_id	text	[en] The id of the selected choice…
selection_text	text	[en] The text of the selected choice…
signature_value	text	[en] The File ID of a collected signature image…
skipped	boolean	[en] Indicate that this input was skipped by the user. Values: true (yes) or false (no).
text_value	text	[en] The collected text value…
type	text	[en] Type of input being collected. Possible values: email = collect email; numeric = numeric field; phone = collect phone number; selection = collect option selection; signature = collect signature; text = text field.

stripe_terminal_readers_action_col_inputs_select_choices

Terminal readers: action.collect_inputs.inputs.selection.choices (one row per item; joins stripe_terminal_readers by column reader_id).

Field	Type
reader_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers). Terminal readers > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_terminal_readers_action_collect_inputs_inputs, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
id	text	[en] The identifier for the selected choice. Maximum 50 characters.
style	text	[en] The button style for the choice. Can be primary or secondary. Possible values: primary = primary button; secondary = secondary button.
text	text	[en] The text to be selected. Maximum 30 characters.

stripe_terminal_readers_action_collect_in_inputs_toggles

Terminal readers: action.collect_inputs.inputs.toggles (one row per item; joins stripe_terminal_readers by column reader_id).

Field	Type
reader_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers). Terminal readers > > id
parent_item	text	[en] Position (or key) of this row's parent item in table stripe_terminal_readers_action_collect_inputs_inputs, joined by dots when nested deeper (e.g. 2, usd, 0.3).
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
default_value	text	[en] The toggle's default value. Can be enabled or disabled. Possible values: disabled = disabled by default; enabled = enabled by default.
description	text	[en] The toggle's description text. Maximum 50 characters.
title	text	[en] The toggle's title text. Maximum 50 characters.
value	text	[en] The toggle's collected value. Can be enabled or disabled. Possible values: disabled = disabled; enabled = enabled.

stripe_terminal_readers_action_collect_inputs_metadata

Terminal readers: action.collect_inputs.metadata (one row per item; joins stripe_terminal_readers by column reader_id).

Field

Type

reader_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers).

Terminal readers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_terminal_readers_action_refund_payment_metadata

Terminal readers: action.refund_payment.metadata (one row per item; joins stripe_terminal_readers by column reader_id).

Field

Type

reader_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers).

Terminal readers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_terminal_readers_action_set_reade_cart_line_items

Terminal readers: action.set_reader_display.cart.line_items (one row per item; joins stripe_terminal_readers by column reader_id).

Field	Type
reader_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers). Terminal readers > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. The amount of the line item.
description	text	[en] Description of the line item.
quantity	int	[en] The quantity of the line item.

stripe_terminal_readers_metadata

Terminal readers: metadata (one row per item; joins stripe_terminal_readers by column reader_id).

Field

Type

reader_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_terminal_readers).

Terminal readers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Top-ups

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
topup_id > _topups_metadata → Top-ups > id
topup_id > _topups_payment_method_options → Top-ups > id

Main object

Balance top-ups funded from the bank account.

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount transferred.
balance_transaction	text	[en] ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. Balance transactions > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
expected_availability_date	timestamp	[en] Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. Date and time in UTC.
failure_code	text	[en] Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
failure_message	text	[en] Message to user further explaining reason for top-up failure if available.
initiated_by	text	[en] Indicates whether the top-up was initiated by Stripe or by the user. Possible values: stripe = initiated by Stripe; user = initiated by the user.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
payment_method	text	[en] The ID of a PaymentMethod representing the payment method used for the top-up. A PaymentMethod of type us_bank_account can be used.
source_id	text	[en] The source field is deprecated. It might not always be present in the API response.
statement_descriptor	text	[en] Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
status	text	[en] The status of the top-up is either canceled, failed, pending, reversed, or succeeded. Possible values: canceled = canceled; failed = failed; pending = pending; reversed = reversed; succeeded = succeeded.
transfer_group	text	[en] A string that identifies this top-up as part of a group.

stripe_topups_metadata

Top-ups: metadata (one row per item; joins stripe_topups by column topup_id).

Field

Type

topup_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_topups).

Top-ups > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

stripe_topups_payment_method_options

Top-ups: payment_method_options (one row per item; joins stripe_topups by column topup_id).

Field

Type

topup_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_topups).

Top-ups > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

network

text

[en] The US bank transfer network used for this top-up. The default is ach. Possible values: ach.

Transfers

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

balance_transaction → Balance transactions > id
transfer_id > _transfers_metadata → Transfers > id

Main object

Transfers from the balance to connected accounts (Stripe Connect).

Field	Type
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount to be transferred.
amount_reversed	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
balance_transaction	text	[en] Balance transaction that describes the impact of this transfer on your account balance. Balance transactions > > id
created	timestamp	[en] Time that this record of the transfer was first created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
destination	text	[en] ID of the Stripe account the transfer was sent to.
destination_payment	text	[en] If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
livemode	boolean	[en] If the object exists in live mode, the value is true. If the object exists in test mode, the value is false. true = live mode (production) record, false = test mode record.
reversed	boolean	[en] Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. Values: true (yes) or false (no).
source_transaction	text	[en] ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
source_type	text	[en] The source balance this transfer came from. One of card, fpx, or bank_account.
transfer_group	text	[en] A string that identifies this transaction as part of a group.

stripe_transfers_metadata

Transfers: metadata (one row per item; joins stripe_transfers by column transfer_id).

Field

Type

transfer_id

text

[en] Identifier of the record this row belongs to (id column of table stripe_transfers).

Transfers > > id

key

text

[en] Key of the item in the record (metadata name, currency or payment method type).

value

text

[en] 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.

Transfers - Details - Reversals

Replication type: Full

Relationships:

transfer_id → Transfers > id
balance_transaction → Balance transactions > id
transfer → Transfers > id
transfer_id > _transfer_reversals_metadata → Transfers > id
transfer_reversal_id > _transfer_reversals_metadata → Transfers - Details - Reversals > id

Main object

Reversals of each transfer to a connected account.

Field	Type
transfer_id	text	[en] Identifier of the parent record (id column of table stripe_transfers). Transfers > > id
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount.
balance_transaction	text	[en] Balance transaction that describes the impact on your account balance. Balance transactions > > id
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
destination_payment_refund	text	[en] Linked payment refund for the transfer reversal.
source_refund	text	[en] ID of the refund responsible for the transfer reversal.
transfer	text	[en] ID of the transfer that was reversed. Transfers > > id

stripe_transfer_reversals_metadata

Transfers - Details - Reversals: metadata (one row per item; joins stripe_transfer_reversals by column transfer_reversal_id).

Field	Type
transfer_id	text	[en] Identifier of the parent record (id column of table stripe_transfers). Transfers > > id
transfer_reversal_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_transfer_reversals). Transfers - Details - Reversals > > id
key	text	[en] Key of the item in the record (metadata name, currency or payment method type).
value	text	[en] 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.

Payouts - Details - Payout transactions

Replication type: Incremental with update window or Full (user configurable)

Parameters:

Update window (days): In Incremental mode, records created in the last N days are re-read on every run (Stripe filters by creation date). Changes to records older than the window are only picked up in Full (Integral) mode
Read start date: Records created from this date on are read on the first run (Incremental mode)

Relationships:

payout_id → Payouts > id
payout_id > _payout_balance_transactions_fee_details → Payouts > id
balance_transaction_id > _payout_balance_transactions_fee_details → Payouts - Details - Payout transactions > id

Main object

Composition of each payout: the sales, fees, refunds and adjustments whose money went to the bank account in that payout, one row per balance transaction, in the balance currency (e.g. BRL). The sum of net over the rows (excluding the type = payout row itself) is the payout amount. Only automatic payouts have a composition; manual payouts are left out.

Field	Type
payout_id	text	[en] Identifier of the parent record (id column of table stripe_payouts). Payouts > > id
id	text	[en] Unique identifier for the object.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Gross amount of this transaction. A positive value represents funds charged to another party, and a negative value represents funds sent to another party. Gross, in your Stripe balance currency (e.g. BRL). Positive = entered the balance; negative = left it (payouts and refunds are negative here).
available_on	timestamp	[en] The date that the transaction's net funds become available in the Stripe balance. Date the money becomes available for payout (the date is what matters; the time is 00:00 UTC).
balance_type	text	[en] The balance that this transaction impacts. Possible values: issuing = Issuing balance; payments = payments balance; refund_and_dispute_prefunding = prefunded balance for refunds and disputes; risk_reserved = balance held in risk reserve.
created	timestamp	[en] Time at which the object was created. Date and time in UTC.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users.
exchange_rate	float	[en] If 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. Exchange rate used: charge amount (customer currency) × exchange_rate = this row's amount (balance currency). Empty when there was no conversion.
fee	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Fees paid for this transaction. Fee charged by Stripe on this transaction (processing + currency conversion, itemized in the fees child table).
net	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Net impact to a Stripe balance. 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… Net = amount − fee: what actually stays in your balance.
reporting_category	text	[en] Accounting category of the transaction, simpler than type: charge = sale; refund; payout; fee; dispute; adjustment.
source	text	[en] This transaction relates to the Stripe object. Id of the record that generated the transaction: charge (ch_...), refund (re_...), payout (po_...), etc.
status	text	[en] The transaction's net funds status in the Stripe balance, which are either available or pending.
type	text	[en] Transaction 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… Possible values: adjustment = balance adjustment; advance = funds advance; advance_funding = advance funding; anticipation_repayment = anticipation repayment; application_fee = Connect platform application fee; application_fee_refund = application fee refund; charge = charge; climate_order_purchase = Climate carbon removal purchase; climate_order_refund = Climate order refund; connect_collection_transfer = Connect collection transfer; contribution = contribution (e.g. Climate); fee_credit_funding = Stripe fee credit funding; inbound_transfer = inbound transfer; inbound_transfer_reversal = inbound transfer reversal; issuing_authorization_hold = Issuing authorization hold; issuing_authorization_release = Issuing authorization release; issuing_dispute = Issuing dispute; issuing_dispute_provisional_credit = Issuing dispute provisional credit; issuing_dispute_provisional_credit_reversal = Issuing provisional credit reversal; issuing_transaction = Issuing card transaction; obligation_outbound = outbound obligation; obligation_reversal_inbound = inbound obligation reversal; payment = payment; payment_failure_refund = failed payment refund; payment_network_reserve_hold = payment network reserve hold; payment_network_reserve_release = payment network reserve release; payment_refund = payment refund; payment_reversal = payment reversal; payment_unreconciled = unreconciled payment; payout = payout to bank account; payout_cancel = payout canceled; payout_failure = payout failed; payout_minimum_balance_hold = payout minimum balance hold; payout_minimum_balance_release = payout minimum balance release; refund = refund; refund_failure = refund failed; reserve_hold = reserve hold; reserve_release = reserve release; reserve_transaction = reserve transaction; reserved_funds = reserved funds; stripe_balance_payment_debit = Stripe balance payment debit; stripe_balance_payment_debit_reversal = Stripe balance payment debit reversal; stripe_fee = Stripe fee; stripe_fx_fee = Stripe currency conversion fee; tax_fee = tax fee (Stripe Tax); tax_fund = tax funds; topup = balance top-up; topup_reversal = top-up reversal; transfer = transfer to connected account; transfer_cancel = transfer canceled; transfer_failure = transfer failed; transfer_refund = transfer reversal. Most common: charge = sale; refund; payout = transfer to the bank; adjustment; stripe_fee = standalone Stripe fee.

stripe_payout_balance_transactions_fee_details

Payouts - Details - Payout transactions: fee_details (one row per item; joins stripe_payout_balance_transactions by column balance_transaction_id).

Field	Type
payout_id	text	[en] Identifier of the parent record (id column of table stripe_payouts). Payouts > > id
balance_transaction_id	text	[en] Identifier of the record this row belongs to (id column of table stripe_payout_balance_transactions). Payouts - Details - Payout transactions > > id
item_index	int	[en] Position of the item in the list (0 = first), as returned by Stripe.
amount	float	[en] Money amount in the currency's main unit, with decimals: 1234.56 = $1,234.56 when the currency is usd. Amount of the fee.
application	text	[en] ID of the Connect application that earned the fee.
currency	text	[en] Three-letter ISO currency code, in lowercase. Must be a supported currency.
description	text	[en] An arbitrary string attached to the object. Often useful for displaying to users. Fee description: "Stripe processing fees" or "Stripe currency conversion fee".
type	text	[en] Type of the fee, one of: application_fee, payment_method_passthrough_fee, stripe_fee, tax, or withheld_tax. Fee type (usually stripe_fee). To tell processing from currency conversion use the description column.

Creating the data source

Which key to use

How to create the restricted key

How to connect

Pipelines

Summary

Relationship chart

Application fees

Balance transactions

Billing credit grants

Billing meters

Charges

Checkout sessions

Checkout sessions - Details - Line items

Connected accounts (Connect)

Coupons

Credit notes

Credit notes - Details - Line items

Current balance

Customers

Customers - Details - Customer balance transactions

Customers - Details - Payment methods

Customers - Details - Tax IDs

Disputes

Early fraud warnings

Entitlement features

Events

Identity verification sessions

Invoice items

Invoice payments

Invoices

Invoices - Details - Invoice line items

Payment intents

Payment links

Payment links - Details - Line items

Payouts

Plans

Prices

Products

Promotion codes

Quotes

Quotes - Details - Line items

Radar reviews

Radar value lists

Radar value lists - Details - Items

Refunds

Setup intents

Shipping rates

Subscription schedules

Subscriptions

Subscriptions - Details - Subscription items

Tax rates

Terminal locations

Terminal readers

Top-ups

Transfers

Transfers - Details - Reversals

Payouts - Details - Payout transactions

Notes