Day of the month Day of the year |
| ||||||
Day of the week Week of the year |
| ||||||
Hour of the day Hour of the day |
| ||||||
Month of the year Month of the year |
| ||||||
Month and day Month and day |
| ||||||
Quarter of the year Quarter of the year |
| ||||||
Week of the year Week of the year |
| ||||||
Week of the year (start Sunday) Week of the year |
| ||||||
Year Year such as 2017. |
| ||||||
Year month Year and month. |
| ||||||
Date Year, month, and day. |
| ||||||
Year month day hour Year, month, day, and hour. |
| ||||||
Year Quarter Year and quarter. |
| ||||||
Year week Year and week. |
| ||||||
Account Id Id of an account. |
| ||||||
Account name Name of the account |
| ||||||
Balance Amount Balance amount. |
| ||||||
Balance Bank Account Amount Amount for bank account. |
| ||||||
Balance Card Amount Amount for card. |
| ||||||
Balance Currency Balance currency. Three-letter ISO currency code, in lowercase. Must be a supported currency. |
| ||||||
Balance FPX Amount Amount for FPX. |
| ||||||
Balance Type Should be available or pending |
| ||||||
Balance Transaction Amount 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. |
| ||||||
Balance Transaction Available On The date that the transaction’s net funds become available in the Stripe balance. |
| ||||||
Balance Transaction Created On Time at which the object was created. Measured in seconds since the Unix epoch. |
| ||||||
Balance Transaction Currency Three-letter ISO currency code, in lowercase. Must be a supported currency. |
| ||||||
Balance Transaction Exchange Rate 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. |
| ||||||
Balance Transaction Fee Fees paid for this transaction. Represented as a positive integer when assessed. |
| ||||||
Balance Transaction ID Unique identifier for the object. |
| ||||||
Balance Transaction Net 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 |
| ||||||
Balance Transaction Reporting Category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective. |
| ||||||
Balance Transaction Status The transaction’s net funds status in the Stripe balance, which are either available or pending. |
| ||||||
Balance Transaction Type The transaction type. |
| ||||||
Charge Amount 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). |
| ||||||
Charge Amount Captured Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made). |
| ||||||
Charge Amount Refunded Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued). |
| ||||||
Charge Billing City The charge's billing city. |
| ||||||
Charge Billing Country Two-letter country code (ISO 3166-1 alpha-2). |
| ||||||
Charge Billing Address Line 1 Address line 1 (e.g., street, PO Box, or company name). |
| ||||||
Charge Billing Address Line 2 Address line 2 (e.g., apartment, suite, unit, or building). |
| ||||||
Charge Billing Postal Code ZIP or postal code. |
| ||||||
Charge Billing State State, county, province, or region. |
| ||||||
Charge Billing Email The charge's billing phone. |
| ||||||
Charge Billing Name The charge’s billing name. |
| ||||||
Charge Billing Phone The charge's billing phone. |
| ||||||
Charge Calculated Statement Descriptor 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. |
| ||||||
Charge Is captured If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. |
| ||||||
Charge Created On Time at which the object was created. Measured in seconds since the Unix epoch. |
| ||||||
Charge Currency The charge's currency |
| ||||||
Charge Is Disputed The charge's disputed state |
| ||||||
Charge Failure Code Error code explaining reason for charge failure if available (see the errors section for a list of codes). |
| ||||||
Charge Failure Message Message to user further explaining reason for charge failure if available. |
| ||||||
Charge ID Unique identifier for the object. |
| ||||||
Charge Is Paid true if the charge succeeded, or was successfully authorized for later capture. |
| ||||||
Charge Id of the payment method ID of the payment method used in this charge. |
| ||||||
Charge Receipt Email The charge's receipt email |
| ||||||
Charge Receipt Number 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. |
| ||||||
Charge Receipt URL 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. |
| ||||||
Charge Is Refunded The charge's refunded state |
| ||||||
Charge Shipping City The charge's shipping city. |
| ||||||
Charge Shipping Country Two-letter country code (ISO 3166-1 alpha-2). |
| ||||||
Charge Shipping Address Line 1 Address line 1 (e.g., street, PO Box, or company name). |
| ||||||
Charge Shipping Address Line 2 Address line 2 (e.g., apartment, suite, unit, or building). |
| ||||||
Charge Shipping Postal Code ZIP or postal code. |
| ||||||
Charge Shipping State State, county, province, or region. |
| ||||||
Charge Shipping Carrier The charge's shipping carrier. |
| ||||||
Charge Shipping Name The charge's shipping name. |
| ||||||
Charge Shipping Phone The charge's shipping phone. |
| ||||||
Charge Shipping Tracking Number The charge's shipping tracking number. |
| ||||||
Charge Statement Descriptor 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. |
| ||||||
Charge Statement Descriptor Suffix 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. |
| ||||||
Charge Status The status of the payment is either succeeded, pending, or failed. |
| ||||||
Customer Balance 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. |
| ||||||
Customer City City, district, suburb, town, or village. |
| ||||||
Customer Country Two-letter country code (ISO 3166-1 alpha-2). |
| ||||||
Customer Created On Time at which the object was created. Measured in seconds since the Unix epoch. |
| ||||||
Customer currency Name of the customer |
| ||||||
Customer Delinquent Tracks the most recent state change on any invoice belonging to the customer. |
| ||||||
Customer Discount Describes the current discount active on the customer, if there is one. |
| ||||||
Customer email Email of the customer |
| ||||||
Customer ID Id of a customer. |
| ||||||
Customer Invoice Prefix Describes the current discount active on the customer, if there is one. |
| ||||||
Customer Address Line 1 Address line 1 (e.g., street, PO Box, or company name). |
| ||||||
Customer Address Line 2 Address line 2 (e.g., apartment, suite, unit, or building). |
| ||||||
Customer Name The customer’s full name or business name. |
| ||||||
Customer Next Invoice Sequence The suffix of the customer’s next invoice number (for example, 0001). |
| ||||||
Customer Phone The customer’s phone number. |
| ||||||
Customer Postal Code ZIP or postal code. |
| ||||||
Customer Shipping City The customer’s shipping city. |
| ||||||
Customer Shipping Country Two-letter country code (ISO 3166-1 alpha-2). |
| ||||||
Customer Shipping Address Line 1 Address line 1 (e.g., street, PO Box, or company name). |
| ||||||
Customer Shipping Address Line 2 Address line 2 (e.g., apartment, suite, unit, or building). |
| ||||||
Customer Shipping Postal Code ZIP or postal code. |
| ||||||
Customer Shipping State State, county, province, or region. |
| ||||||
Customer Shipping Name The customer’s shipping name. |
| ||||||
Customer Shipping Phone The customer’s shipping phone. |
| ||||||
Customer State State, county, province, or region. |
| ||||||
Customer Tax Exempt 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”. |
| ||||||
Customer IP Tax Address A recent IP address of the customer used for tax reporting and tax location inference. |
| ||||||
Customer Tax Location Country The customer’s country as identified by Stripe Tax. |
| ||||||
Customer Tax Location Source The data source used to infer the customer’s location. |
| ||||||
Customer Tax Location State The customer’s state, county, province, or region as identified by Stripe Tax. |
| ||||||
Customer Automatic Tax Status Surfaces if automatic tax computation is possible given the current customer location information. |
| ||||||
Invoice Amount Due 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. |
| ||||||
Invoice Amount Paied The amount, in cents, that was paid. |
| ||||||
Invoice Amount Remaining The difference between amount_due and amount_paid, in cents. |
| ||||||
Invoice Amount Shipping This is the sum of all the shipping amounts. |
| ||||||
Invoice Attempt Count 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. |
| ||||||
Invoice Attempted 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. |
| ||||||
Invoice Auto Advance The Invoice auto advance state |
| ||||||
Invoice Billing Reason Indicates the reason why the invoice was created. |
| ||||||
Invoice Collection Method 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. |
| ||||||
Invoice Created At Date fo the creation of the invoice. |
| ||||||
Invoice Currency Three-letter ISO currency code, in lowercase. Must be a supported currency. |
| ||||||
Invoice Due date The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically. |
| ||||||
Invoice Effective At 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. |
| ||||||
Invoice Ending Balance 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. |
| ||||||
Invoice Hosted URL The invoice url |
| ||||||
Invoice ID The Invoice ID |
| ||||||
Invoice PDF The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. |
| ||||||
Invoice Next Payment Attempt The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice. |
| ||||||
Invoice Number 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. |
| ||||||
Invoice Is Paid 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. |
| ||||||
Invoice Is Paid Out Of Band Returns true if the invoice was manually marked paid, returns false if the invoice hasn’t been paid yet or was paid on Stripe. |
| ||||||
Invoice Period End End of the usage period during which invoice items were added to this invoice. |
| ||||||
Invoice Period Start Start of the usage period during which invoice items were added to this invoice. |
| ||||||
Invoice Post Payment Credit Note Amount Total amount of all post-payment credit notes issued for this invoice. |
| ||||||
Invoice Pre Payment Credit Note Amount Total amount of all pre-payment credit notes issued for this invoice. |
| ||||||
Invoice Receipt Number This is the transaction number that appears on email receipts sent for this invoice. |
| ||||||
Invoice Starting Balance 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. |
| ||||||
Invoice Statement Descriptor Extra information about an invoice for the customer’s credit card statement. |
| ||||||
Invoice Status The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more |
| ||||||
Invoice Subscription Proration Date Only set for upcoming invoices that preview prorations. The time used to calculate prorations. |
| ||||||
Invoice Subtotal 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. |
| ||||||
Invoice Subtotal Excluding Tax 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 |
| ||||||
Invoice Tax The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. |
| ||||||
Invoice Total Total after discounts and taxes. |
| ||||||
Invoice Total Excluding Tax The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax. |
| ||||||
Invoice Item Amount The Invoice Item Amount |
| ||||||
Invoice Item Currency The Invoice Item Currency |
| ||||||
Invoice Item Created At The Invoice Item Created At |
| ||||||
Invoice Item IS Discountable The Invoice Item Is Discountable |
| ||||||
Invoice Item ID The Invoice Item Id |
| ||||||
Invoice Item Period End The Invoice Item Period End |
| ||||||
Invoice Item Period Start The Invoice Item Period Start |
| ||||||
Invoice Item Proration The Invoice Item Proration |
| ||||||
Invoice Item 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. |
| ||||||
Invoice Item Subscription item The subscription item that this invoice item has been created for, if any. |
| ||||||
Invoice Item Unit Amount Unit amount (in the currency specified) of the invoice item. |
| ||||||
Price Is Active Whether the price can be used for new purchases. |
| ||||||
Price Billing Scheme Describes how to compute the price per period. |
| ||||||
Price Created At Time at which the object was created. Measured in seconds since the Unix epoch. |
| ||||||
Price Currency Three-letter ISO currency code, in lowercase. |
| ||||||
Price Custom Unit Amount Custom unit amount if set. |
| ||||||
Price ID Unique identifier for the price object. |
| ||||||
Price Live Mode Has the value true if the object exists in live mode or false if in test mode. |
| ||||||
Price Metadata (flattened) Set of key-value pairs for structured data. Flattened from associative array. |
| ||||||
Price Descritpion A brief description or name for the price. |
| ||||||
Price Interval Billing frequency (e.g., month, year) for recurring prices. |
| ||||||
Price Interval Count Number of intervals between each billing period. |
| ||||||
Price Trial Period (Days) Number of trial period days granted when subscribing. |
| ||||||
Price Usage Type Configures how the quantity per period is determined. |
| ||||||
Price Tax Behavior Specifies whether the price is inclusive, exclusive, or unspecified of taxes. |
| ||||||
Price Tiers Mode Defines if tiered pricing is used and how. |
| ||||||
Price Transform Quantity Transform that is applied to the quantity before computing the amount due. |
| ||||||
Price Type One of 'one_time' or 'recurring'. |
| ||||||
Price Unit Amount The unit amount in cents to be charged, represented as a whole integer. |
| ||||||
Price Unit Amount (Decimal) The unit amount, represented as a decimal string with at most 12 decimal places. |
| ||||||
Product Active Whether the product is currently available for purchase. |
| ||||||
Default Price Amount The ID of the Price object that is the default price for this product. |
| ||||||
Product Description 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. |
| ||||||
Product ID Unique identifier for the object. |
| ||||||
Product Metadata (flattened) 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. |
| ||||||
Product Name The product’s name, meant to be displayable to the customer. |
| ||||||
Produce Tax Code ID A tax code ID that identifies the product category for tax calculation purposes. |
| ||||||
Subscription Billing Cycle Anchor 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. |
| ||||||
Subscription Cancel At A date in the future at which the subscription will automatically get canceled. |
| ||||||
Subscription 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. 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. |
| ||||||
Subscription 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 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. |
| ||||||
Subscription Cancellation Details Comment Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. |
| ||||||
Subscription Cancellation Details Feedback The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. |
| ||||||
Subscription Cancellation Details Reason Why this subscription was canceled. |
| ||||||
Subscription Collection Method 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. |
| ||||||
Subscription Created At Time at which the object was created. Measured in seconds since the Unix epoch. |
| ||||||
Subscription Currency Three-letter ISO currency code, in lowercase. Must be a supported currency. |
| ||||||
Subscription 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. |
| ||||||
Subscription Current Period Start Start of the current period that the subscription has been invoiced for. |
| ||||||
Subscription Days Until Due 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. |
| ||||||
Subscription Ended At If the subscription has ended, the date the subscription ended. |
| ||||||
Subscription ID The Subscription Id |
| ||||||
Subscription Next Pending Invoice item Invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval. |
| ||||||
Subscription Pause Collection Behavior The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void. |
| ||||||
Subscription Pause Collection Resume At The time after which the subscription will resume collecting payments. |
| ||||||
Subscription Start Date Date when the subscription was first created. The date might differ from the created date due to backdating. |
| ||||||
Subscription Status Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid. |
| ||||||
Subscription Trial End If the subscription has a trial, the end of that trial. |
| ||||||
Subscription Trial Start If the subscription has a trial, the beginning of that trial. |
|