Fields listing for Stripe

Id of an account.

Name of the account

Balance amount.

Amount for bank account.

Amount for card.

Balance currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.

Amount for FPX.

Gross amount of this transaction (in cents). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.

The date that the transaction’s net funds become available in the Stripe balance.

Time at which the object was created. Measured in seconds since the Unix epoch.

Three-letter ISO currency code, in lowercase. Must be a supported currency.

If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’s amount is 1000 and currency is eur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’s amount is 1234, its currency is usd, and the exchange_rate is 1.234.

Fees paid for this transaction. Represented as a positive integer when assessed.

Unique identifier for the object.

Net impact to a Stripe balance (in cents). 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

Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

The transaction’s net funds status in the Stripe balance, which are either available or pending.

The transaction type.

Should be available or pending

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

The charge's billing city.

Two-letter country code (ISO 3166-1 alpha-2).

The charge's billing phone.

The charge’s billing name.

The charge's billing phone.

ZIP or postal code.

State, county, province, or region.

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.

Time at which the object was created. Measured in seconds since the Unix epoch.

The charge's currency

Error code explaining reason for charge failure if available (see the errors section for a list of codes).

Message to user further explaining reason for charge failure if available.

Unique identifier for the object.

ID of the payment method used in this charge.

If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

The charge's disputed state

true if the charge succeeded, or was successfully authorized for later capture.

The charge's refunded state

The charge's receipt email

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.

his 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.

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

The charge's shipping carrier.

The charge's shipping city.

Two-letter country code (ISO 3166-1 alpha-2).

The charge's shipping name.

The charge's shipping phone.

ZIP or postal code.

State, county, province, or region.

The charge's shipping tracking number.

For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.

Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

The status of the payment is either succeeded, pending, or failed.

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

Surfaces if automatic tax computation is possible given the current customer location information.

The current balance, if any, that’s stored on the customer. 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.

City, district, suburb, town, or village.

Two-letter country code (ISO 3166-1 alpha-2).

Time at which the object was created. Measured in seconds since the Unix epoch.

Name of the customer

Tracks the most recent state change on any invoice belonging to the customer.

Describes the current discount active on the customer, if there is one.

Email of the customer

Id of a customer.

Describes the current discount active on the customer, if there is one.

A recent IP address of the customer used for tax reporting and tax location inference.

The customer’s full name or business name.

The suffix of the customer’s next invoice number (for example, 0001).

The customer’s phone number.

ZIP or postal code.

Address line 1 (e.g., street, PO Box, or company name).

Address line 2 (e.g., apartment, suite, unit, or building).

The customer’s shipping city.

Two-letter country code (ISO 3166-1 alpha-2).

The customer’s shipping name.

The customer’s shipping phone.

ZIP or postal code.

State, county, province, or region.

State, county, province, or region.

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”.

The customer’s country as identified by Stripe Tax.

The data source used to infer the customer’s location.

The customer’s state, county, province, or region as identified by Stripe Tax.

Year, month, and day.

Day of the year

Week of the year

The ID of the Price object that is the default price for this product.

Hour of the day

Final amount due at this time for this invoice. If the invoice’s total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.

The amount, in cents, that was paid.

The difference between amount_due and amount_paid, in cents.

This is the sum of all the shipping amounts.

Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.

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.

The Invoice auto advance state

Indicates the reason why the invoice was created.

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.

Date fo the creation of the invoice.

Three-letter ISO currency code, in lowercase. Must be a supported currency.

The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.

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.

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.

The invoice url

The Invoice ID

Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer’s account balance.

Returns true if the invoice was manually marked paid, returns false if the invoice hasn’t been paid yet or was paid on Stripe.

The Invoice Item Amount

The Invoice Item Created At

The Invoice Item Currency

The Invoice Item Id

The Invoice Item Is Discountable

The Invoice Item Period End

The Invoice Item Period Start

The Invoice Item Proration

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.

The subscription item that this invoice item has been created for, if any.

Unit amount (in the currency specified) of the invoice item.

The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.

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.

The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

End of the usage period during which invoice items were added to this invoice.

Start of the usage period during which invoice items were added to this invoice.

Total amount of all post-payment credit notes issued for this invoice.

Total amount of all pre-payment credit notes issued for this invoice.

This is the transaction number that appears on email receipts sent for this invoice.

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.

Extra information about an invoice for the customer’s credit card statement.

The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

Only set for upcoming invoices that preview prorations. The time used to calculate prorations.

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.

The integer amount in cents representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated

The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.

Total after discounts and taxes.

The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax.

Month and day

Month of the year

Describes how to compute the price per period.

Time at which the object was created. Measured in seconds since the Unix epoch.

Three-letter ISO currency code, in lowercase.

Custom unit amount if set.

A brief description or name for the price.

Unique identifier for the price object.

Billing frequency (e.g., month, year) for recurring prices.

Number of intervals between each billing period.

Whether the price can be used for new purchases.

Has the value true if the object exists in live mode or false if in test mode.

Set of key-value pairs for structured data. Flattened from associative array.

Specifies whether the price is inclusive, exclusive, or unspecified of taxes.

Defines if tiered pricing is used and how.

Transform that is applied to the quantity before computing the amount due.

Number of trial period days granted when subscribing.

One of 'one_time' or 'recurring'.

The unit amount in cents to be charged, represented as a whole integer.

The unit amount, represented as a decimal string with at most 12 decimal places.

Configures how the quantity per period is determined.

A tax code ID that identifies the product category for tax calculation purposes.

Whether the product is currently available for purchase.

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.

Unique identifier for the object.

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. Flattened from associative array.

The product’s name, meant to be displayable to the customer.

Quarter of the year

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.

A date in the future at which the subscription will automatically get canceled.

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. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.

Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.

The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.

Why this subscription was canceled.

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. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.

Time at which the object was created. Measured in seconds since the Unix epoch.

Three-letter ISO currency code, in lowercase. Must be a supported currency.

End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

Start of the current period that the subscription has been invoiced for.

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.

If the subscription has ended, the date the subscription ended.

The Subscription Id

Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.

The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.

The time after which the subscription will resume collecting payments.

Date when the subscription was first created. The date might differ from the created date due to backdating.

Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.

If the subscription has a trial, the end of that trial.

If the subscription has a trial, the beginning of that trial.

Week of the year

Week of the year

Year such as 2017.

Year and month.

Year, month, day, and hour.

Year and quarter.

Year and week.