Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

Retrieves the balance transaction with the given ID.

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

For automatic Stripe payouts only; only returns transactions that were paid out on the specified payout ID

payout

Only returns transactions of the given type. One of - adjustment; advance; advance_funding; anticipation_repayment; application_fee; application_fee_refund; charge; connect_collection_transfer; contribution; issuing_authorization_hold; issuing_authorization_release; issuing_dispute; issuing_transaction; payment; payment_failure_refund; payment_refund; payout; payout_cancel; payout_failure; refund; refund_failure; reserve_transaction; reserved_funds; stripe_fee; stripe_fx_fee; tax_fee; topup; topup_reversal transfer; transfer_cancel; transfer_failure; or transfer_refund

type

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp; or it can be a dictionary with the following options

created

Only return transactions in a certain currency. Three-letter ISO currency code in lowercase. Must be a supported currency

currency

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance; if you make a list request and receive 100 objects; starting with obj_bar; your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list

ending_before

A limit on the number of objects to be returned. Limit can range between 1 and 100; and the default is 10

limit

source

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance; if you make a list request and receive 100 objects; ending with obj_foo; your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list

starting_after

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 $999999.99)

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

An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers; your receipt emails will include the description of the charge(s) that they are describing

The email address to which this charge’s receipt will be sent. The receipt will not be sent until the charge is paid; and no receipts will be sent for test mode charges. If this charge is for a Customer; the email address specified here will override the customer’s email address. If receipt_email is specified for a charge in live mode; a receipt will be sent regardless of your email settings

Shipping information for the charge. Helps prevent fraud on charges for physical goods

A payment source to be charged. This can be the ID of a card (i.e. credit or debit card); a bank account; a source; a token; or a connected account. For certain sources—namely; cards; bank accounts; and attached sources—you must also pass the ID of the associated customer

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.

Only return charges for the customer specified by this customer ID.

customer

A filter on the list based on the object created field.

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance; if you make a list request and receive 100 objects; starting with obj_bar; your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

A limit on the number of objects to be returned. Limit can range between 1 and 100; and the default is 10.

Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.

payment_intent

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Only return charges for this transfer group.

transfer_group

The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.

An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers; your receipt emails will include the description of the charge(s) that they are describing.

A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent include a user_report key with a value of fraudulent. If you believe a charge is safe; include a user_report key with a value of safe. Stripe will use the information you send to improve our fraud detection algorithms.

A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

This is the email address that the receipt for this charge will be sent to. If this field is updated; then a new email receipt will be sent to the updated address.

Shipping information for the charge. Helps prevent fraud on charges for physical goods.

The amount to capture which must be less than or equal to the original amount. Any additional amount will be automatically refunded.

An application fee amount to add on to this charge which must be less than or equal to the original amount.

The email address to send this charge’s receipt to. This will override the previously-specified email address for this charge; if one was set. Receipts will not be sent in test mode.

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.

An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

The search query string. See search query language and the list of supported query fields for charges.

query

Configure actions after a Checkout Session has expired.

Settings for automatic tax lookup for this session and resulting payments; invoices and subscriptions.

Specify whether Checkout should collect the customer’s billing address.

If set; Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.

A unique string to reference the Checkout Session. This can be a customer ID; a cart ID; or similar; and can be used to reconcile the session with your internal systems.

Configure fields for the Checkout Session to gather active consent from customers.

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

Display additional text for your customers using custom text.

ID of an existing Customer; if one exists. In payment mode the customer’s most recent card payment method will be used to prefill the email name; card details; and billing address on the Checkout page. In subscription mode; the customer’s default payment method will be used if it’s a card; and otherwise the most recent card will be used. A valid billing address; billing name and billing email are required on the payment method for Checkout to prefill the customer’s card details.If the Customer already has a valid email set; the email will be prefilled and not editable in Checkout. If the Customer does not have a valid email; Checkout will set the email entered during the session on the Customer.If blank for Checkout Sessions in payment or subscription mode; Checkout will create a new Customer object based on information provided during the payment flow.You can set payment_intent_data.setup_future_usage to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.

Configure whether a Checkout Session creates a Customer during Session confirmation.When a Customer is not created; you can still retrieve email; address; and other customer data entered in Checkout with customer_details.Sessions that don’t create Customers instead are grouped by guest customers in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.Can only be set in payment and setup mode.
customer_update

If provided this value will be used when the Customer object is created. If not provided; customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete use the customer field.

The coupon or promotion code to apply to this Session. Currently; only up to one may be specified.

The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default; this value is 24 hours from creation.

Generate a post-purchase Invoice for one-time payments.

A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.For payment mode there is a maximum of 100 line items; however it is recommended to consolidate line items if there are more than a few dozen.For subscription mode there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.

The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item.

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

Specify whether Checkout should collect a payment method. When set to if_required; Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount.Can only be set in subscription mode.

A list of the types of payment methods (e.g. card) this Checkout Session can accept.In payment and subscription mode you can omit this attribute to manage your payment methods from the Stripe Dashboard. It is required in setup mode.Read more about the supported payment methods and their requirements in our payment method details guide.If multiple payment methods are passed; Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer’s location and other characteristics.

Controls phone number collection settings for the session.We recommend that you review your privacy policy and check with your legal contacts before using this feature. Learn more about collecting phone numbers with Checkout.

A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.

When set; provides configuration for Checkout to collect a shipping address from a customer.

The shipping rate options to apply to this Session.

Describes the type of transaction being performed by Checkout in order to customize relevant text on the page; such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode; but not Checkout Sessions in subscription or setup mode.

A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.

The URL to which Stripe should send customers when payment or setup is complete. If you’d like to use information from the successful Checkout Session on your page; read the guide on customizing your success page.

Controls tax ID collection settings for the session.

Only return the Checkout Session for the PaymentIntent specified.

Only return the Checkout Session for the subscription specified.

subscription

Only return the Checkout Sessions for the Customer specified.

Only return the Checkout Sessions for the Customer details specified.

customer_details

A limit on the number of objects to be returned. Limit can range between 1 and 100 and the default is 10.

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance; if you make a list request and receive 100 objects; ending with obj_foo; your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed)

A hash containing directions for what this Coupon will apply discounts to.

Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed)

Coupons defined in each available currency option (only supported if amount_off is passed). Each key must be a three-letter ISO currency code and a supported currency. For example; to define your coupon in eur; pass the fields below in the eur key of currency_options.

Specifies how long the discount will be in effect if used on a subscription

Required only if duration is repeating in which case it must be a positive integer that specifies the number of months the discount will be in effect.

Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don’t want to specify a particular code; you can leave the ID blank and we’ll generate a random code for you.

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example; you might have a 50% off coupon that the first 20 readers of your blog can use.

Name of the coupon displayed to customers on for instance invoices; or receipts. By default the id is shown if name is not set.

A positive float larger than 0; and smaller or equal to 100; that represents the discount the coupon will apply (required if amount_off is not passed).

Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date; the coupon can no longer be applied to new customers.

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp.

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter ISO currency code and a supported currency. For example; to define your coupon in eur; pass the fields below in the eur key of currency_options.

Name of the coupon displayed to customers on; for instance invoices; or receipts. By default the id is shown if name is not set.

An integer amount in cents that represents the customer’s current balance; which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.

Balance information and default balance settings for this customer.

If you provide a coupon code the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.

An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.

The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

Default invoice settings for this customer.

The customer’s full name or business name.

The sequence to be used on the customer’s next invoice. Defaults to 1.

The ID of the PaymentMethod to attach to the customer.

Customer’s preferred languages ordered by preference.

The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.

The customer’s shipping information. Appears on invoices emailed to this customer.

When using payment sources created via the Token or Sources APIs; passing source will create a new source object; make it the new customer default source; and delete the old customer default if one exists. If you want to add additional sources instead of replacing the existing default; use the card creation API. Whenever you attach a card to a customer; Stripe will automatically validate the card.

The customer’s tax exemption. One of - none; exempt; reverse.

A case-sensitive filter on the list based on the customer’s email field. The value must be a string

email

A filter on the list based on the object created field

Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

test_clock

If you provide a coupon code; the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.

f you are using payment methods created via the PaymentMethods API see the invoice_settings.default_payment_method parameter.Provide the ID of a payment source already attached to this customer to make it this customer’s default payment source.If you want to add a new payment source and make it the default see the source property.

Customer’s preferred languages; ordered by preference.

When using payment sources created via the Token or Sources APIs passing source will create a new source object; make it the new customer default source and delete the old customer default if one exists. If you want to add additional sources instead of replacing the existing default; use the card creation API. Whenever you attach a card to a customer Stripe will automatically validate the card.

The customer’s tax exemption. One  - none;exempt; reverse.

The search query string. See search query language and the list of supported query fields for customers.

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

page

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. Can only be applied when there are no line items with recurring prices.

Configuration for automatic tax collection.

Configuration for collecting the customer’s billing address.

Configure fields to gather active consent from customers.

Three-letter ISO currency code; in lowercase. Must be a supported currency and supported by each line item’s price.

Configures whether checkout sessions created by this payment link create a Customer.

The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

The account on behalf of which to charge.

Specify whether Checkout should collect a payment method. When set to if_required; Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.

The list of payment method types that customers can use.

Controls phone number collection settings during checkout.We recommend that you review your privacy policy and check with your legal contacts.

Configuration for collecting the customer’s shipping address.

The shipping rate options to apply to checkout sessions created by this payment link.

Describes the type of transaction being performed in order to customize relevant text on the page such as the submit button. Changing this value will also affect the hostname in the url property (example

When creating a subscription the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.

Controls tax ID collection during checkout.

The account (if any) the payments will be attributed to for tax reporting; and where funds from each payment will be transferred to.

Only return payment links that are active or inactive (e.g. pass false to list all inactive payment links).

active

Whether the payment link’s url is active. If false; customers visiting the URL will be shown a page saying that the link has been deactivated.

The list of payment method types that customers can use. Pass an empty string to enable automatic payment methods that use your payment method settings.

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance if you make a list request and receive 100 objects ending with obj_foo; your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list

Whether the price can be used for new purchases

Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed) or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. For example; to define your price in eur; pass the fields below in the eur key of currency_options.

When set; provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

A brief description of the price; hidden from customers.

The ID of the product that this price will belong to.

These fields can be used to create a new product that this price will belong to.

The recurring components of a price such as interval and usage_type.

Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive; exclusive; or unspecified. Once specified as either inclusive or exclusive; it cannot be changed.

Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

Defines if the tiering price should be graduated or volume based. In volume-based tiering; the maximum quantity within a period determines the per unit price; in graduated tiering pricing can successively change as the quantity grows.

If set to true will atomically remove the lookup key from the existing price and assign it to this price.

Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.

A positive integer in cents (or 0 for a free price) representing how much to charge. One of unit_amount or custom_unit_amount is required; unless billing_scheme=tiered.

Same as unit_amount; but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Only return prices that are active or inactive (e.g. pass false to list all inactive prices).

Only return prices for the given currency.

Only return prices for the given product.

product

Only return prices of type recurring or one_time.

Only return the price with these lookup_keys; if any exist.

lookup_keys

Only return prices with these recurring fields.

recurring

Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive exclusive or unspecified. Once specified as either inclusive or exclusive; it cannot be changed.

If set to true; will atomically remove the lookup key from the existing price; and assign it to this price.

The search query string. See search query language and the list of supported query fields for prices.

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.

An identifier will be randomly generated by Stripe. You can optionally override this ID but the ID must be unique across all products in your Stripe account.

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

Only return products that are active or inactive (e.g. pass false to list all inactive products).

Only return products with the given IDs. Cannot be used with starting_after or ending_before.

Only return products that can be shipped (i.e. physical and not digital products).

shippable

Whether the product is available for purchase.

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

The search query string. See search query language and the list of supported query fields for products.

Whether the promotion code is currently active.

The customer-facing code. Regardless of case; this code must be unique across all active promotion codes for a specific customer. If left blank; we will generate one automatically.

The customer that this promotion code can be used by. If not set; the promotion code can be used by all customers.

The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by; then this value cannot be after the coupon’s redeems_by.

A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions; then this value cannot be greater than the coupon’s max_redemptions.

Settings that restrict the redemption of the promotion code.

Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. Not supported for receiver type sources, where charge amount may not be specified until funds land.

Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.

Information about the owner of the payment instrument that may be used or required by particular source types.

Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow is redirect).

An arbitrary string to be displayed on your customer’s statement. As an example, if your website is RunClub and the item you’re charging for is a race ticket, you may want to specify a statement_descriptor of RunClub 5K race ticket. While many payment types will display this information, some may not display it at all.

The type of the source to create. Required unless customer and original_source are specified (see the Cloning card Sources guide)