Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Stripe Source


Source Info
  • The Stripe Source is an Object Cloud 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(link takes you to an external page) builds economic infrastructure for the internet, that enables businesses of every size to accept payments and manage their businesses online.


Getting started

getting-started page anchor
  1. In Segment, navigate 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(link takes you to an external page) with your test Secret Key. Segment's support team can then configure your source to use test mode data.

Sync

sync page anchor

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 are the groupings of resources that Segment pulls from your source. In your warehouse, each collection gets its own table.

CollectionTypeDescription
accountsobjectThis 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(link takes you to an external page)
application_fee_refundsobjectApplication 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(link takes you to an external page)
application_feesobjectWhen 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(link takes you to an external page)
balance_transaction_fee_detailsobjectBalance transaction fee details include a breakdown of fees (in cents) paid for each transaction. For more information, see Stripe's API docs(link takes you to an external page)
balance_transactionsobjectBalance transactions lists the transaction balance history. For more information, see Stripe's API docs(link takes you to an external page)
bank_accountsobjectBank 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(link takes you to an external page)
cardsobjectYou 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(link takes you to an external page)
chargesobjectTo 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(link takes you to an external page)
couponsobjectA 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(link takes you to an external page)
customersobjectCustomer 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(link takes you to an external page)
discountsobjectA 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(link takes you to an external page)
disputesobjectA 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(link takes you to an external page)
invoice_itemsobjectSometimes 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(link takes you to an external page)
invoice_linesobjectWhen 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(link takes you to an external page)
invoicesobjectInvoices 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(link takes you to an external page)
order_shipping_methods.objectA list of supported shipping methods for a given product.
payment_intents.objectA 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(link takes you to an external page)
payment_methods.objectPaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents(link takes you to an external page) to collect payments or saved to Customer objects to store instrument details for future payments. For more information, see Stripe's API docs(link takes you to an external page)
plans.objectA subscription plan contains the pricing information for different products and feature levels on your site. For more information, see Stripe's API docs(link takes you to an external page)
products.objectA specific good or service you make available for your customers to purchase. For more information, see Stripe's API docs(link takes you to an external page).
refunds.objectRefund 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(link takes you to an external page)
skusobjectA specific variant of a product. .
subscription_itemsobjectSubscription 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(link takes you to an external page).
subscriptions.objectSubscriptions 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(link takes you to an external page)
tax_rates.objectTax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
transfer_reversals.objectA 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(link takes you to an external page)
transfers.objectWhen 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(link takes you to an external page)

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

Property NameDescription
business_logoThe publicly visible logo of the business
business_nameThe publicly visible name of the business
business_urlThe publicly visible website of the business
charges_enabledWhether the account can create live charges
countryThe country of the account
debit_negative_balancesA Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account
default_currencyThe currency this account has chosen to use as the default
details_submittedWhether account details have been submitted
display_nameThe display name for this account
emailThe primary user's email address
metadataA set of key-value pairs that describe additional information about the object
statement_descriptorThe default text that appears on credit card statements when a charge is made directly on the account
support_address_cityCity/District/Suburb/Town/Village
support_address_countryTwo-letter ISO code representing the country of the card
support_address_line1Address line 1 (Street address/PO Box/Company name)
support_address_line2Address line 2 (Apartment/Suite/Unit/Building)
support_address_postal_codeZIP or postal code
support_address_stateState/County/Province/Region
support_emailA publicly shareable support email address for the business
support_phoneA publicly shareable support phone number for the business
support_urlA publicly shareable website
timezoneThe timezone used in the Stripe Dashboard for this account
transfers_enabledWhether transfers are enabled
product_descriptionInternal description of the product sold or service provided by the business.
typeThe Stripe account type. Can be standard, express, or custom.
Property NameDescription
amountAmount, in cents
createdTime at which the object was created. Measured in seconds since the Unix epoch.
currencyThree-letter ISO currency code, in lowercase
fee_idID of the application fee that was refunded
metadataA set of key-value pairs that describe additional information about the object
Property NameDescription
account_idID of the Stripe account this fee was taken from
amount_refundedAmount in pence refunded
amountAmount earned, in pence
application_idID of the Connect application that earned the fee
availableThe date on which the transaction's net funds become available to the balance
balance_transaction_idBalance transaction that describes the impact of this collected application fee on your account balance
charge_idID of the charge that the application fee was taken from
createdTime at which the object was created. Measured in seconds since the Unix epoch.
currencyThree-letter ISO currency code, in lowercase
metadataA set of key-value pairs that describe additional information about the object
originating_transactionID of the corresponding charge on the platform account
refundedWhether the fee has been fully refunded
transfer_idA reference to the related transaction, if enabled
Property NameDescription
amountGross amount of the transaction, in cents
currencyThree-letter ISO currency code, in lowercase
descriptionAn arbitrary string attached to the object
feeFees (in cents) paid for this transaction
metadataA set of key-value pairs that describe additional information about the object
netNet amount of the transaction, in cents
sourceThe Stripe object to which this transaction is related
statusIf the transaction's net funds are available in the Stripe balance yet
typeTransaction type
createdTime at which the object was created
availableThe date the transaction's net funds will become available in the Stripe balance

balance_transaction_fee_details

balance_transaction_fee_details page anchor
Property NameDescription
amountGross amount of the transaction, in pence
applicationID of the Stripe Connect application that earned the fee.
balance_transaction_idUnique identifier for the object
currencyThree-letter ISO currency code, in lowercase
descriptionAn arbitrary string attached to the object
typeTransaction type
Property NameDescription
bank_nameName of the bank associated with the routing number
countryTwo-letter ISO code representing the country the bank account is located in
currencyThree-letter ISO code for the currency paid out to the bank account
default_for_currencyCurrency default
is_deletedWhether the bank account is active or has been deleted
metadataA set of key-value pairs that describe additional information about the object
statusStatus of account
Property NameDescription
address_cityCity/District/Suburb/Town/Village
address_countryBilling address country, if provided when creating card
address_line1_checkCheck for address_line1 value
address_line1Address line 1 (Street address/PO Box/Company name)
address_line2Address line 2 (Apartment/Suite/Unit/Building)
address_stateState/County/Province/Region
address_zip_checkCheck for ZIP or postal code
address_zipZIP or postal code
brandCard brand
countryTwo-letter ISO code representing the country of the card
cvc_checkIf a CVC was provided, results of the check
dynamic_last4The last four digits of the device account number
exp_monthTwo-digit number representing the card's expiration month
exp_yearFour-digit number representing the card's expiration year
fingerprintUniquely identifies this particular card number.
fundingCard funding type
last4The last four digits of the card
metadataA set of key-value pairs that describe additional information about the object
nameCardholder name
tokenization_methodIf the card number is tokenized, this is the method that was used
Property NameDescription
amount_refundedAmount in cents refunded
amountA positive integer in the smallest currency unit representing how much to charge
application_feeThe application fee (if any) for the charge
balance_transaction_idID of the balance transaction that describes the impact of this charge on your account balance
capturedIf the charge was created without capturing
currencyThree-letter ISO currency code, in lowercase
customer_idID of the customer this charge is for if one exists
descriptionAn arbitrary string attached to the object
destinationThe account (if any) the charge was made on behalf of, with an automatic transfer
failure_codeError code explaining reason for charge failure if available
failure_messageMessage to user further explaining reason for charge failure if available
fraud_details_stripe_reportAssessment from Stripe that describes if a charge is fraudulent
fraud_details_user_reportAssessment from a user that describes if a charge is safe or fraudulent
invoice_idID of the invoice this charge is for if one exists
metadataA set of key-value pairs that describe additional information about the object
paidtrue if the charge succeeded, or was successfully authorized for later capture
payment_intent_idID of the PaymentIntent associated with this charge, if one exists.
payment_method_idID of the payment method used in this charge.
receipt_emailThis is the email address that the receipt for this charge was sent to
receipt_numberThis is the transaction number that appears on email receipts sent for this charge
refundedWhether the charge has been fully refunded
shipping_address_cityCity/District/Suburb/Town/Village
shipping_address_countryTwo-letter ISO code representing the country of the charge
shipping_address_line1Address line 1 (Street address/PO Box/Company name)
shipping_address_line2Address line 2 (Apartment/Suite/Unit/Building)
shipping_address_postal_codeZIP or postal code
shipping_address_stateState/County/Province/Region
shipping_carrierThe delivery service that shipped the charged order
shipping_nameThe recipient's name
shipping_phoneThe recipient's phone number, including extension
shipping_tracking_numberThe tracking number obtained from the specified carrier
statement_descriptorExtra information about a charge. This will appear on your customer's credit card statement
statusThe status of the payment
Property NameDescription
amount_offAmount (in the currency specified) that will be taken off the subtotal of any invoices for this customer
currencyThe three-letter ISO code for the currency of the amount to take off
duration_in_monthsIf duration is repeating, the number of months the coupon applies
durationDescribes how long a customer who applies this coupon will get the discount
max_redemptionsMaximum number of times this coupon can be redeemed, in total, before it is no longer valid
metadataA set of key-value pairs that describe additional information about the object
percent_offPercent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon
percent_off_precisePercent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon, in decimal form
times_redeemedNumber of times this coupon has been applied to a customer
validTaking account of the above properties, whether this coupon can still be applied to a customer
Property NameDescription
balanceCurrent balance, if any, being stored on the customer's account
currencyThree-letter ISO code for the currency the customer can be charged in for recurring billing purpose
default_sourceID of the default payment source for the customer.
delinquentWhen the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed
descriptionAn arbitrary string attached to the object
emailThe customer's email address
metadataA set of key-value pairs that describe additional information about the object
Property NameDescription
coupon_idThe ID of the discount
customer_idID of the customer
endThe end date of the discount, unless the discount is applied either once or forever
startThe date the discount was applied
subscriptionThe subscription that this coupon is applied to, if it is applied to a particular subscription

Segment flattens Stripe's Evidence and Evidence Details objects. See Stripe's Dispute(link takes you to an external page) documentation for more detail.

Property NameDescription
amountDisputed amount. Usually the amount of the charge
charge_idID of the charge that was disputed
currencyThree-letter ISO currency code, in lowercase
createdTime 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(link takes you to an external page). For example, evidence_access_activity_log.
evidence_details_The evidence details of a dispute, as described in Stripe's documentation(link takes you to an external page). For example, evidence_details_due_by.
is_charge_refundableIf true, it is still possible to refund the disputed payment
metadataA set of key-value pairs that describe additional information about the object
reasonReason given by cardholder for dispute
statusCurrent status of dispute
Property NameDescription
amountAmount (in the currency specified) of the invoice item
currencyThree-letter ISO currency code, in lowercase
customer_idThe ID of the customer who will be billed when this invoice item is billed
dateTime at which the object was created. Measured in seconds since the Unix epoch.
descriptionAn arbitrary string attached to the object
discountableIf true, discounts will apply to this invoice item. Always false for prorations
invoice_idThe ID of the invoice this invoice item belongs to
metadataA set of key-value pairs that describe additional information about the object
period_startThe start of the period
period_endThe end of the period, which must be greater than or equal to the start.
prorationWhether the invoice item was created automatically as a proration adjustment when the customer switched plans
quantityQuantity 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_idThe subscription that this invoice item has been created for, if any
Property NameDescription
amount_dueFinal amount due at this time for this invoice
application_feeThe 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_countNumber of payment attempts made for this invoice, from the perspective of the payment retry schedule
attemptedWhether an attempt has been made to pay the invoice
billing_reasonThe reason for the invoice.
charge_idID of the latest charge generated for this invoice, if any
currencyThree-letter ISO currency code, in lowercase
customer_idID of the customer
descriptionAn arbitrary string attached to the object
due_dateThe invoice's due date.
ending_balanceEnding customer balance after the invoice is frozen
metadataA set of key-value pairs that describe additional information about the object
paidWhether payment was successfully collected for this invoice
period_endEnd of the usage period during which invoice items were added to the invoice
period_startStart of the usage period during which invoice items were added to the invoice
receipt_numberThis is the transaction number that appears on email receipts sent for this invoice
starting_balanceStarting customer balance before the invoice is frozen
statement_descriptorExtra information about an invoice for the customer's credit card statement
subscription_idThe subscription that this invoice was prepared for, if any
subtotalTotal of all subscriptions, invoice items, and prorations on the invoice before any discount is applied
taxThe 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
totalTotal after discount
auto_advanceControls whether Stripe will perform automatic collection of the invoice.
statusThe status of the invoice
createdTime at which the object was created. Measured in seconds since the Unix epoch.
Property NameDescription
amountThe amount, in cents
currencyThree-letter ISO currency code(link takes you to an external page)
descriptionAn arbitrary string attached to the object
discountableIf true, discounts will apply to this line item. Always false for prorations
invoice_idThe ID of the invoice to which this line belongs
item_idIf id is prefixed with ii_ then this is the line item's UUID, if any
period_endEnd of the line item's billing period
period_startStart of the line item's billing period
plan_idThe id of the Plan that this invoice_line belongs to
prorationIf true, this line item is a proration
quantityThe quantity of the subscription, if the line item is a subscription or a proration
subscription_idIf 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_ratesAn array of tax rate IDs.
typeA string identifying the type of the source of this line item, either an InvoiceItem or a Subscription

Segment flattens Stripe's Delivery Estimate object.

Property NameDescription
amountThe total amount of the line item, represented in the smallest currency unit
currencyThree-letter ISO currency code(link takes you to an external page), in lowercase.
delivery_estimate_The estimated delivery date for a given shipping method. For example, delivery_estimate_date.
descriptionAn arbitrary string attached to the object
order_idThe identifier of the order associated with the shipping method
shipping_idA unique identifier for a given shipping method
Property NameDescription
amount_capturableAmount that can be captured from this PaymentIntent.
amount_receivedAmount that was collected by this PaymentIntent.
amountAmount intended to be collected by this PaymentIntent.
application_fee_amountThe amount of the application fee (if any) for the resulting payment.
application_idID of the Connect application that created the PaymentIntent.
canceled_atTime at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
cancellation_reasonReason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
capture_methodOne of automatic (default) or manual. For more info refer Stripe API docs(link takes you to an external page)
confirmation_methodOne of automatic (default) or manual. For more info refer Stripe API docs(link takes you to an external page)
createdTime at which the object was created. Measured in seconds since the Unix epoch.
currencyThree-letter ISO currency code(link takes you to an external page), in lowercase.
customer_idID of the Customer this PaymentIntent is for, if one exists.
descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
invoice_idID of the invoice that created this PaymentIntent, if it exists.
livemodeHas the value true if the object exists in live mode or the value false if the object exists in test mode.
metadataA set of key-value pairs that describe additional information about the object
on_behalf_ofThe account (if any) for which the funds of the PaymentIntent are intended.
payment_method_idID of the payment method used in this PaymentIntent.
receipt_emailEmail address that the receipt for the resulting payment will be sent to.
review_idID of the review associated with this PaymentIntent, if any.
statement_descriptorExtra information about a PaymentIntent. This will appear on your customer's statement when this PaymentIntent succeeds in creating a charge.
statusStatus of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status(link takes you to an external page).
transfer_data_amountThe amount intended to be collected
transfer_data_destinationThe 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_groupA string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts(link takes you to an external page) for details.
Property NameDescription
billing_details_address_cityCity tied to the PaymentMethod's billing details
billing_details_address_country2-letter country code tied to the PaymentMethod's billing details
billing_details_address_line1Address line 1 tied to the PaymentMethod's billing details
billing_details_address_line2Address line 2 tied to the PaymentMethod's billing details
billing_details_address_postal_codeZIP or Postal code tied to the PaymentMethod's billing details
billing_details_address_stateState/Country/Province/Region tied to the PaymentMethod's billing details
billing_details_emailEmail address tied to the PaymentMethod's billing details
billing_details_nameName tied to the PaymentMethod's billing details
billing_details_phonePhone number tied to the PaymentMethod's billing details
card_networks_availableAll available networks for the card
createdTime at which the object was created. Measured in seconds since the Unix epoch.
customer_idThe 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.
livemodeHas the value true if the object exists in live mode or the value false if the object exists in test mode.
metadataA set of key-value pairs that describe additional information about the object
typeThe 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 objectThe 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)
Property NameDescription
amountThe amount in cents to be charged on the interval specified
currencyThree-letter ISO currency code, in lowercase
interval_countThe number of intervals (specified in the interval property) between subscription billings
intervalOne of day, week, month or year. The frequency with which a subscription should be billed
productThe product whose pricing this plan determines.
metadataA set of key-value pairs that describe additional information about the object
trial_period_daysDefault number of trial days when subscribing a customer to this plan using trial_from_plan=true

Segment flattens Stripe's package_dimensions object. See Stripe's Products(link takes you to an external page) documentation for more information.

Property NameDescription
activeWhether the product is available for purchase
attributesAn array of up to 4 attributes that each SKU can provide
captionA short description of the product
deactivate_onAn array of application identifiers that cannot purchase the product
descriptionThe product's description, displayed to the customer
imagesAn array of up to 8 image URLs for the product
livemodeWhether the object exist in live mode or test mode
metadataA set of key-value pairs that describe additional information about the object
nameThe product's name, as displayed to the customer
package_dimensions_The dimensions of a product's package, as described in Stripe's documentation(link takes you to an external page). For example, package_dimensions_height.
shippableWhether the product is a shipped good
urlA URL of a publically-accessible webpage for this product
Property NameDescription
amountAmount, in cents
balance_transaction_idBalance transaction that describes the impact on your account balance
charge_idID of the charge that was refunded
currencyThree-letter ISO currency code, in lowercase
metadataA set of key-value pairs that describe additional information about the object
reasonReason for the refund
receipt_numberThis is the transaction number that appears on email receipts sent for this refund

Segment flattens Stripe's inventory, package_dimensions objects.

Property NameDescription
activeWhether the SKU is available for purchase
attributes_A dictionary of attributes and values defined by the product
createdTime at which the object was created. Measured in seconds since the Unix epoch
currencyThree-letter ISO currency code, in lowercase
imageThe URL of an image for this SKU
inventory_A description of the SKU's inventory. For example, inventory_quantity.
is_deletedWhether the object is active or has been deleted
livemodeWhether the object exist in live mode or test mode
metadataA 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.
priceThe cost of the item in the smallest currency unit
product_idThe ID of the product this SKU is associated with
updatedTime at which the object was last updated. Measured in seconds since the Unix epoch
Property NameDescription
application_fee_percentThis represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account
cancel_at_period_endIf 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_atIf 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_methodThe method used to collect the subscription.
createdTime at which the object was created. Measured in seconds since the Unix epoch.
current_period_endEnd 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_startStart of the current period that the subscription has been invoiced for.
customer_idID of the customer who owns the subscription
discount_idReferences the associated discount, if available
ended_atIf the subscription has ended, the date the subscription ended.
is_deletedWhether the object is active or has been deleted
plan_idReferences the associated plan, if available
quantityThe quantity of the plan to which the customer is subscribed.
start_dateDate when the subscription was first created
statusPossible values are trialing, active, past_due, canceled, or unpaid
trial_endIf the subscription has a trial, the end of that trial.
trial_startIf the subscription has a trial, the beginning of that trial.
Property NameDescription
createdTime at which the object was created. Measured in seconds since the Unix epoch.
metadataA set of key-value pairs that describe additional information about the object
plan_idReferences the associated plan, if available
quantityThe quantity of the plan to which the customer is subscribed
subscription_idThe ID of the subscription this item belongs to
tax_ratesAn array of tax rate IDs.
Property NameDescription
activeDefaults 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.
countryTwo-letter country code (ISO 3166-1 alpha-2(link takes you to an external page)).
descriptionAn arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_nameThe display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusiveThis specifies if the tax rate is inclusive or exclusive.
jurisdictionThe jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
percentageThis represents the tax rate percent out of 100.
stateISO 3166-2(link takes you to an external page) subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_typeThe high-level tax type, such as vat or sales_tax.
Property NameDescription
amountAmount, in cents
balance_transaction_idBalance transaction that describes the impact on your account balance
createdTime at which the object was created. Measured in seconds since the Unix epoch.
currencyThree-letter ISO currency code, in lowercase
metadataA set of key-value pairs that describe additional information about the object
transfer_idID of the transfer that was reversed
Property NameDescription
amount_reversedAmount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)
amountAmount in cents to be transferred
balance_transaction_idBalance transaction that describes the impact of this transfer on your account balance
bank_account_idID of the bank account used for the transaction
createdTime at which the object was created. Measured in seconds since the Unix epoch.
currencyThree-letter ISO currency code, in lowercase
descriptionAn arbitrary string attached to the object
destination_idID of the Stripe account the transfer was sent to
destination_paymentIf the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer
metadataA set of key-value pairs that describe additional information about the object
reversedWhether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false
source_transactionID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance