Stripe Source


Good to know: Object Cloud source

The Stripe Source is an object source. This means that it sends information (traits) about a thing that exists and persists over time, such as a person or company, and which can be updated over time. Data from this source can only be exported directly to a warehouse, but it can then be used for further analysis. Learn more about cloud sources.

Stripe builds economic infrastructure for the internet, that enables businesses of every size to accept payments and manage their businesses online.

Getting Started

  1. In Segment go to Connections and click Add Source.
  2. Choose Stripe.
  3. Give the Source a nickname and click Add Source. The nickname is used to designate the source in the Segment interface, and Segment creates a related schema name. The schema name is the namespace you query against in your warehouse. The nickname can be whatever you like, but Segment recommends using a name that reflects the source itself and distinguishes amongst your environments.
  4. Click Connect, and authenticate with Stripe’s OAuth. To use data from Stripe’s test mode, contact Segment Support with your test Secret Key. Segment’s support team can then configure your source to use test mode data.

Components

Sync

The Stripe source is built with a sync component, which means Segment make requests to the Stripe API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Stripe objects (and their corresponding properties) according to the Collections Table below. The objects are written into a separate schema, corresponding to the source instance’s schema name you designated upon creation (for example, stripe_prod.charges).

Segment’s sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Stripe. For example, if subscription_status goes from active to inactive between syncs, on its next sync that ticket’s status is inactive.

The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan.

Collections

Collections are the groupings of resources that Segment pulls from your source. In your warehouse, each collection gets its own table.

Collection Type Description
accounts object This is an object representing your Stripe account. You can retrieve it to see properties on the account like its current e-mail address or if the account is enabled yet to make live charges. For more information, see Stripe’s API docs
application_fee_refunds object Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account that the fee was originally collected from. For more information, see Stripe’s API docs
application_fees object When you collect a transaction fee on top of a charge made for your user (using Stripe Connect), an application fee object is created in your account. You can list, retrieve, and refund application fees. For more information, see Stripe’s API docs
balance_transaction_fee_details object Balance transaction fee details include a breakdown of fees (in cents) paid for each transaction. For more information, see Stripe’s API docs
balance_transactions object Balance transactions lists the transaction balance history. For more information, see Stripe’s API docs
bank_accounts object Bank accounts are used at Stripe in two ways: as a payment method on Customer objects and as a transfer destination on Account objects for managed accounts. The accepted and required parameters are different for each context. For more information, see Stripe’s API docs
cards object You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient or a managed account in order to transfer to those cards later. For more information, see Stripe’s API docs
charges object To charge a credit or a debit card, you create a charge object. You can retrieve and refund individual charges as well as list all charges. For more information, see Stripe’s API docs
coupons object A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons only apply to invoices; they do not apply to one-off charges. For more information, see Stripe’s API docs
customers object Customer objects allow you to perform recurring charges and track multiple charges that are associated with the same customer. For more information, see Stripe’s API docs
discounts object A discount represents the actual application of a coupon to a particular customer. It contains information about when the discount began and when it will end. For more information, see Stripe’s API docs
disputes object A dispute occurs when a customer questions your charge with their bank or credit card company. When a customer disputes your charge, you’re given the opportunity to respond to the dispute with evidence that shows the charge is legitimate. You can find more information about the dispute process in the disputes FAQ. For more information, see Stripe’s API docs
invoice_items object Sometimes you want to add a charge or credit to a customer but only actually charge the customer’s card at the end of a regular billing cycle. This is useful for combining several charges to minimize per-transaction fees or having Stripe tabulate your usage-based billing totals. For more information, see Stripe’s API docs
invoice_lines object When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items For more information, see Stripe’s API docs
invoices object Invoices are statements of what a customer owes for a particular billing period, including subscriptions, invoice items, and any automatic proration adjustments if necessary. For more information, see Stripe’s API docs
order_shipping_methods object A list of supported shipping methods for a given product.
payment_intents object A PaymentIntent tracks the process of collecting a payment from your customer. A PaymentIntent transitions through multiple statuse throughout its lifetime and ultimately creates at most one successful charge. For more information, see Stripe’s API docs
payment_methods object PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments. For more information, see Stripe’s API docs
plans object A subscription plan contains the pricing information for different products and feature levels on your site. For more information, see Stripe’s API docs
products object A specific good or service you make available for your customers to purchase. For more information, see Stripe’s API docs.
refunds object Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. The fees you were originally charged are also refunded. For more information, see Stripe’s API docs
skus object A specific variant of a product. .
subscription_items object Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships. For more information, see Stripe’s API docs.
subscriptions object Subscriptions allow you to charge a customer’s card on a recurring basis. A subscription ties a customer to a particular plan you’ve created. For more information, see Stripe’s API docs
tax_rates object Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
transfer_reversals object A previously created transfer can be reversed if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the transfer will be refunded. You may not reverse automatic Stripe transfers. For more information, see Stripe’s API docs
transfers object When Stripe sends you money or you initiate a transfer to a bank account, debit card, or connected Stripe account, a transfer object will be created. You can retrieve individual transfers as well as list all transfers. For more information, see Stripe’s API docs

Collection Properties

Below are tables outlining the properties included in the collections listed above.

accounts

Property Name Description
business_logo The publicly visible logo of the business
business_name The publicly visible name of the business
business_url The publicly visible website of the business
charges_enabled Whether the account can create live charges
country The country of the account
debit_negative_balances A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account
default_currency The currency this account has chosen to use as the default
details_submitted Whether account details have been submitted
display_name The display name for this account
email The primary user’s email address
metadata A set of key-value pairs that describe additional information about the object
statement_descriptor The default text that appears on credit card statements when a charge is made directly on the account
support_address_city City/District/Suburb/Town/Village
support_address_country Two-letter ISO code representing the country of the card
support_address_line1 Address line 1 (Street address/PO Box/Company name)
support_address_line2 Address line 2 (Apartment/Suite/Unit/Building)
support_address_postal_code ZIP or postal code
support_address_state State/County/Province/Region
support_email A publicly shareable support email address for the business
support_phone A publicly shareable support phone number for the business
support_url A publicly shareable website
timezone The timezone used in the Stripe Dashboard for this account
transfers_enabled Whether transfers are enabled
product_description Internal description of the product sold or service provided by the business.
type The Stripe account type. Can be standard, express, or custom.

application_fee_refunds

Property Name Description
amount Amount, in cents
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase
fee_id ID of the application fee that was refunded
metadata A set of key-value pairs that describe additional information about the object

application_fees

Property Name Description
account_id ID of the Stripe account this fee was taken from
amount_refunded Amount in pence refunded
amount Amount earned, in pence
application_id ID of the Connect application that earned the fee
available The date on which the transaction’s net funds become available to the balance
balance_transaction_id Balance transaction that describes the impact of this collected application fee on your account balance
charge_id ID of the charge that the application fee was taken from
created Time at which the object was created. Measured in seconds since the Unix epoch.
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase
metadata A set of key-value pairs that describe additional information about the object
metadata A set of key-value pairs that describe additional information about the object
originating_transaction ID of the corresponding charge on the platform account
refunded Whether the fee has been fully refunded
transfer_id A reference to the related transaction, if enabled

balance_transactions

Property Name Description
amount Gross amount of the transaction, in cents
currency Three-letter ISO currency code, in lowercase
description An arbitrary string attached to the object
fee Fees (in cents) paid for this transaction
metadata A set of key-value pairs that describe additional information about the object
net Net amount of the transaction, in cents
source The Stripe object to which this transaction is related
status If the transaction’s net funds are available in the Stripe balance yet
type Transaction type
created Time at which the object was created
available The date the transaction’s net funds will become available in the Stripe balance

balance_transaction_fee_details

Property Name Description
amount Gross amount of the transaction, in pence
application ID of the Stripe Connect application that earned the fee.
balance_transaction_id Unique identifier for the object
currency Three-letter ISO currency code, in lowercase
description An arbitrary string attached to the object
type Transaction type

bank_accounts

Property Name Description
bank_name Name of the bank associated with the routing number
country Two-letter ISO code representing the country the bank account is located in
currency Three-letter ISO code for the currency paid out to the bank account
default_for_currency Currency default
is_deleted Whether the bank account is active or has been deleted
metadata A set of key-value pairs that describe additional information about the object
status Status of account

cards

Property Name Description
address_city City/District/Suburb/Town/Village
address_country Billing address country, if provided when creating card
address_line1_check Check for above
address_line1 Address line 1 (Street address/PO Box/Company name)
address_line2 Address line 2 (Apartment/Suite/Unit/Building)
address_state State/County/Province/Region
address_zip_check Check for above
address_zip ZIP or postal code
brand Card brand
country Two-letter ISO code representing the country of the card
cvc_check If a CVC was provided, results of the check
dynamic_last4 The last four digits of the device account number
exp_month Two-digit number representing the card’s expiration month
exp_year Four-digit number representing the card’s expiration year
fingerprint Uniquely identifies this particular card number.
funding Card funding type
last4 The last four digits of the card
metadata A set of key-value pairs that describe additional information about the object
name Cardholder name
tokenization_method If the card number is tokenized, this is the method that was used

charges

Property Name Description
amount_refunded Amount in cents refunded
amount A positive integer in the smallest currency unit representing how much to charge
application_fee The application fee (if any) for the charge
balance_transaction_id ID of the balance transaction that describes the impact of this charge on your account balance
captured If the charge was created without capturing
currency Three-letter ISO currency code, in lowercase
customer_id ID of the customer this charge is for if one exists
description An arbitrary string attached to the object
destination The account (if any) the charge was made on behalf of, with an automatic transfer
failure_code Error code explaining reason for charge failure if available
failure_message Message to user further explaining reason for charge failure if available
fraud_details_stripe_report Assessment from Stripe that describes if a charge is fraudulent
fraud_details_user_report Assessment from a user that describes if a charge is safe or fraudulent
invoice_id ID of the invoice this charge is for if one exists
metadata A set of key-value pairs that describe additional information about the object
paid true if the charge succeeded, or was successfully authorized for later capture
payment_intent_id ID of the PaymentIntent associated with this charge, if one exists.
payment_method_id ID of the payment method used in this charge.
receipt_email This is the email address that the receipt for this charge was sent to
receipt_number This is the transaction number that appears on email receipts sent for this charge
refunded Whether the charge has been fully refunded
shipping_address_city City/District/Suburb/Town/Village
shipping_address_country Two-letter ISO code representing the country of the charge
shipping_address_line1 Address line 1 (Street address/PO Box/Company name)
shipping_address_line2 Address line 2 (Apartment/Suite/Unit/Building)
shipping_address_postal_code ZIP or postal code
shipping_address_state State/County/Province/Region
shipping_carrier The delivery service that shipped the charged order
shipping_name The recipient’s name
shipping_phone The recipient’s phone number, including extension
shipping_tracking_number The tracking number obtained from the specified carrier
statement_descriptor Extra information about a charge. This will appear on your customer’s credit card statement
status The status of the payment

coupons

Property Name Description
amount_off Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer
currency The three-letter ISO code for the currency of the amount to take off
duration_in_months If duration is repeating, the number of months the coupon applies
duration Describes how long a customer who applies this coupon will get the discount
max_redemptions Maximum number of times this coupon can be redeemed, in total, before it is no longer valid
metadata A set of key-value pairs that describe additional information about the object
percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon
percent_off_precise Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon, in decimal form
times_redeemed Number of times this coupon has been applied to a customer
valid Taking account of the above properties, whether this coupon can still be applied to a customer

customers

Property Name Description
balance Current balance, if any, being stored on the customer’s account
currency Three-letter ISO code for the currency the customer can be charged in for recurring billing purpose
default_source ID of the default payment source for the customer.
delinquent When the customer’s latest invoice is billed by charging automatically, delinquent is true if the invoice’s latest charge is failed
description An arbitrary string attached to the object
email The customer’s email address
metadata A set of key-value pairs that describe additional information about the object

discounts

Property Name Description
coupon_id The ID of the discount
customer_id ID of the customer
end The end date of the discount, unless the discount is applied either once or forever
start The date the discount was applied
subscription The subscription that this coupon is applied to, if it is applied to a particular subscription

disputes

Segment flattens Stripe’s Evidence and Evidence Details objects. See Stripe’s Dispute documentation for more detail.

Property Name Description
amount Disputed amount. Usually the amount of the charge
charge_id ID of the charge that was disputed
currency Three-letter ISO currency code, in lowercase
created Time at which the object was created. Measured in seconds since the Unix epoch.
evidence_ The evidence provided as part of a dispute, as described in Stripe’s documentation. For example, evidence_access_activity_log.
evidence_details_ The evidence details of a dispute, as described in Stripe’s documentation. For example, evidence_details_due_by.
is_charge_refundable If true, it is still possible to refund the disputed payment
metadata A set of key-value pairs that describe additional information about the object
reason Reason given by cardholder for dispute
status Current status of dispute

invoice_items

Property Name Description
amount Amount (in the currency specified) of the invoice item
currency Three-letter ISO currency code, in lowercase
customer_id The ID of the customer who will be billed when this invoice item is billed
date Time at which the object was created. Measured in seconds since the Unix epoch.
description An arbitrary string attached to the object
discountable If true, discounts will apply to this invoice item. Always false for prorations
invoice_id The ID of the invoice this invoice item belongs to
metadata A set of key-value pairs that describe additional information about the object
period_start The start of the period
period_end The end of the period, which must be greater than or equal to the start.
proration Whether the invoice item was created automatically as a proration adjustment when the customer switched plans
quantity Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for
subscription_id The subscription that this invoice item has been created for, if any

invoices

Property Name Description
amount_due Final amount due at this time for this invoice
application_fee The fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account when the invoice is paid
attempt_count Number of payment attempts made for this invoice, from the perspective of the payment retry schedule
attempted Whether an attempt has been made to pay the invoice
billing_reason The reason for the invoice.
charge_id ID of the latest charge generated for this invoice, if any
currency Three-letter ISO currency code, in lowercase
customer_id ID of the customer
description An arbitrary string attached to the object
due_date The invoice’s due date.
ending_balance Ending customer balance after the invoice is frozen
metadata A set of key-value pairs that describe additional information about the object
paid Whether payment was successfully collected for this invoice
period_end End of the usage period during which invoice items were added to the invoice
period_start Start of the usage period during which invoice items were added to the invoice
receipt_number This is the transaction number that appears on email receipts sent for this invoice
starting_balance Starting customer balance before the invoice is frozen
statement_descriptor Extra information about an invoice for the customer’s credit card statement
subscription_id The subscription that this invoice was prepared for, if any
subtotal Total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied
tax The amount of tax included in the total, calculated from tax_percent and the subtotal. If no tax_percent is defined, this value will be null
total Total after discount
auto_advance Controls whether Stripe will perform automatic collection of the invoice.
status The status of the invoice
created Time at which the object was created. Measured in seconds since the Unix epoch.

invoice_lines

Property Name Description
amount The amount, in cents
currency Three-letter ISO currency code
description An arbitrary string attached to the object
discountable If true, discounts will apply to this line item. Always false for prorations
invoice_id The ID of the invoice to which this line belongs
item_id If id is prefixed with ii_ then this is the line item’s UUID, if any
period_end End of the line item’s billing period
period_start Start of the line item’s billing period
plan_id The id of the Plan that this invoice_line belongs to
proration If true, this line item is a proration
quantity The quantity of the subscription, if the line item is a subscription or a proration
subscription_id If id is prefixed with sub_ then this is the line item’s UUID, else it is the ID of The subscription that the invoice item pertains to, if any.
tax_rates An array of tax rate IDs.
type A string identifying the type of the source of this line item, either an InvoiceItem or a Subscription

order_shipping_methods

Segment flattens Stripe’s Delivery Estimate object.

Property Name Description
amount The total amount of the line item, represented in the smallest currency unit
currency Three-letter ISO currency code, in lowercase.
delivery_estimate_ The estimated delivery date for a given shipping method. For example, delivery_estimate_date.
description An arbitrary string attached to the object
order_id The identifier of the order associated with the shipping method
shipping_id A unique identifier for a given shipping method

payment_intents

Property Name Description
amount_capturable Amount that can be captured from this PaymentIntent.
amount_received Amount that was collected by this PaymentIntent.
amount Amount intended to be collected by this PaymentIntent.
application_fee_amount The amount of the application fee (if any) for the resulting payment.
application_id ID of the Connect application that created the PaymentIntent.
canceled_at Time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
cancellation_reason 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, or automatic).
capture_method One of automatic (default) or manual. For more info refer Stripe API docs
confirmation_method One of automatic (default) or manual. For more info refer Stripe API docs
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase.
customer_id ID of the Customer this PaymentIntent is for, if one exists.
description An arbitrary string attached to the object. Often useful for displaying to users.
invoice_id ID of the invoice that created this PaymentIntent, if it exists.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata A set of key-value pairs that describe additional information about the object
on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended.
payment_method_id ID of the payment method used in this PaymentIntent.
receipt_email Email address that the receipt for the resulting payment will be sent to.
review_id ID of the review associated with this PaymentIntent, if any.
statement_descriptor Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.
status Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
transfer_data_amount The amount intended to be collected
transfer_data_destination The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.
transfer_data_destination The account the payment is attributed to for tax reporting
transfer_group A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

payment_methods

Property Name Description
billing_details_address_city City tied to the PaymentMethod’s billing details
billing_details_address_country 2-letter country code tied to the PaymentMethod’s billing details
billing_details_address_line1 Address line 1 tied to the PaymentMethod’s billing details
billing_details_address_line2 Address line 2 tied to the PaymentMethod’s billing details
billing_details_address_postal_code ZIP or Postal code tied to the PaymentMethod’s billing details
billing_details_address_state State/Country/Province/Region tied to the PaymentMethod’s billing details
billing_details_email Email address tied to the PaymentMethod’s billing details
billing_details_name Name tied to the PaymentMethod’s billing details
billing_details_phone Phone number tied to the PaymentMethod’s billing details
card_networks_available All available networks for the card
created Time at which the object was created. Measured in seconds since the Unix epoch.
customer_id 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.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata A set of key-value pairs that describe additional information about the object
type The type of the PaymentMethod. An additional object is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
custom object The additional details of the PaymentMethod as specified by the type property. (Note this is a Dynamic Object, and may have multiple properties prefixed with the same key)

plans

Property Name Description
amount The amount in cents to be charged on the interval specified
currency Three-letter ISO currency code, in lowercase
interval_count The number of intervals (specified in the interval property) between subscription billings
interval One of day, week, month or year. The frequency with which a subscription should be billed
product The product whose pricing this plan determines.
metadata A set of key-value pairs that describe additional information about the object
trial_period_days Default number of trial days when subscribing a customer to this plan using trial_from_plan=true

products

Segment flattens Stripe’s package_dimensions object. See Stripe’s Products documentation for more information.

Property Name Description
active Whether the product is available for purchase
attributes An array of up to 4 attributes that each SKU can provide
caption A short description of the product
deactivate_on An array of application identifiers that cannot purchase the product
description The product’s description, displayed to the customer
images An array of up to 8 image URLs for the product
livemode Whether the object exist in live mode or test mode
metadata A set of key-value pairs that describe additional information about the object
name The product’s name, as displayed to the customer
package_dimensions_ The dimensions of a product’s package, as described in Stripe’s documentation. For example, package_dimensions_height.
shippable Whether the product is a shipped good
url A URL of a publically-accessible webpage for this product

refunds

Property Name Description
amount Amount, in cents
balance_transaction_id Balance transaction that describes the impact on your account balance
charge_id ID of the charge that was refunded
currency Three-letter ISO currency code, in lowercase
metadata A set of key-value pairs that describe additional information about the object
reason Reason for the refund
receipt_number This is the transaction number that appears on email receipts sent for this refund

skus

Segment flattens Stripes inventory, package_dimensions objects.

Property Name Description
active Whether the SKU is available for purchase
attributes_ A dictionary of attributes and values defined by the product
created Time at which the object was created. Measured in seconds since the Unix epoch
currency Three-letter ISO currency code, in lowercase
image The URL of an image for this SKU
inventory_ A description of the SKU’s inventory. For example, inventory_quantity.
is_deleted Whether the object is active or has been deleted
livemode Whether the object exist in live mode or test mode
metadata A set of key-value pairs that describe additional information about the object
package_dimensions_ The dimensions of a SKU’s package dimensions. For example, package_dimensions_height.
price The cost of the item in the smallest currency unit
product_id The ID of the product this SKU is associated with
updated Time at which the object was last updated. Measured in seconds since the Unix epoch

subscriptions

Property Name Description
application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account
cancel_at_period_end If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true
canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
collection_method The method used to collect the subscription.
created Time at which the object was created. Measured in seconds since the Unix epoch.
current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
current_period_start Start of the current period that the subscription has been invoiced for.
customer_id ID of the customer who owns the subscription
discount_id References the associated discount, if available
ended_at If the subscription has ended, the date the subscription ended.
is_deleted Whether the object is active or has been deleted
plan_id References the associated plan, if available
quantity The quantity of the plan to which the customer is subscribed.
quantity The quantity of the plan to which the customer should be subscribed
start_date Date when the subscription was first created
status Possible values are trialing, active, past_due, canceled, or unpaid
trial_end If the subscription has a trial, the end of that trial.
trial_start If the subscription has a trial, the beginning of that trial.

subscription_items

Property Name Description
created Time at which the object was created. Measured in seconds since the Unix epoch.
metadata A set of key-value pairs that describe additional information about the object
plan_id References the associated plan, if available
quantity The quantity of the plan to which the customer is subscribed
subscription_id The ID of the subscription this item belongs to
tax_rates An array of tax rate IDs.

tax_rates

Property Name Description
active 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.
country Two-letter country code (ISO 3166-1 alpha-2).
description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive This specifies if the tax rate is inclusive or exclusive.
jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
percentage This represents the tax rate percent out of 100.
state ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
tax_type The high-level tax type, such as vat or sales_tax.

transfer_reversals

Property Name Description
amount Amount, in cents
balance_transaction_id Balance transaction that describes the impact on your account balance
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase
metadata A set of key-value pairs that describe additional information about the object
transfer_id ID of the transfer that was reversed

transfers

Property Name Description
amount_reversed Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)
amount Amount in cents to be transferred
balance_transaction_id Balance transaction that describes the impact of this transfer on your account balance
bank_account_id ID of the bank account used for the transaction
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase
description An arbitrary string attached to the object
destination_id ID of the Stripe account the transfer was sent to
destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer
metadata A set of key-value pairs that describe additional information about the object
reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false
source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance

This page was last modified: 22 May 2024



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account