Stripe.net

Occurs whenever an account status or property has changed.

Occurs whenever a user authorizes an application. Sent to the related application only.

Occurs whenever a user deauthorizes an application. Sent to the related application only.

Occurs whenever an external account is created.

Occurs whenever an external account is deleted.

Occurs whenever an external account is updated.

Occurs whenever an application fee is created on a charge.

Occurs whenever an application fee is refunded, whether from refunding a charge or from refunding the application fee directly, including partial refunds.

Occurs whenever an application fee refund is updated.

Occurs whenever your Stripe balance has been updated (e.g. when a charge collected is available to be paid out). By default, Stripe will automatically transfer any funds in your balance to your bank account on a daily basis.

Occurs whenever a receiver has been created.

Occurs whenever a receiver is filled (that is, when it has received enough bitcoin to process a payment of the same amount).

Occurs whenever a receiver is updated.

Occurs whenever bitcoin is pushed to a receiver.

Occurs whenever a previously uncaptured charge is captured.

Occurs whenever a previously uncaptured charge expires.

Occurs whenever a failed charge attempt occurs.

Occurs whenever a pending charge is created.

Occurs whenever a charge is refunded, including partial refunds.

Occurs whenever a new charge is created and is successful.

Occurs whenever a charge description or metadata is updated.

Occurs when the dispute is closed and the dispute status changes to charge_refunded, lost, warning_closed, or won.

Occurs whenever a customer disputes a charge with their bank.

Occurs when funds are reinstated to your account after a dispute is closed. This includes partially refunded payments.

Occurs when funds are removed from your account due to a dispute.

Occurs when the dispute is updated (usually with evidence).

Occurs whenever a refund is updated on selected payment methods.

Occurs when a Checkout Session has been successfully completed.

Occurs whenever a coupon is created.

Occurs whenever a coupon is deleted.

Occurs whenever a coupon is updated.

Occurs whenever a credit note is created.

Occurs whenever a credit note is updated.

Occurs whenever a credit note is voided.

Occurs whenever a new customer is created.

Occurs whenever a customer is deleted.

Occurs whenever any property of a customer changes.

Occurs whenever a coupon is attached to a customer.

Occurs whenever a customer's discount is removed.

Occurs whenever a customer is switched from one coupon to another.

Occurs whenever a new source is created for the customer.

Occurs whenever a source is removed from a customer.

Occurs whenever a source will expire at the end of the month.

Occurs whenever a source's details are changed.

Occurs whenever a customer with no subscription is signed up for a plan.

Occurs whenever a customer ends their subscription.

Occurs three days before the trial period of a subscription is scheduled to end.

Occurs whenever a new Stripe-generated file is available for your account.

Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions.

Occurs whenever a draft invoice is deleted.

Occurs whenever a draft invoice is finalized and updated to be an open invoice.

Occurs whenever an invoice is marked uncollectible.

Occurs whenever an invoice payment attempt requires further user action to complete.

Occurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method.

Occurs whenever an invoice payment attempt succeeds.

Occurs whenever an invoice email is sent out.

Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your subscriptions settings. Note: The received object will not have an invoice ID.

Occurs whenever an invoice changes (e.g., the invoice amount).

Occurs whenever an invoice is voided.

Occurs whenever an invoice item is created.

Occurs whenever an invoice item is deleted.

Occurs whenever an invoice item is updated.

Occurs whenever an issuing authorization is created.

Occurs whenever an issuing authorization request is sent.

Occurs whenever an issuing authorization is updated.

Occurs whenever an issuing card is created.

Occurs whenever an issuing card is updated.

Occurs whenever an issuing cardholder is created.

Occurs whenever an issuing cardholder is updated.

Occurs whenever an issuing dispute is created.

Occurs whenever an issuing dispute is updated.

Occurs whenever an issuing transaction is created.

Occurs whenever an issuing transaction is updated.

Occurs whenever an order is created.

Occurs whenever payment is attempted on an order, and the payment fails.

Occurs whenever payment is attempted on an order, and the payment succeeds.

Occurs whenever an order is updated.

Occurs whenever an order return is created.

Occurs whenever a payment is created.

Occurs when a has funds to be captured. Check the property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an value up to the specified amount. Learn more about capturing PaymentIntents.

Occurs when a PaymentIntent is canceled.

Occurs when a new PaymentIntent is created.

Occurs when a PaymentIntent has failed the attempt to create a source or a payment.

Occurs when a PaymentIntent has been successfully fulfilled.

Occurs whenever a new payment method is attached to a customer.

Occurs whenever a card payment method's details are automatically updated by CAU.

Occurs whenever a payment method is detached from a customer.

Occurs whenever a payment method is updated via the API.

Occurs whenever a payout is canceled.

Occurs whenever a new payout is created.

Occurs whenever Stripe attempts to send a payout and that transfer fails.

Occurs whenever a payout is *expected* to be available in the destination account. If the payout fails, a notification is also sent, at a later time.

Occurs whenever a payout's metadata is updated.

Occurs whenever a person is created.

Occurs whenever a person is deleted.

Occurs whenever a person is updated.

Occurs whenever a plan is created.

Occurs whenever a plan is deleted.

Occurs whenever a plan is updated.

Occurs whenever a product is created.

Occurs whenever a product is deleted.

Occurs whenever a product is updated.

Occurs whenever an early fraud warning is created.

Occurs whenever an early fraud warning is updated.

Occurs whenever a recipient is created.

Occurs whenever a recipient is deleted.

Occurs whenever a recipient is updated.

Occurs whenever a requested failed to complete.

Occurs whenever a requested completed succesfully.

Occurs whenever a requested is updated (typically to indicate that a new day's data has come available).

Occurs whenever a review is closed. The review's reason field indicates why: approved, disputed, refunded, or refunded_as_fraud.

Occurs whenever a review is opened.

Occurs when a SetupIntent is canceled.

Occurs when a new SetupIntent is created.

Occurs when a SetupIntent has failed the attempt to setup a payment method.

Occurs when a SetupIntent has successfully setup a payment method.

Occurs whenever a Sigma scheduled query run finishes.

Occurs whenever a SKU is created.

Occurs whenever a SKU is deleted.

Occurs whenever a SKU is updated.

Occurs whenever a source is canceled.

Occurs whenever a source transitions to chargeable.

Occurs whenever a source is failed.

Occurs whenever a source mandate notification method is set to manual.

Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment.

Occurs whenever a source transaction is created.

Occurs whenever a source transaction is updated.

Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.

Occurs whenever a subscription schedule is canceled.

Occurs whenever a new subscription schedule is completed.

Occurs whenever a new subscription schedule is created.

Occurs 7 days before a subscription schedule will expire.

Occurs whenever a new subscription schedule is released.

Occurs whenever a subscription schedule is updated.

Occurs whenever a tax rate is created.

Occurs whenever a tax rate changes.

Occurs whenever a top-up is canceled.

Occurs whenever a top-up is created.

Occurs whenever a top-up fails.

Occurs whenever a top-up is reversed.

Occurs whenever a top-up succeeds.

Occurs whenever a new transfer is created.

Occurs whenever a transfer is reversed, including partial reversals.

Occurs whenever the description or metadata of a transfer is updated.

May be sent by Stripe at any time to see if a provided webhook URL is working.

Standard is the default method.

Only supported for transfers to debit cards.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Optional information related to the business.

The business type. Can be company or individual.

A hash containing the set of capabilities that was requested for this account and their associated states.

Whether the account can create live charges.

Information about the company or business. This field is null unless business_type is set to company.

The account’s country.

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

Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account’s country.

Whether this object is deleted or not.

Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

The primary user’s email address.

External accounts (bank accounts and debit cards) currently attached to this account.

Information about the person represented by the account. This field is null unless business_type is set to individual.

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.

Whether Stripe can send payouts to this account.

Information about the requirements for the account, including what information needs to be collected, and by when.

Account options for customizing how the account functions within Stripe.

Details on the acceptance of the Stripe Services Agreement.

The Stripe account type. Can be standard, express, or custom.

The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.

The customer-facing business name.

Internal-only description of the product sold or service provided by the business. It’s used by Stripe for risk and underwriting purposes.

A publicly available mailing address for sending support issues to.

A publicly available email address for sending support issues to.

A publicly available phone number to call with support issues.

A publicly available website for handling support issues.

The business’s publicly available website.

The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.

The status of the legacy payments capability of the account.

The status of the transfers capability of the account, or whether your platform can transfer funds to the account.

The company’s primary address.

The Kana variation of the company’s primary address (Japan only).

The Kanji variation of the company’s primary address (Japan only).

Whether information was collected from the company’s directors.

The company’s legal name.

The Kana variation of the company’s legal name Japan only).

The Kanji variation of the company’s legal name (Japan only).

Whether the company’s owners have been provided.

The company’s phone number (used for verification).

Whether the company’s business ID number was provided.

The jurisdiction in which the tax_id is registered (Germany-based companies only).

Whether the company’s business VAT number was provided.

Information on the verification state of the company.

A document for the company.

(ID of a ) The back of a document returned by a file upload with a purpose value of additional_verification. Expandable.

(Expanded) The back of a document returned by a file upload with a purpose value of additional_verification.

A user-displayable string describing the verification state of this document.

A machine-readable code specifying the verification state for this document. One of document_corrupt, document_failed_copy, document_not_readable, document_not_uploaded, document_failed_other, document_fraudulent, document_invalid, document_manipulated, document_too_large, or document_failed_test_mode.

(ID of a ) The front of a document returned by a file upload with a purpose value of additional_verification. Expandable.

(Expanded) The front of a document returned by a file upload with a purpose value of additional_verification.

The date the fields in currently_due must be collected by to keep payouts enabled for the account. These fields might block payouts sooner if the next threshold is reached before these fields are collected.

The fields that need to be collected to keep the account enabled. If not collected by the current_deadline, these fields are moved to past_due and the account is disabled.

If the account is disabled, this string describes why the account can’t create charges or receive payouts.

The fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to currently_due and the current_deadline is set.

The fields that weren’t collected by the currently_due. These fields need to be collected to enable payouts for the account.

Additional fields that may be required depending on the results of verification or review for provided requirements. If any of these fields become required, they appear in or .

Settings used to apply the account’s branding to email receipts, invoices, Checkout, and other products.

Settings specific to card charging on the account.

Settings used to configure the account within the Stripe dashboard.

Settings that apply across payment methods for charging on the account.

Settings specific to the account’s payouts.

(ID of a ) An icon for the account. Must be square and at least 128px x 128px. Expandable.

(Expanded) An icon for the account. Must be square and at least 128px x 128px.

(ID of a ) A logo for the account that will be used in Checkout instead of the icon and without the account’s name next to it if provided. Must be at least 128px x 128px. Expandable.

(Expanded)A logo for the account that will be used in Checkout instead of the icon and without the account’s name next to it if provided. Must be at least 128px x 128px.

A CSS hex color value representing the primary branding color for this account.

Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.

The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge. statement_descriptor_prefix is useful for maximizing descriptor space for the dynamic portion.

The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.

The timezone used in the Stripe Dashboard for this account.

Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.

Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.

The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge.

The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).

The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).

A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account.

Details on when funds from charges are available, and when they are paid out to an external account.

The text that appears on the bank account statement for payouts. If not set, this efaults to the platform’s bank descriptor as set in the Dashboard.

The number of days charges for the account will be held before being paid out.

How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.

The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.

The day of the week funds will be paid out, of the style ‘monday’, ‘tuesday’, etc. Only shown if interval is weekly.

The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative.

The IP address from which the Stripe Services Agreement was accepted by the account representative.

The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative.

Whether this object is deleted or not.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

ID of the account the capability is associated with.

Whether the capability has been requested.

Time at which the capability was requested. Measured in seconds since the Unix epoch.

Information about the requirements for this capability, including what information needs to be collected, and by when.

The status of the capability. Can be active, inactive, pending, or unrequested.

The date the fields in currently_due must be collected by to keep the capability enabled for the account.

The fields that need to be collected to keep the capability enabled. If not collected by the current_deadline, these fields appear in past_due as well, and the capability is disabled.

If the capability is disabled, this string describes why. Possible values are requirement.fields_needed, pending.onboarding, pending.review, rejected_fraud, or rejected.other.

The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in currently_due as well, and the current_deadline is set.

The fields that weren’t collected by the currently_due. These fields need to be collected to enable the capability for the account.

Additional fields that may be required depending on the results of verification or review for provided requirements. If any of these fields become required, they appear in or .

Whether this object is deleted or not.

A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a 0-decimal currency) representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency.

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

The application fee (if any) for the charge. See the Connect documentation for details.

The amount of the application application fee (if any) for the charge. See the Connect documentation for details.

ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).

Billing details of the payment method used in the payment.

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

Three-letter ISO currency code representing the currency in which the charge was made.

ID of the customer this charge is for if one exists.

The account (if any) the charge was made on behalf of, with an automatic transfer. See the Connect documentation for details.

Details about the dispute if the charge has been disputed.

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.

Hash with information on fraud assessments for the charge. Assessments reported by you have the key user_report and, if set, possible values of safe and fraudulent. Assessments from Stripe have the key stripe_report and, if set, the value fraudulent.

ID of the invoice this charge is for if one exists.

A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the charge in a structured format.

The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.

ID of the order this charge is for if one exists.

Details about the level III data associated with the Charge. This is a gated property and most integrations can not access it.

Details about whether the payment was accepted, and why.

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

ID of the payment intent this charge is for if one exists.

ID of the PaymentMethod associated with this charge.

Transaction-specific details of the payment method used in the payment.

This is the email address that the receipt for this charge was sent to.

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

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

Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

A list of refunds that have been applied to the charge.

ID of the review associated with this charge if one exists.

Shipping information for the charge.

For most Stripe users, the source of every charge is a credit or debit card. This hash is then the card object describing that card.

The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.

Extra information about a charge. This will appear on your customer’s credit card statement.

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.

ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Bank-State-Branch number of the bank account.

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

Last four digits of the bank account number.

ID of the mandate used to make this payment.

Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown.

Check results by Card networks on Card address and CVC at time of payment.

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

Two-digit number representing the card’s expiration month.

Four-digit number representing the card’s expiration year.

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.

Card funding type. Can be credit, debit, prepaid, or unknown.

The last four digits of the card.

True if this payment was marked as MOTO and out of scope for SCA.

Populated if this transaction used 3D Secure authentication.

If this Card is part of a card wallet, this contains the details of the card wallet.

Whether or not authentication was performed. 3D Secure will succeed without authentication when the card is not enrolled.

Whether or not 3D Secure succeeded.

The version of 3D Secure that was used for this payment.

Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. The value reversed_after_approval indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as “pending” on a cardholder’s statement.

An enumerated value indicating a more detailed explanation of the outcome’s type. See understanding declines for details.

Stripe’s evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100.

The ID of the Radar rule that matched the payment, if applicable.

A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.

Possible values are authorized, issuer_declined, blocked, and invalid. See understanding declines for details.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Specify whether Checkout should collect the customer’s billing address. If set to required, Checkout will always collect the customer’s billing address. If left blank or set to auto Checkout will only collect the billing address when necessary.

The URL the customer will be directed to if they decide to go back to your website.

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar. It is included in the checkout.session.completed webhook and can be used to fulfill the purchase.

ID of the customer this Session is for if one exists.

Customer this Session is for (if it was expanded).

The email address used to create the customer object.

The line items, plans, or SKUs that were purchased by the customer.

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

The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser’s locale is used.

The mode of the Checkout Session which can be payment, setup, or subscription.

The ID of the PaymentIntent created if SKUs or line items were provided.

PaymentIntent created if SKUs or line items were provided (if it was expanded).

The list of payment method types (e.g. card) that this Checkout Session is allowed to use.

The ID of the SetupIntent created if mode was set to setup.

The SetupIntent created if mode was set to setup (if it was expanded).

The ID of the subscription created if one or more plans were provided.

The subscription created if one or more plans were provided (if it was expanded).

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 using line items or a SKU, and not checkout sessions for subscriptions. Supported values are auto, book, donate, or pay.

The URL the customer will be directed to after a successful payment.

The URL the customer will be directed to if they decide to go back to your website.

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar. It is included in the checkout.session.completed webhook and can be used to fulfill the purchase.

The email address used to create the customer object. If you already know your customer’s email address, use this attribute to prefill it on Checkout.

ID of the customer this Checkout Session is for if one exists. May only be used with LineItems. Usage with SubscriptionData is not yet available.

A list of items your customer is purchasing.

The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser’s locale is used.

The mode of the Checkout Session which can be payment, setup, or subscription.

A subset of parameters to be passed to PaymentIntent creation.

The list of payment method types (e.g. card) that this Checkout Session is allowed to use.

A subset of parameters to be passed to SetupIntent creation.

A subset of parameters to be passed to subscription creation.

The URL the customer will be directed to after a successful payment.

The amount to be collected per unit of the line item.

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

The description for the line item.

A list of images representing this line item.

The name for the line item.

Quantity of the line item being purchased.

The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner’s Stripe account.

Capture method of this PaymentIntent, one of automatic or manual.

An arbitrary string attached to the object. Often useful for displaying to users.

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.

The Stripe account ID for which these funds are intended.

Email address that the receipt for the resulting payment will be sent to.

Indicates that you intend to make future payments with this PaymentIntent’s payment method. If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes. Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. Stripe uses this to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to make later off-session payments for this customer.

Shipping information for this payment.

Extra information about the payment. This will appear on your customer’s statement when this payment succeeds in creating a charge.

The parameters used to automatically create a Transfer when the payment succeeds.

An arbitrary string attached to the object. Often useful for displaying to users.

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.

The Stripe account ID for which the Session is going to set up a PaymentMethod for.

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account. The request must be made with an OAuth key in order to set an application fee percentage. For more information, see the application fees documentation.

List of items, each with an attached plan.

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.

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48h in the future.

Indicates if a plan’s should be applied to the subscription. Setting TrialEnd on DubscriptionData is preferred. Defaults to false.

Integer representing the number of trial period days before the customer is charged for the first time.

Amount for the display item.

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

Details about the display item if it's of type custom.

The Plan if the display item is of type plan.

Quantity of the display item being purchased.

The Sku if the display item is of type sku.

The type of display item.

The description of the line item.

The images of the line item.

The name of the line item.

Whether this object is deleted or not.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Credit note amount.

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.

ID of the customer associated with that credit note.

ID of the customer balance transaction related to this credit note.

ID of the invoice associated with that credit note.

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

Credit note memo.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

Credit note number.

The link to download the PDF of the credit note.

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.

ID of the refund associated with that credit note.

Status of this credit note, one of issued or void.

Type of this credit note, one of post_payment or pre_payment.

The time that the credit note was voided.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

The amount of the transaction. A negative value is a credit for the customer’s balance, and a positive value is a debit to the customer’s balance.

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

ID of the credit note associated with that customer balance transaction.

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

ID of the customer associated with this customer balance transaction.

An arbitrary string attached to the object. Often useful for displaying to users.

The customer’s balance after the transaction was applied. A negative value decrease the amount due on the customer’s next invoice. A positive value increase the amount due on the customer’s next invoice.

ID of the invoice this charge is for if one exists.

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

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.

Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_too_large, invoice_too_small, or unspent_receiver_credit.

The customer’s address.

Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

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

The currency the customer can be charged in for recurring billing purposes.

ID of the default source attached to this customer.

Warning: this is not in the documentation.

Whether this object is deleted or not.

Whether or not the latest charge for the customer’s latest invoice has failed.

An arbitrary string attached to the object. Often useful for displaying to users.

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

The customer’s email address.

The prefix for the customer used to generate unique invoice numbers.

The customer’s default invoice settings.

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

A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

The customer’s full name or business name.

The customer’s phone number.

The customer’s preferred locales (languages), ordered by preference.

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

The customer’s payment sources, if any.

The customer’s current subscriptions, if any.

Describes the customer’s tax exemption status. One of none, exempt, or reverse.

The customer’s current tax ids, if any.

Default custom fields to be displayed on invoices for this customer.

ID of the default payment method for the customer.

Default footer to be displayed on invoices for this customer.

Whether this object is deleted or not.

(ID of a ) Your subscription cancellation policy, as shown to the customer. Expandable.

(Expanded) Your subscription cancellation policy, as shown to the customer.

(ID of a ) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. Expandable.

(Expanded) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.

(ID of a ) A relevant document or contract showing the customer’s signature. Expandable.

(Expanded) A relevant document or contract showing the customer’s signature.

(ID of a ) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. Expandable.

(Expanded) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.

(ID of a ) Any receipt or message sent to the customer notifying them of the charge. Expandable.

(Expanded) Any receipt or message sent to the customer notifying them of the charge.

(ID of a ) Your refund policy, as shown to the customer. Expandable.

(Expanded) Your refund policy, as shown to the customer.

(ID of a ) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. Expandable.

(Expanded) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.

(ID of a ) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer’s full shipping address, if possible. Expandable.

(Expanded) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer’s full shipping address, if possible.

(ID of a ) Any additional evidence or statements. Expandable.

(Expanded) Any additional evidence or statements.

Whether this object is deleted or not.

is the raw JSON data of the response that was used to initialize this ephemeral key. When working with mobile clients that might only understand one version of the API you should prefer to send this value back to them so that they'll be able to decode an object that's current according to their version.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

For Connect events, the identifier of the account that emitted the event.

The Stripe API version used to render data.

Note: This property is populated only for events on or after October 31, 2014.

Time at which the object was created.

Object containing data associated with the event.

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

Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you’ve specified.

Information on the API request that instigated the event.

Description of the event (e.g., invoice.created or charge.refunded).

Object containing the API resource relevant to the event. For example, an invoice.created event will have a full invoice object () as the value of the object key.

Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events).

This contains the same data as , but untyped. This is occasionally useful, e.g. when working with an API resource for which the Stripe.net library does not have a concrete type.

ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe’s automatic subscription handling). Request logs are available in the dashboard, but currently not in the API.

The idempotency key transmitted during the request, if any.

Note: This property is populated only for events on or after May 23, 2017.

Represents a generic expandable field.

Type of the field when expanded.

Gets or sets the ID.

The ID. Trying to set when is already set.

Gets or sets the expanded object.

The expanded object.

Time at which the object was created.

Whether this link is already expired.

Time at which the link expires.

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

ID of the file object this link points to.

The file object this link points to (if expanded).

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.

The publicly accessible URL to download the file.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

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

ID of the customer who will be billed when this invoice item is billed.

The customer who will be billed when this invoice item is billed (if it was expanded).

Date at which the invoice item was created.

Whether this object is deleted or not.

An arbitrary string attached to the object. Often useful for displaying to users.

If true, discounts will apply to this invoice item. Always false for prorations.

ID of the invoice this invoice item belongs to.

The invoice this invoice item belongs to (if it was expanded).

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

A set of key/value pairs that you can attach to a subscription object.

Period this invoice item was created for.

If the invoice item is a proration, the plan of the subscription that the proration was computed for.

Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

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.

ID of the subscription that this invoice item has been created for, if any.

The subscription that this invoice item has been created for, if any (if it was expanded).

ID of the subscription item associated with this invoice item.

The tax rates which apply to the invoice item. When set, the on the invoice do not apply to this invoice item.

For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.

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

Same as , but contains a decimal value with at most 12 decimal places.

The country of the business associated with this invoice, most often the business creating the invoice.

The public name of the business associated with this invoice, most often the business creating the invoice.

The amount of the application application fee (if any) for the invoice. See the Connect documentation for details.

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. Defaults to charge_automatically.

The customer’s address. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s email. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s name. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s phone number. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s shipping information. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s tax exempt status. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

The customer’s tax ids. Until the invoice is finalized, this field will equal . Once the invoice is finalized, this field will no longer be updated.

ID of the default payment method for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default payment method, if any, or to the customer’s default payment method.

Tax rates applied to the invoice.

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

A unique, identifying string that appears on emails sent to the customer for this invoice.

ID of the PaymentIntent associated with this invoice.

The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.

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

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

If is set to subscription_threshold this returns more information on which threshold rules triggered the invoice.

The tax amounts which apply to this invoice.

Type of the tax ID, one of eu_vat, nz_gst, au_abn, or unknown.

The value of the tax ID.

The tax amounts which apply to this line item.

Tax rates applied to this line item.

Set to true if we grouped proration items into one, false if not.

The amount, in cents, of the tax.

This specifies if the tax rate is inclusive or exclusive.

The ID of the tax rate that was applied to get this tax amount.

The total invoice amount threshold boundary if it triggered the threshold invoice.

Indicates which line items triggered a threshold invoice.

The IDs of the line items that triggered the threshold invoice.

The quantity threshold boundary that applied to the given line item.

One of match, mismatch, or not_provided.

One of success, failure, exempt, or none.

One of match, mismatch, or not_provided.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

The cardholder’s billing address.

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

The cardholder’s email address.

Whether or not this cardholder is the default cardholder.

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

A set of key/value pairs that you can attach to a subscription object.

The cardholder’s name. This will be printed on cards issued to them.

The cardholder’s phone number.

Information about verification requirements for the cardholder, including what information needs to be collected.

One of active, inactive, or blocked.

One of individual or business_entity.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Spending rules that give you some control over how your cards can be used.

The brand of the card.

The Cardholder object to which the card belongs.

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

The expiration month of the card.

The expiration year of the card.

The last 4 digits of the card number.

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

A set of key/value pairs that you can attach to a subscription schedule object.

The name of the cardholder, printed on the card.

Metadata about the PIN on the card.

ID of the that this card replaces.

(Expanded) The that this card replaces.

Why the card that this card replaces (if any) needed to be replaced. One of damage, expiration, loss, or theft.

Where and how the card will be shipped.

One of active, inactive, canceled, lost, stolen, or pending.

One of virtual or physical.

The status of the pin. One of blocked or active.

A categorization of the seller’s type of business.

City where the seller is located.

Country where the seller is located.

Name of the seller.

Identifier assigned to the seller by the card brand.

Postal code where the seller is located.

State where the seller is located.

The url an online purchase was made from.

If the cardholder is disabled, this string describes why. Can be one of listed, rejected.listed, or under_review.

If not empty, this field contains the list of fields that need to be collected in order to verify and re-enable the cardholder.

The unique id of the account you have revoked access to, as a string. This is the same as the you passed in. If this is returned, the revocation was successful.

The access token you can use to make requests on behalf of this Stripe account. Use it as you would any Stripe secret API key. This key does not expire, but may be revoked by the user at any time (you'll get a account.application.deauthorized webhook event when this happens).

This property is deprecated. In backend code, it is recommended that you use your own secret key in conjunction with the connected account's ID found in .

The live mode indicator for the token. If true, the can be used as a live secret key. If false, the can be used as a test secret key. Depends on the mode of the secret API key used to make the request.

Can be used to get a new access token of an equal or lesser scope, or of a different live mode (where applicable).

This property is deprecated. In backend code, it is recommended that you don't use access tokens or refresh tokens at all. Instead, you should use your own secret key in conjunction with the connected account's ID found in .

The scope granted to the access token, depending on the scope of the authorization code and scope parameter.

A publishable key that can be used with this account. Matches the mode—live or test—of the token.

This property is deprecated. In frontend code, it is recommended that you use your own publishable key in conjunction with the connected account's ID found in .

The unique id of the account you have been granted access to, as a string.

Will always have a value of bearer.

If type is "exact", date will be the expected delivery date in the format YYYY-MM-DD.

If type is "range", earliest will be be the earliest delivery date in the format YYYY-MM-DD.

If type is "range", latest will be the latest delivery date in the format YYYY-MM-DD.

The type of estimate. Must be either "range" or "exact".

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the order.

ID of the Connect Application that created the order.

The ID of the payment used to pay for the order. Present if the order status is paid, fulfilled, or refunded. Expandable.

Time at which the object was created.

3-letter ISO code representing the currency in which the order was made.

The customer used for the order.

The email address of the customer placing the order.

List of items constituting the order.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

The shipping method that is currently selected for this order, if any. If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.

The shipping address for the order. Present if the order is for goods to be shipped.

A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.

Current order status. One of created, paid, canceled, fulfilled, or returned.

The timestamps at which the order status was updated.

The merchant’s order ID if it is different from the Stripe order ID.

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the line item.

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

Description of the line item, meant to be displayable to the user (e.g., "Express shipping").

ID of the parent associated with this order item.

A positive integer representing the number of instances of parent that are included in this order item. Applicable/present only if type is sku.

The type of line item. One of sku, tax, shipping, or discount.

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the returned line item.

3-letter ISO code representing the currency of the return.

The items included in this order return.

The order that this return includes items from. Expandable.

The ID of the refund issued for this return. Expandable.

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the line item.

3-letter ISO code representing the currency of the line item.

The estimated delivery date for the given shipping method. Can be either a specific date or a range.

Description of the line item, meant to be displayable to the user (e.g., "Express shipping").

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Amount intended to be collected by this PaymentIntent.

Amount that can be captured from this PaymentIntent.

Amount that was collected by this PaymentIntent.

ID of the Connect application that created the PaymentIntent.

The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.

Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

One of automatic (default) or manual. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment. Change the capture method to manual if you wish to separate authorization and capture for payment methods that support this.

Charges that were created by this PaymentIntent, if any.

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Please refer to our automatic confirmation quickstart guide to learn about how client_secret should be handled.

One of automatic (default) or manual. When the confirmation method is automatic, a PaymentIntent can be confirmed using a publishable key. After next actions are handled, no additional confirmation is required to complete the payment. When the confirmation method is manual, all payment attempts must be made using a secret key. The PaymentIntent returns to the requires_confirmation state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.

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.

ID of the Customer this PaymentIntent belongs to, if one exists. If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.

An arbitrary string attached to the object. Often useful for displaying to users.

ID of the invoice that created this PaymentIntent, if one exists.

The payment error encountered in the previous PaymentIntent confirmation.

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

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.

ID of the payment method used in this PaymentIntent.

Payment-method-specific configuration for this PaymentIntent.

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

Email address that the receipt for the resulting payment will be sent to.

ID of the review associated with this PaymentIntent, if any.

Shipping information for this PaymentIntent.

ID of the Source associated with this PaymentIntent, if any.

Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

Contains instructions for authenticating a payment by redirecting your customer to another page or application.

Type of the next action to perform, one of redirect_to_url or use_stripe_sdk.

If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.

The URL you must redirect your customer to in order to authenticate the payment.

If the PaymentIntent’s supported payment method types include card, this hash contains the configurations that will be applied to each payment attempt of that type.

We strongly recommend that you rely on our SCA engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request authentication based on logic from your own fraud engine, provide this option. Permitted values include: automatic, any, or challenge_only.

The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.

ID of the account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

ID of the customer this charge is for if one exists.

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

The day of birth, between 1 and 31.

The month of birth, between 1 and 12.

The four-digit year of birth.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

The account the person is associated with.

The person’s address.

The Kana variation of the person’s address (Japan only).

The Kanji variation of the person’s address (Japan only).

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

Whether this object is deleted or not.

The person’s date of birth.

The person’s email address.

The person’s first name.

The Kana variation of the person’s first name (Japan only).

The Kanji variation of the person’s first name (Japan only).

The person’s gender (International regulations require either “male” or “female”).

Whether the person’s id_number was provided.

The person’s last name.

The Kana variation of the person’s last name (Japan only).

The Kanji variation of the person’s last name (Japan only).

The person’s maiden name.

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.

The person’s phone number.

Describes the person’s relationship to the account.

Information about the requirements for this person, including what information needs to be collected, and by when.

Whether the last 4 digits of this person’s SSN have been provided.

The persons’s verification status.

Whether the person is a director of the account’s legal entity..

Whether the person has significant responsibility to control, manage, or direct the organization.

Whether the person is an owner of the account’s legal entity..

The percent owned by the person of the account’s legal entity.

Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.

The person’s title (e.g., CEO, Support Engineer).

Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s current_deadline, these fields are moved to past_due and the account is disabled.

Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to currently_due and the account’s current_deadline is set.

Fields that weren’t collected by the account’s current_deadline. These fields need to be collected to enable payouts for the person’s account.

Additional fields that may be required depending on the results of verification or review for provided requirements. If any of these fields become required, they appear in or .

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

A user-displayable string describing the verification state for this person. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.

A machine-readable code specifying the verification state for this person. One of document_name_mismatch, failed_keyed_identity, or failed_other.

An identifying document for this individual, either a passport or local ID card.

The state of verification for this person. Possible values are unverified, pending, or verified.

(ID of a ) The back of an ID returned by a file upload with a purpose value of identity_document. Expandable.

(Expanded) The back of an ID returned by a file upload with a purpose value of identity_document.

A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.

A machine-readable code specifying the verification state for this document.

(ID of a ) The front of an ID returned by a file upload with a purpose value of identity_document. Expandable.

(Expanded) The front of an ID returned by a file upload with a purpose value of identity_document.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Whether the plan is currently available for new subscriptions.

Specifies a usage aggregation strategy for plans where is metered. Allowed values are sum for summing up all usage during a period, last_during_period for picking the last usage record reported within a period, last_ever for picking the last usage record ever (across period bounds) or max which picks the usage record with the maximum reported usage during a period. Defaults to sum.

The amount in cents to be charged on the interval specified.

Same as , but contains a decimal value with at most 12 decimal places.

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

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.

Whether this object is deleted or not.

One of day, week, month or year. The frequency with which a subscription should be billed.

The number of intervals (specified in the interval property) between subscription billings.

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

A set of key/value pairs that you can attach to a subscription object.

A brief description of the plan, hidden from customers.

ID of the product linked to this plan.

The product linked to this plan (if it was expanded).

Each element represents a pricing tier. This parameter requires to be set to tiered.

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.

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

Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

Configures how the quantity per period should be determined, can be either metered or licensed. licensed will automatically bill the quantity set for a plan when adding it to a subscription, metered will aggregate the total usage based on usage records. Defaults to licensed.

Price for the entire tier.

Same as , but contains a decimal value with at most 12 decimal places.

Per unit price for units relevant to the tier.

Same as , but contains a decimal value with at most 12 decimal places.

Up to and including to this quantity will be contained in the tier.

Whether or not the product is currently available for purchase.

A list of up to 5 attributes that each SKU can provide values for (e.g. ["color", "size"]).

A short one-line description of the product, meant to be displayable to the customer.

Time at which the object was created.

An array of connect application identifiers that cannot purchase this product.

Whether this object is deleted or not.

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

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

Flag indicating whether the object exists in live mode or test mode.

Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

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

The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own package_dimensions.

Whether this product is a shipped good.

What appears on a customer's credit card statement.

The type of the Product. Either 'good' or 'service'.

This represents a unit of this product, such as a seat or API call, on customers' receipts and invoices.

A URL of a publicly-accessible webpage for this product.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.

ID of the charge this early fraud warning is for.

Time at which the object was created.

The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.

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

A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the charge in a structured format.

Only return early fraud warnings for the charge specified by this charge ID.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

ID of the Connect application that created the SetupIntent.

Reason for canceling this SetupIntent. Possible values are abandoned, requested_by_customer, or duplicate.

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

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

ID of the Customer this SetupIntent belongs to, if one exists. If present, payment methods used with this SetupIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this SetupIntent.

An arbitrary string attached to the object. Often useful for displaying to users.

The error encountered in the previous SetupIntent confirmation.

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

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

If present, this property tells you what actions you need to take in order for your customer to continue payment setup.

ID of the account (if any) for which the setup is intended.

ID of the payment method used with this SetupIntent.

Payment-method-specific configuration for this SetupIntent.

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

Indicates how the payment method is intended to be used in the future. Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.

If the SetupIntent’s payment method types include card, this hash contains the configurations that will be applied to each setup attempt of that type.

Whether or not the SKU is available for purchase.

A dictionary of attributes and values for the attributes defined by the product. If, for example, a product’s attributes are ["size", "gender"], a valid SKU has the following dictionary of attributes: {"size": "Medium", "gender": "Unisex"}.

Time at which the object was created.

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

Whether this object is deleted or not.

The URL of an image for this SKU, meant to be displayable to the customer.

Description of the SKU’s inventory.

Flag indicating whether the object exists in live mode or test mode.

Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

The dimensions of this SKU for shipping purposes.

The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a 0-decimal currency).

The ID of the product this SKU is associated with. The product must be currently active.

Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument and can be used with the Source API just like a card object: once chargeable, they can be charged, or attached to customers.

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single-use sources.

The client secret of the source. Used for client-side polling using a publishable key.

Information related to the code verification flow. Present if the source is authenticated by a verification code (flow is code_verification).

The currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single-use sources.

The customer to which the source is attached, if any.

The authentication flow of the source. Flow is one of redirect, receiver, code_verification, none.

A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about the source in a structured format.

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

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

Information related to the receiver flow. Present if the source is a receiver (flow is receiver).

Information related to the redirect flow. Present if the source is authenticated by a redirect (flow is redirect).

Extra information about a source. This will appear on your customer’s statement every time you charge the source.

The status of the charge, one of canceled, chargeable, consumed, failed, or pending. Only chargeable source objects can be used to create a charge.

The type of the source. The type is a payment method, one of card, three_d_secure, giropay, sepa_debit, ideal, klarna, sofort, or bancontact.

One of reusable, single-use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while other may leave the option at creation. If an incompatible value is passed, an error will be returned.

The number of attempts remaining to authenticate the source object with a verification code.

The status of the code verification, either pending, succeeded or failed.

Owner’s address.

Owner’s email address.

Owner’s full name.

Owner’s phone number (including extension).

Verified owner's address.

Verified owner’s email address.

Verified owner’s full name.

Verified owner’s phone number (including extension).

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

The total amount charged by you. The amount charged is expressed in the source’s currency.

The total amount received by the receiver source. AmountReceived = AmountReturned + AmountCharged is true at all times. The amount received is expressed in the source’s currency.

The total amount that was returned to the customer. The amount returned is expressed in the source’s currency.

The failure reason for the redirect. One of .

The URL you provide to redirect the customer to after they authenticated their payment.

The status of the redirect, either not_required, pending, succeeded or failed.

The URL provided to you to redirect a customer to as part of a redirect authentication flow.

A positive integer representing the total amount for the order.

The currency associated with the order.

The email address of the customer placing the order.

List of items constituting the order.

The shipping address for the order. Present if the order is for goods to be shipped.

The amount (price) for this order item.

This currency of this order item. Required when amount is present.

Human-readable description for this order item.

The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.

The type of this order item.

If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.

Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

The card used to create this 3DS source.

Two-letter ISO code representing the country of the card.

The ID of the customer to which the card belongs, if any.

If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

This is an internal property that is not returned in standard API requests.

(For tokenized numbers only.) The last four digits of the device account number.

The expiration month of the card.

The expiration year of the card.

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.

Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

This is an internal property that is not returned in standard API requests.

The last 4 digits of the card number.

The card's 3D Secure support status. Can be one of `not_supported`, `required`, `recommended` or `optional`.

If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `android_pay`.

For card errors, the ID of the failed charge.

For some errors that could be handled programmatically, a short string indicating the error code reported.

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline.

A URL to more information about the error code reported.

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

The object for errors returned on a request involving a .

The source object for errors returned on a request involving a source.

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error.

A string describing the object type returned.

A list containing the actual response elements, paginated by any request parameters.

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

The URL for accessing this list.

Whether this object is deleted or not.

The tax rates which apply to the subscription item.

Usage threshold that triggers the subscription to create an invoice.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

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.

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

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

Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

ID of the associated with the subscription schedule. Expandable.

(Expanded) The associated with the subscription schedule.

ID of the default payment method for the subscription schedule.

ID of the default source for the subscription schedule.

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are cancel, none, release and renew.

The schedule's default invoice settings.

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

A set of key/value pairs that you can attach to a subscription schedule object.

Configuration for the subscription schedule’s phases.

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

ID of the subscription once managed by the subscription schedule (if it is released).

Behavior of the subscription schedule and underlying subscription when it ends.

Interval and duration at which the subscription schedule renews for when it ends if renewal_behavior is renew.

Possible values are active, canceled, completed, not_started, released and renewal_behavior.

ID of the associated with the subscription schedule. Expandable.

(Expanded) The associated with the subscription schedule.

The end of the this phase of the subscription schedule.

The start of this phase of the subscription schedule.

The number of days from which the invoice is created until it is due.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

ID of the associated with this phase for the subscription schedule. Expandable.

(Expanded) The associated with this phase for the subscription schedule.

ID of the default payment method for the subscription schedule.

The default tax rates which apply to the phase of this subscription schedule.

The end of this phase of the subscription schedule.

The default invoice settings for this phase.

Plans to subscribe during this phase of the subscription schedule.

The start of this phase of the subscription schedule.

If provided, each invoice created during this phase of the subscription schedule will apply the tax rate, increasing the amount billed to the customer.

When the trial ends within the phase.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

ID of the included in the phase for this subscription schedule. Expandable.

(Expanded) The included in the phase for this subscription schedule.

Quantity of the plan to which the customer should be subscribed.

The tax rates which apply to this specific item on the phase for a subscription schedule.

Interval at which to renew the subscription schedule for when it ends.

Number of intervals to renew the subscription schedule for when it ends.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

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

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

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.

ID of the customer who owns the subscription.

Customer who owns this subscription (if it was expanded).

Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where billing=charge_automatically.

ID of the default payment method for the subscription.

Default payment method for the subscription (if it was expanded).

ID of the default source for the subscription.

Default source for the subscription (if it was expanded).

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.

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

List of subscription items, each with an attached plan.

ID of the most recent invoice this subscription has generated.

The most recent invoice this subscription has generated (if it was expanded).

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

A set of key/value pairs that you can attach to a subscription object.

ID of the pending SetupIntent associated with this subscription.

The pending SetupIntent associated with this subscription (if it was expanded).

Plan the customer is subscribed to. Only set if the subscription contains a single plan.

The quantity of the plan to which the customer is subscribed. Only set if the subscription contains a single plan.

ID of the schedule attached to the subscription.

Schedule attached to the subscription (if it was expanded).

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 specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

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

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

Monetary threshold that triggers the subscription to advance to a new billing period.

Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Two-letter ISO code representing the country of the tax ID.

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

ID of the customer this tax ID is for if one exists.

Whether this object is deleted or not.

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

Type of the tax ID, one of au_abn, eu_vat, in_gst, no_vat, nz_gst, or unknown.

Value of the tax ID.

The persons’s verification status.

Verification status, one of pending, unavailable, unverified, or verified.

The official address associated with the tax ID returned from the external provider.

The official name associated with the tax ID returned from the external provider.

Unique identifier for the object.

String representing the object’s type. Objects of the same type share the same value.

Whether the tax rate is currently available for new subscriptions.

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

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

This specifies if the tax rate is inclusive or exclusive.

The jurisdiction for the tax rate.

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

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.

This represents the tax rate percent out of 100.

Whether this object is deleted or not.

Filters readers by device type.

A location ID to filter the response list to only readers at the specific location.

A status filter to filter readers to only offline or online readers. Possible values are offline and online.

A positive integer in the smallest currency unit (e.g., 100 cents to top up $1.00 or 100 to topup ¥100, a 0-decimal currency) representing how much to top up. The minimum amount is $0.50 US or equivalent in Top-up currency.

ID of the balance transaction that describes the impact of this Top-up on your account balance (not including refunds or disputes).

Three-letter ISO currency code representing the currency in which the Top-up was made.

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

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

A set of key/value pairs that you can attach to a topup object. It can be useful for storing additional information about the topup in a structured format.

For most Stripe users, the source of every Top-up is a bank account. This hash is then the source object describing that bank account.

Extra information about a topup. This will appear on your customer’s credit card statement.

The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

A string that identifies this top-up as part of a group.

Deserializes the JSON to a Stripe object type. The type is automatically deduced from the object key in the JSON string.

The object to deserialize. The deserialized Stripe object from the JSON string.

Deserializes the JSON to the specified Stripe object type.

The type of the Stripe object to deserialize to. The object to deserialize. The deserialized Stripe object from the JSON string.

Reports a Stripe object as a string.

A string representing the Stripe object, including its JSON serialization.

Serializes the Stripe object as a JSON string.

An indented JSON string represensation of the object.

Sets a string ID on an expandable field. If the expandable field does not exist, a new one is initialized. If the expandable field exists and already contains an expanded object, and the ID within the expanded object does not match the new string ID, expanded object is discarded.

Type of the expanded object. The string ID. The expandable field. The expandable field with its ID set to the provided string ID.

Sets an expanded object on an expandable field. If the expandable field does not exist, a new one is initialized.

Type of the expanded object. The expanded object. The expandable field. The expandable field with its expanded object set to the provided object.

Deserializes the JSON to a Stripe object type.

The object to deserialize. The deserialized Stripe object from the JSON string.

Resources that implement this interface can appear as sources in balance transactions. Possible concrete classes:

Represents a non-generic expandable field.

Gets or sets the ID.

The ID.

Gets or sets the expanded object.

The expanded object.

Gets a value indicating whether the is expanded.

true if the is expanded; otherwise, false.

Represents a generic expandable field.

Type of the field when expanded.

Gets or sets the expanded object.

The expanded object.

Resources that implement this interface can be used as external accounts, i.e. they can be attached to a Stripe account to receive payouts. Possible concrete classes:

Interface that identifies entities returned by Stripe that have an `id` attribute.

Unique identifier for the object.

Interface that identifies entities with a Metadata property of type .

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.

Interface that identifies entities returned by Stripe that have an `object` attribute.

String representing the object's type. Objects of the same type share the same value.

Resources that implement this interface can be used as payment sources when creating charges. Possible concrete classes:

Interface that identifies all entities returned by Stripe.

An enum describing the reason for a failed redirect.

Indicates that the authentication failed or the transaction was declined.

Indicates that the redirect failed due to a technical error.

Indicates that the user aborted or dropped out of the redirect flow.

Used to indicate that a particular property is allowed to have a name that isn't a strict snake_case -> CamelCase conversion from the JSON name defined its property.

This is only used for an internal wholesome test.

This class provides methods to serialize various objects with application/x-www-form-urlencoded encoding. This is used to encode request parameters to be sent to Stripe's API.

Creates an for a given options class.

The options class. The .

Creates the HTTP query string for a given options class.

The options class. The query string.

Creates the HTTP query string for a collection of name/value tuples.

The collection of name/value tuples. The query string.

URL-encodes a string.

The string to URL-encode. The URL-encoded string.

Returns a list of parameters for a given value. The value can be basically anything, as long as it can be encoded in some way.

The value for which to create the list of parameters. The key under which new keys should be nested, if any. The list of parameters.

Returns a list of parameters for a given instance.

The instance for which to create the list of parameters. The key under which new keys should be nested, if any. The list of parameters.

Returns a list of parameters for a given options class. If a key prefix is provided, the keys for the new parameters will be nested under the key prefix. E.g. if the key prefix `foo` is passed and the options class contains a parameter `bar`, then a parameter with key `foo[bar]` will be returned.

The options class for which to create the list of parameters. The key under which new keys should be nested, if any. The list of parameters.

Returns a list of parameters for a given dictionary. If a key prefix is provided, the keys for the new parameters will be nested under the key prefix. E.g. if the key prefix `foo` is passed and the dictionary contains a key `bar`, then a parameter with key `foo[bar]` will be returned.

The dictionary for which to create the list of parameters. The key under which new keys should be nested, if any. The list of parameters.

Returns a list of parameters for a given list of objects. The parameter keys will be indexed under the `keyPrefix` parameter. E.g. if the `keyPrefix` is `foo`, then the key for the first element's will be `foo[0]`, etc.

The list for which to create the list of parameters. The key under which new keys should be nested. The list of parameters.

Creates a list containing a single parameter.

The parameter's key. The parameter's value. A list containg the single parameter.

Computes the new key prefix, given a key and an existing prefix (if any). E.g. if the key is `bar` and the existing prefix is `foo`, then `foo[bar]` is returned. If a key already contains nested values, then only the non-nested part is nested under the prefix, e.g. if the key is `bar[baz]` and the prefix is `foo`, then `foo[bar][baz]` is returned. If no prefix is provided, the key is returned unchanged.

The key. The existing key prefix, if any. The new key prefix.

A container for name/value tuples encoded using application/x-www-form-urlencoded MIME type.

Initializes a new instance of the class.

The collection of name/value tuples to encode.

Gets the content type for a given file extension.

The file extension. The content type, or application/octet-stream if the file extension is unknown.

A container for content encoded using multipart/form-data MIME type.

Initializes a new instance of the class.

The collection of name/value tuples to encode.

Initializes a new instance of the class.

The collection of name/value tuples to encode. The boundary string for the multipart form data content.

Converts a to and from JSON.

Gets a value indicating whether this can write JSON.

true if this can write JSON; otherwise, false.

Writes the JSON representation of the object.

The to write to. The value. The calling serializer.

Reads the JSON representation of the object.

The to read from. Type of the object. The existing value of object being read. The calling serializer. The object value.

Determines whether this instance can convert the specified object type.

Type of the object. true if this instance can convert the specified object type; otherwise, false.

This converter is used to deserialize event objects regardless of which API version they're formatted with. In the general case, Stripe.net uses a specific API version (), but events are a special case: when receiving an event object via a webhook notification, the object will be formatted with the Stripe account's default API version which may be different than Stripe.net's API version.

Gets a value indicating whether this can write JSON.

true if this can write JSON; otherwise, false.

Writes the JSON representation of the object.

The to write to. The value. The calling serializer.

Reads the JSON representation of the object.

The to read from. Type of the object. The existing value of object being read. The calling serializer. The object value.

Determines whether this instance can convert the specified object type.

Type of the object. true if this instance can convert the specified object type; otherwise, false.

Converts a to and from JSON.

Type of the field when expanded.

Gets a value indicating whether this can write JSON.

true if this can write JSON; otherwise, false.

Writes the JSON representation of the object.

The to write to. The value. The calling serializer.

Reads the JSON representation of the object.

The to read from. Type of the object. The existing value of object being read. The calling serializer. The object value.

Determines whether this instance can convert the specified object type.

Type of the object. true if this instance can convert the specified object type; otherwise, false.

This converter can be used to deserialize any Stripe object. It is mainly useful for polymorphic attributes, when the property's type is an interface instead of a concrete type. In this case, the converter will use the value of the `object` key in the JSON payload to decide which concrete type to instantiate. If no concrete type is found (or if one is found, but it's not compatible with the expected interface), then the converter returns `null`.

Gets a value indicating whether this can write JSON.

true if this can write JSON; otherwise, false.

Writes the JSON representation of the object.

The to write to. The value. The calling serializer.

Reads the JSON representation of the object.

The to read from. Type of the object. The existing value of object being read. The calling serializer. The object value.

Determines whether this instance can convert the specified object type.

Type of the object. true if this instance can convert the specified object type; otherwise, false.

Converts the string to snake case.

The string to convert. A string with the contents of the input string converted to snake_case.

Determines whether the two specified objects have the same value. The comparison is done in constant time to prevent timing attacks.

The first string to compare. The second string to compare. true if the value of the a parameter is equal to the value of the b parameter; otherwise, false.

Checks whether a string contains any whitespace characters or not.

The string to check. true if the string contains any whitespace characters; otherwise, false. Thrown if str is null.

Dictionary mapping the values contained in the `object` key of JSON payloads returned by Stripe's API to concrete types of model classes.

Returns the concrete type to use, given a potential type and the value of the `object` key in a JSON payload.

Potential type. Can be a concrete type or an interface. Value of the `object` key in the JSON payload. The concrete type to use, or `null`.

Contains information about the "app" which this integration belongs to. This should be reserved for plugins that wish to identify themselves with Stripe.

Gets or sets the name of your application (e.g. "MyAwesomeApp").

Gets or sets your Stripe Partner ID (e.g. "pp_partner_1234"), if you have one.

Gets or sets the version of your application (e.g. "1.2.34").

Gets or sets the website for your application (e.g. "https://myawesomeapp.info").

Formats a in a way that's suitable to be appended to a User-Agent string.

The formatted app information to be appended. Note that this format is shared between all libraries so if it's changed, it should be changed everywhere.

Interface for HTTP clients used to make requests to Stripe's API.

Sends a request to Stripe's API as an asynchronous operation.

The parameters of the request to send. The cancellation token to cancel operation. The task object representing the asynchronous operation.

Interface for a Stripe client.

Gets the base URL for Stripe's API.

The base URL for Stripe's API.

Gets the API key used by the client to send requests.

The API key used by the client to send requests.

Gets the client ID used by the client in OAuth requests.

The client ID used by the client in OAuth requests.

Gets the base URL for Stripe's OAuth API.

The base URL for Stripe's OAuth API.

Gets the base URL for Stripe's Files API.

The base URL for Stripe's Files API.

Sends a request to Stripe's API as an asynchronous operation.

Type of the Stripe entity returned by the API. The HTTP method. The path of the request. The parameters of the request. The special modifiers of the request. The cancellation token to cancel operation. The task object representing the asynchronous operation. Thrown if the request fails.

Helper class used by to manage request telemetry.

If telemetry is enabled and there is at least one metrics item in the queue, then add a X-Stripe-Client-Telemetry header with the item; otherwise, do nothing.

The request headers.

If telemetry is enabled and the queue is not full, then enqueue a new metrics item; otherwise, do nothing.

The HTTP response message. The request duration.

A Stripe client, used to issue requests to Stripe's API and deserialize responses.

Initializes a new instance of the class.

The API key used by the client to make requests. The client ID used by the client in OAuth requests. The client to use. If null, an HTTP client will be created with default parameters. The base URL for Stripe's API. Defaults to . The base URL for Stripe's OAuth API. Defaults to . The base URL for Stripe's Files API. Defaults to . if apiKey is null. if apiKey is empty or contains whitespace.

Default base URL for Stripe's API.

Default base URL for Stripe's OAuth API.

Default base URL for Stripe's Files API.

Gets the base URL for Stripe's API.

The base URL for Stripe's API.

Gets the API key used by the client to send requests.

The API key used by the client to send requests.

Gets the client ID used by the client in OAuth requests.

The client ID used by the client in OAuth requests.

Gets the base URL for Stripe's OAuth API.

The base URL for Stripe's OAuth API.

Gets the base URL for Stripe's Files API.

The base URL for Stripe's Files API.

Gets the used to send HTTP requests.

The used to send HTTP requests.

Sends a request to Stripe's API as an asynchronous operation.

Global configuration class for Stripe.net settings.

API version used by Stripe.net.

Gets or sets the API key.

You can also set the API key using the StripeApiKey key in .

Gets or sets the client ID.

You can also set the client ID using the StripeClientId key in .

Gets or sets the settings used for deserializing JSON objects returned by Stripe's API. It is highly recommended you do not change these settings, as doing so can produce unexpected results. If you do change these settings, make sure that is among the converters, otherwise Stripe.net will no longer be able to deserialize polymorphic resources represented by interfaces (e.g. ).

Gets or sets the maximum number of times that the library will retry requests that appear to have failed due to an intermittent problem.

Gets or sets the flag enabling request latency telemetry. Enabled by default.

Gets or sets a custom for sending requests to Stripe's API. You can use this to use a custom message handler, set proxy parameters, etc.

To use a custom message handler:


            System.Net.Http.HttpMessageHandler messageHandler = ...;
            var httpClient = new System.Net.HttpClient(messageHandler);
            var stripeClient = new Stripe.StripeClient(
                stripeApiKey,
                httpClient: new Stripe.SystemNetHttpClient(httpClient));
            Stripe.StripeConfiguration.StripeClient = stripeClient;

Gets the version of the Stripe.net client library.

Sets information about the "app" which this integration belongs to. This should be reserved for plugins that wish to identify themselves with Stripe.

Returns a new instance of with the default settings used by Stripe.net.

A instance.

Sets the API key. This method is deprecated and will be removed in a future version, please use the property setter instead.

API key.

Represents a request to Stripe's API.

Initializes a new instance of the class.

The client creating the request. The HTTP method. The path of the request. The parameters of the request. The special modifiers of the request.

The HTTP method for the request (GET, POST or DELETE).

The URL for the request. If this is a GET or DELETE request, the URL also includes the request parameters in its query string.

The value of the Authorization header with the API key.

Dictionary containing Stripe custom headers (Stripe-Version, Stripe-Account, Idempotency-Key...).

The body of the request. For POST requests, this will be either a application/x-www-form-urlencoded or a multipart/form-data payload. For non-POST requests, this will be null.

This getter creates a new instance every time it is called.

Returns a string that represents the .

A string that represents the .

Represents a response from Stripe's API.

Initializes a new instance of the class.

The HTTP status code. The HTTP headers of the response. The body of the response.

Gets the HTTP status code of the response.

The HTTP status code of the response.

Gets the HTTP headers of the response.

The HTTP headers of the response.

Gets the body of the response.

The body of the response.

Gets the date of the request, as returned by Stripe.

The date of the request, as returned by Stripe.

Gets the idempotency key of the request, as returned by Stripe.

The idempotency key of the request, as returned by Stripe.

Gets the ID of the request, as returned by Stripe.

The ID of the request, as returned by Stripe.

Returns a string that represents the .

A string that represents the .

Standard client to make requests to Stripe's API, using to send HTTP requests. It can gather telemetry about request latency (via ) and automatically retry failed requests when it's safe to do so.

Initializes a new instance of the class.

The client to use. If null, an HTTP client will be created with default parameters. The maximum number of times the client will retry requests that fail due to an intermittent problem. Information about the "app" which this integration belongs to. This should be reserved for plugins that wish to identify themselves with Stripe. Whether to enable request latency telemetry or not.

Default timespan before the request times out.

Maximum sleep time between tries to send HTTP requests after network failure.

Minimum sleep time between tries to send HTTP requests after network failure.

Gets or sets a value indicating whether the client should sleep between automatic request retries.

This is an internal property meant to be used in tests only.

Initializes a new instance of the class with default parameters.

The new instance of the class.

Sends a request to Stripe's API as an asynchronous operation.

The parameters of the request to send. The cancellation token to cancel operation. The task object representing the asynchronous operation.

The company’s primary address.

The Kana variation of the company’s primary address (Japan only).

The Kanji variation of the company’s primary address (Japan only).

Whether the company’s directors have been provided. Set this to true after creating all the company’s directors for this account.

The company’s legal name.

The Kana variation of the company’s legal name (Japan only).

The Kanji variation of the company’s legal name (Japan only).

Whether the company’s owners have been provided. Set this to true after creating all the company’s owners for this account.

The company’s phone number (used for verification).

The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.).

The jurisdiction in which the tax id is registered (Germany-based companies only).

The VAT number of the company.

Information on the verification state of the company.

The back of a document returned by a file upload with a purpose value of additional_verification.

The front of a document returned by a file upload with a purpose value of additional_verification.

A document verifying the business.

One of .

The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic statement_descriptor specified on the charge.

The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).

The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).

A card or bank account to attach to the account. You can provide either a token, like the ones returned by Stripe.js, or a or instance. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.

Domain to add as an Apple Pay Domain.

A filter on the list based on the object available_on field. The value can be a or a .

A set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

REQUIRED. Either a token, like the ones returned by Stripe.js, or a instance containing a user’s bank account details.

Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the requirements arrays.

REQUIRED. Either a token, like the ones returned by Stripe.js, or a instance containing a user’s card details.

Amount to capture on the authorization.

This is deprecated in favor of ApplicationFeeAmount.

A fee in cents that will be applied to the charge and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account (using RequestOptions available on all service methods), using the Stripe-Account header, an OAuth key, or the destination parameter. For more information, see the application fees documentation.

An optional dictionary containing a new destination amount to use. Can only be used with destination charges created with Stripe Connect.

Email address that will receive an email receipt confirming the transaction.

An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. 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. The statement description may not include <>"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all.

A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a 0-decimal currency) representing how much to charge the card. The minimum amount is $0.50 US or equivalent in charge currency.

3-letter ISO code for currency.

Whether or not to immediately capture the charge. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire in 7 days. For more information, see authorizing charges and settling later.

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.

If specified, the charge will be attributed to the destination account for tax reporting, and the funds from the charge will be transferred to the destination account.

Extra information about the charge passing level III data to card networks.

A string that identifies this transaction as part of a group. For details, see Grouping transactions.

The Stripe account ID that these funds are intended for. Automatically set if you use the destination parameter. See the Connect documentation for details.

A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the customer in a structured format. It's often a good idea to store an email address in metadata for tracking later.

The email address to send this charge's receipt to. The receipt will not be sent until the charge is paid. If this charge is for a customer, the email address specified here will override the customer's email address. Receipts will not be sent for test mode charges. 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. For more information, see the Charge object documentation.

The ID of an existing customer that will be charged in this request.

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.

ID of an existing, connected stripe account.

The amount to transfer to the destination account.

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

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

Only return charges for this transfer group.

Shipping information for the charge. Helps prevent fraud on charges for physical goods. For more information, see the Charge object documentation.

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.

Plan ID for this item.

Quantity for this item.

Credit note amount.

Amount to credit the customer balance.

ID of the invoice.

Credit note memo.

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.

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.

ID of an existing refund to link this credit note to.

Amount to refund. If set, a refund will be created for the charge associated with the invoice.

ID of the customer.

ID of the invoice.

Credit note memo.

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.

The amount to apply to the customer’s balance. Pass a negative amount to credit the customer’s balance, and pass in a positive amount to debit the customer’s balance.

Three-letter ISO currency code, in lowercase. Must be a supported currency. If not set, the customer’s currency will be updated to this value.

An arbitrary string attached to the object. Often useful for displaying to users.

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.

An arbitrary string attached to the object. Often useful for displaying to users.

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.

The customer’s address.

The customer’s full name or business name.

The customer’s phone number.

The customer’s preferred locales (languages), ordered by preference.

The source can either be a Token or a Source, as returned by Elements, or a containing a user’s credit card details. You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer to be charged automatically for a plan that is not free. Passing source will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source, instead use to add the card and then to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.

Describes the customer’s tax exemption status. One of none, exempt, or reverse.

The customer’s tax IDs.

Default custom fields to be displayed on invoices for this customer.

ID of the default payment method for the customer.

Default footer to be displayed on invoices for this customer.

Type of the tax ID, one of eu_vat, nz_gst or au_abn.

Value of the tax ID.

The customer’s address.

The customer’s full name or business name.

The customer’s phone number.

The customer’s preferred locales (languages), ordered by preference.

A Token’s or a Source’s ID, as returned by Elements. 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 . Whenever you attach a card to a customer, Stripe will automatically validate the card.

Describes the customer’s tax exemption status. One of none, exempt, or reverse.

The optional arguments you can pass. Stripe Documentation.

Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.

Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).

This class contains utility methods to process event objects in Stripe's webhooks.

Parses a JSON string from a Stripe webhook into a object.

The JSON string to parse. If true (default), the method will throw a if the API version of the event doesn't match Stripe.net's default API version (see ). The deserialized . Thrown if the API version of the event doesn't match Stripe.net's default API version. This method doesn't verify webhook signatures. It's recommended that you use instead.

Parses a JSON string from a Stripe webhook into a object, while verifying the webhook's signature.

The JSON string to parse. The value of the Stripe-Signature header from the webhook request. The webhook endpoint's signing secret. The time tolerance, in seconds (default 300). If true (default), the method will throw a if the API version of the event doesn't match Stripe.net's default API version (see ). The deserialized . Thrown if the signature verification fails for any reason, of if the API version of the event doesn't match Stripe.net's default API version.

Parses a JSON string from a Stripe webhook into a object, while verifying the webhook's signature.

The JSON string to parse. The value of the Stripe-Signature header from the webhook request. The webhook endpoint's signing secret. The time tolerance, in seconds. The timestamp to use for the current time. If true (default), the method will throw a if the API version of the event doesn't match Stripe.net's default API version (see ). The deserialized . Thrown if the signature verification fails for any reason, of if the API version of the event doesn't match Stripe.net's default API version.

REQUIRED. Either a token, like the ones returned by Stripe.js, or a instance containing a user’s bank account details.

When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.

A set of key-value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format.

The name of the person or business that owns the bank account.

The type of entity that holds the account. This can be either individual or >company.

City/District/Suburb/Town/Village.

Billing address country, if provided when creating card.

Address line 1 (Street address/PO Box/Company name).

Address line 2 (Apartment/Suite/Unit/Building).

State/County/Province/Region.

ZIP or postal code.

When set to true, this becomes the default external account for its currency.

Two digit number representing the card’s expiration month.

Four digit number representing the card’s expiration year.

Cardholder name.

The ID of the file.

A future timestamp after which the link will no longer be usable.

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.

REQUIRED. A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the multipart/form-data protocol).

Optional parameters to automatically create a for the newly created file.

REQUIRED. The purpose of the uploaded file. Possible values are business_logo, customer_signature, dispute_evidence, identity_document, pci_document, or tax_document_user_upload.

Set this to true to create a file link for the newly created file. Creating a link is only possible when the file’s purpose is one of the following: business_icon, business_logo, customer_signature, dispute_evidence, pci_document, or tax_document_user_upload.

A future timestamp after which the link will no longer be usable.

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.

The integer amount in cents of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer’s account, pass a negative amount.

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

The ID of the customer who will be billed when this invoice item is billed.

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.

The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.

A set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

The period associated with this invoice item.

Non-negative integer. The quantity of units for the invoice item.

The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.

The tax rates which apply to the invoice item. When set, the on the invoice do not apply to this invoice item.

The integer unit amount in cents of the charge to be applied to the upcoming invoice. This value will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer’s account, pass a negative value.

Same as , but accepts a decimal value with at most 12 decimal places.

The integer amount in cents of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer’s account, pass a negative amount.

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.

A set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

The period associated with this invoice item.

Non-negative integer. The quantity of units for the invoice item.

The tax rates which apply to the invoice item. When set, the on the invoice do not apply to this invoice item.

Same as , but accepts a decimal value with at most 12 decimal places.

A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

A list of up to 4 custom fields to be displayed on the invoice.

REQUIRED.

The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice.

ID of the default payment method for the invoice.

Ids of the tax rates to apply to this subscription.

The date on which payment for this invoice is due. Only valid for invoices where billing=send_invoice.

Footer to be displayed on the invoice. This can be unset by updating the value to null and then saving.

Extra information about a charge for the customer’s credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item’s product’s statement_descriptor.

The ID of the subscription to invoice. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will exclude pending invoice items that pertain to other subscriptions.

The percent tax rate applied to the invoice, represented as a decimal number.

The end of the period, which must be greater than or equal to the start.

he start of the period.

Either charge_automatically, or send_invoice.

A filter on the list based on the object created field. The value can be a or a .

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

A filter on the list based on the object due_date field. The value can be a or a .

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

Only return invoices for the subscription specified by this subscription ID.

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made.

Indicates if a customer is on session while an invoice payment is attempted.

ID of the payment method to use for paying the invoice.

Ids of the tax rates to apply to this subscription item.

The integer amount in cents of previewed invoice item.

Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items.

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.

Ids of the tax rates to apply to this invoice item.

A set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

The period associated with this invoice item.

Non-negative integer. The quantity of units for the invoice item.

The tax rates which apply to the invoice item. When set, the on the invoice do not apply to this invoice item.

Same as , but accepts a decimal value with at most 12 decimal places.

Either charge_automatically or send_invoice. This field can be updated only on draft invoices.

A list of up to 4 custom fields to be displayed on the invoice.

The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice.

ID of the default payment method for the invoice.

Ids of the tax rates to apply to this subscription.

The date on which payment for this invoice is due. Only valid for invoices where billing=send_invoice.

Footer to be displayed on the invoice. This can be unset by updating the value to null and then saving.

The code of the coupon to apply. If subscription or subscription_items is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer’s subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.

REQUIRED.

List of invoice items to add or update in the upcoming invoice preview.

The identifier of the unstarted schedule whose upcoming invoice you’d like to retrieve. Cannot be used with subscription or subscription fields.

For new subscriptions, a future to anchor the subscription’s billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to one of .

Time at which the subscription would cancel.

Boolean indicating whether this subscription should cancel at the end of the current period.

Boolean indicating whether the invoice returned would preview cancelling the subscription immediately.

If provided, the invoice returned will preview updating or creating a subscription with those tax rates applied.

The identifier of the subscription for which you’d like to retrieve the upcoming invoice. If not provided, but a subscription_items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_items is provided, you will retrieve the next upcoming invoice from among the customer’s subscriptions.

List of subscription items, each with an attached plan.

If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of subscription_items or subscription, and one of subscription_items or subscription_trial_end are required.

If previewing an update to a subscription, and doing proration, subscription_proration_date forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration cannot be set to false.

If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of subscription_items or subscription is required.

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_items or subscription is required.

Indicates if a plan’s trial_period_days should be applied to the subscription. Setting subscription_trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with subscription_trial_end is not allowed.

REQUIRED.

List of invoice items to add or update in the upcoming invoice preview.

The identifier of the unstarted schedule whose upcoming invoice you’d like to retrieve. Cannot be used with subscription or subscription fields.

Time at which the subscription would cancel.

Boolean indicating whether this subscription should cancel at the end of the current period.

Boolean indicating whether the invoice returned would preview cancelling the subscription immediately.

If provided, the invoice returned will preview updating or creating a subscription with those tax rates applied.

List of subscription items, each with an attached plan.

If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of subscription_items or subscription is required.

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_items or subscription is required.

Boolean to indicate that the user should always be asked to connect, even if they're already connected. Defaults to false.

The unique identifier provided to your application, found in your application settings.

The only option at the moment is code.

The URL for the authorize response redirect. If provided, this must exactly match one of the comma-separated redirect_uri values in your application settings. To protect yourself from certain forms of man-in-the-middle attacks, the live mode redirect_uri must use a secure HTTPS connection. Defaults to the redirect_uri in your application settings if not provided.

read_write or read_only, depending on the level of access you need. Defaults to read_only.

An arbitrary string value we will pass back to you, useful for CSRF protection.

login or register, depending on what type of screen you want your users to see. Only override this to be login if you expect all your users to have Stripe accounts already (e.g., most read-only applications, like analytics dashboards or accounting software). Defaults to login for scope read_only and register for scope read_write.

Prefilled details in the account form for new users.

If your platform is designated for one Capability (either card_payments or transfers), you won’t need to specify additional Capabilities. However, if your platform supports both, you can add a Capability to an individual Express account by including the parameter in your OAuth link.

The Kana variation of the address block. This parameter is only relevant for Japan. You must prefill with JP and with a valid Japanese postal code to use this parameter.

The Kanji variation of the address block. This parameter is only relevant for Japan. You must prefill with JP and with a valid Japanese postal code to use this parameter.

The Kana variation of the address building. This parameter is only relevant for Japan. You must prefill with JP and with a valid Japanese postal code to use this parameter.

The Kanji variation of the address building. This parameter is only relevant for Japan. You must prefill with JP and with a valid Japanese postal code to use this parameter.

The legal name of the business, also used for the statement descriptor.

The type of the business. Must be one of sole_prop, corporation, non_profit, partnership, or llc.

Address city of the business. We highly recommend that you also prefill with the corresponding country.

Two-letter country code (e.g., US or CA). Must be a country that Stripe currently supports.

Three-letter ISO code representing currency, in lowercase (e.g., usd or cad). Must be a valid country and currency combination that Stripe supports. Must prefill with the corresponding country.

Day (1-31) for the birth date of the person who will be filling out a Stripe application. If filling this property, you must also fill and .

Month (1-12) for the birth date of the person who will be filling out a Stripe application. If filling this property, you must also fill and .

Year (YYYY, greather than 1900) for the birth date of the person who will be filling out a Stripe application. If filling this property, you must also fill and .

The user's email address. Must be a valid email format.

Recommended.

First name of the person who will be filling out a Stripe application.

The Kana variation of the first name of the person who will be filling out a Stripe application. Must prefill with JP, as this parameter is only relevant for Japan.

The Kanji variation of the first name of the person who will be filling out a Stripe application. Must prefill with JP, as this parameter is only relevant for Japan.

The gender of the person who will be filling out a Stripe application. (International regulations require either male or female.) Must prefill with JP, as this parameter is only relevant for Japan.

Last name of the person who will be filling out a Stripe application.

The Kana variation of the last name of the person who will be filling out a Stripe application. Must prefill with JP, as this parameter is only relevant for Japan.

The Kanji variation of the last name of the person who will be filling out a Stripe application. Must prefill with JP, as this parameter is only relevant for Japan.

The business phone number. Must be 10 digits only. Must also prefill with the corresponding country.

true if the user sells a physical product, false otherwise.

A description of what the business is accepting payments for.

Address state of the business. Must be the two-letter state or province code (e.g., NY for a U.S. business or AB for a Canadian one). Must also prefill with the corresponding country.

Street address of the business.

The URL for the user's business. This may be the user's website, a profile page within your application, or another publicly available profile for the business, such as a LinkedIn or Facebook profile. Must be URL-encoded and include a scheme (http or https). If you will be prefilling this field, we highly recommend that the linked page contain a description of the user's products or services and their contact information. If we don't have enough information, we'll have to reach out to the user directly before initiating payouts.

Recommended.

Address postal code of the business. We highly recommend that you also prefill with the corresponding country.

The client_id of the application that you'd like to disconnect the account from. The account must be connected to this application.

The account you'd like to disconnect from.

If you specified a Capability using the parameter, you can verify that Stripe applied the suggested Capability in this POST request by including and identifying that card_payments or transfers match. A request error will be returned if the suggested Capability doesn’t match the assertion: in this case, it’s recommended to end the onboarding flow with a failure.

The secret API key. When converting an authorization code to an access token, you must use an API key that matches the mode—live or test—of the authorization code (which depends on whether the client_id used was production or development).

The value of the code, depending on the grant_type.

authorization_code when turning an authorization code into an access token, or refresh_token when using a refresh token to get a new access token.

The value of the refresh_token, depending on the grant_type.

When requesting a new access token from a refresh token, any scope that has an equal or lesser scope as the refresh token. Has no effect when requesting an access token from an authorization code. Defaults to the scope of the refresh token.

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

A coupon code that represents a discount to be applied to this order. Must be one-time duration and in tbe same currency as the order.

The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If email or shipping are also provided, they will override the values retrieved from the customer object.

The email address of the customer placing the order.

List of items constituting the order.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

Shipping address for the order. Required if any of the SKUs are for products that have shippable set to true.

The ID of the SKU being ordered.

The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.

Only return orders for the given customer.

Only return orders with the given IDs.

Only return orders that have the given status. One of created, paid, fulfilled, or refunded.

Only return orders that match the given status_transitions. One of canceled, fulfilled, paid or returned.

Only return orders with the given upstream order IDs.

The ID of an existing customer that will be charged in this request.

A payment source to be charged, such as a credit card. If you also pass a customer ID, the source must be the ID of a source belonging to the customer. Otherwise, if you do not pass a customer ID, the source you provide must either be a token, like the ones returned by Stripe.js.

A fee in cents that will be applied to the order and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account, using the Stripe-Account header or OAuth key. For more information, see the application fees documentation.

The email address of the customer placing the order. If a customer is specified, that customer's email address will be used.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

A filter on the list based on the object canceled field. The value can be a or a .

A filter on the list based on the object fulfilled field. The value can be a or a .

A filter on the list based on the object paid field. The value can be a or a .

A filter on the list based on the object returned field. The value can be a or a .

A coupon code that represents a discount to be applied to this order. Must be one-time duration and in tbe same currency as the order.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

The shipping method to select for fulfilling this order. If specified, must be one of the ids of a shipping method in the shipping_methods array. If specified, will overwrite the existing selected shipping method, updating items as necessary.

Tracking information once the order has been fulfilled.

Current order status. One of created, paid, canceled, fulfilled, or returned.

The name of the carrier like USPS, UPS, or FedEx. ShippingTrackingNumber must also be set with this property.

The tracking number provided by the carrier. ShippingCarrier must also be set with this property.

Reason for canceling this PaymentIntent. Possible values are duplicate, fraudulent, requested_by_customer, or abandoned.

The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full amount capturable if not provided.

The amount of the application fee (if any) that will be applied to the payment and transferred to the application owner’s Stripe account. For more information, see the PaymentIntents use case for connected accounts.

Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

The client secret of the PaymentIntent. Required if a publishable key is used to confirm the payment intent.

Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.

Payment-method-specific configuration for this PaymentIntent.

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

Email address that the receipt for the resulting payment will be sent to.

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

If the PaymentIntent has a payment_method and a customer or if you’re attaching a payment method to the PaymentIntent in this request, you can pass this as true to save the payment method to the customer. Defaults to false. If the payment method is already saved to a customer, this does nothing. If this type of payment method cannot be saved to a customer, the request will error.

Shipping information for this PaymentIntent.

ID of the Source to use with this PaymentIntent. Prefer using .

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

Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. If the payment method attached is a card, a return_url may be provided in case additional authentication is required.

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

An arbitrary string attached to the object. Often useful for displaying to users.

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.

The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.

Payment-method-specific configuration for this PaymentIntent.

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

Email address that the receipt for the resulting payment will be sent to.

String representing the object’s type. Objects of the same type share the same value.

Shipping information for this PaymentIntent.

ID of the Source to use with this PaymentIntent. Prefer using .

Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the payment intent.

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

When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA.

Control when to request 3D Secure on this PaymentIntent.

Configuration for any card payments attempted on this PaymentIntent.

The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.

If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account. The ID of the resulting transfer will be returned on the successful charge’s transfer field.

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

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

An arbitrary string attached to the object. Often useful for displaying to users.

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.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

Email address that the receipt for the resulting payment will be sent to.

Shipping information for this PaymentIntent.

ID of the Source to use with this PaymentIntent. Prefer using .

Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

Card security code. It is highly recommended to always include this value.

Two-digit number representing the card's expiration month.

Two- or four-digit number representing the card's expiration year.

The card number, as a string without any separators.

For backwards compatibility, you can provide a Stripe token (e.g., for Apple Pay, or legacy Checkout).

Two-digit number representing the card's expiration month.

Two- or four-digit number representing the card's expiration year.

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

If this is a card PaymentMethod, raw card details. You must meet the requirements for PCI compliance. We strongly recommend using Stripe.js instead of interacting with this API directly.

The customer associated with the PaymentMethod that you are trying to share with a connected account.

This is a FPX PaymentMethod available in Malaysia.

The id of the PaymentMethod that you are trying to share with a Connected account. This only works with Stripe Connect.

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Account holder type for FPX transaction. Can be one of "individual" or "company".

FPX bank name.

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

If this is a card PaymentMethod, new values associated with the card.

REQUIRED. A positive integer in cents representing how much to payout.

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

An arbitrary string attached to the object. Often useful for displaying to users. This can be unset by updating the value to null and then saving.

The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.

A set of key-value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.

The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of bank_account or card.

A string to be displayed on the recipient’s bank or card statement. This may be at most 22 characters. Attempting to use a statement_descriptor longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.

A filter on the list based on the object arrival_date field. The value can be a or a .

The ID of an external account - only return payouts sent to this external account.

Only return payouts that have the given status: pending, paid, failed, or canceled.

A set of key-value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.

A filter on the list of people returned based on whether these people are directors of the account’s company.

A filter on the list of people returned based on whether these people are executives of the account’s company.

A filter on the list of people returned based on whether these people are owners of the account’s company.

A filter on the list of people to find the account representative.

Whether the person is a director of the account’s legal entity..

Whether the person has significant responsibility to control, manage, or direct the organization.

Whether the person is an owner of the account’s legal entity..

The percent owned by the person of the account’s legal entity.

The person’s title (e.g., CEO, Support Engineer).

The person’s address.

The Kana variation of the person’s address (Japan only).

The Kanji variation of the person’s address (Japan only).

The person’s date of birth.

The person’s email address.

The person’s first name.

The Kana variation of the person’s first name (Japan only).

The Kanji variation of the person’s first name (Japan only).

The person’s gender (International regulations require either male or female).

The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.

The person’s last name.

The Kana variation of the person’s last name (Japan only).

The Kanji variation of the person’s last name (Japan only).

The person’s maiden name.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

A person token, used to securely provide details to the person.

The person’s phone number.

The relationship that this person has with the account’s legal entity.

The last 4 digits of the person’s social security number.

The person’s verification status.

The back of a document returned by a file upload with a purpose value of identity_document.

The front of a document returned by a file upload with a purpose value of identity_document.

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

An identifying document, either a passport or local ID card.

Whether the plan is currently available for new subscriptions.

The amount in cents to be charged on the interval specified.

Same as , but contains a decimal value with at most 12 decimal places.

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

An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.

One of day, week, month or year. The frequency with which a subscription should be billed.

The number of intervals (specified in the interval property) between subscription billings.

A set of key/value pairs that you can attach to a subscription object.

A brief description of the plan, hidden from customers.

The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a instance containing fields used to create a service product.

Each element represents a pricing tier. This parameter requires to be set to tiered.

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

Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

Only return plans for the given product.

The flat billing amount for an entire tier, regardless of the number of units in the tier.

Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.

The per unit billing amount for each individual unit for which this tier applies.

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

Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use to define a fallback tier.

Use this value to define a fallback tier.

Whether the plan is currently available for new subscriptions.

A set of key/value pairs that you can attach to a subscription object.

A brief description of the plan, hidden from customers.

The product the plan belongs to. Note that after updating, statement descriptors and line items of the plan in active subscriptions will be affected.

Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.

The type of the product. Either 'service' or 'good'.

Whether or not the product is currently available for purchase. Defaults to true.

A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g. ["color", "size"]).

A short one-line description of the product, meant to be displayable to the customer.

An array of Connect application names or identifiers that should not be able to order the SKUs for this product.

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

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.

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

The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own package_dimensions.

Whether this product is shipped (i.e. physical goods). Defaults to true.

What appears on the customers credit card statement.

A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices.

A URL of a publicly-accessible webpage for this product.

A positive integer in cents representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.

REQUIRED. The identifier of the charge to refund.

A set of key-value pairs that you can attach to a Refund object. This can be useful for storing additional information about the refund in a structured format. You can unset individual keys if you POST an empty value for that key. You can clear all keys if you POST an empty value for metadata.

String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. If you believe the charge to be fraudulent, specifying fraudulent as the reason will add the associated card and email to your blocklists, and will also help us improve our fraud detection algorithms.

Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

Reason for canceling this SetupIntent. Possible values are abandoned, requested_by_customer, or duplicate.

The client secret of the SetupIntent. Required if a publishable key is used to confirm the setup intent.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this SetupIntent.

Payment-method-specific configuration for this SetupIntent.

The URL to redirect your customer back to after they authenticate on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If the payment method attached is a card, a ReturnUrl may be provided in case additional authentication is required.

An arbitrary string attached to the object. Often useful for displaying to users. This can be unset by updating the value to null and then saving.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

The Stripe account ID for which this SetupIntent is created.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this SetupIntent.

Payment-method-specific configuration for this SetupIntent.

The list of payment method types that this SetupIntent is allowed to set up. If this is not provided, defaults to card.

The client secret of the SetupIntent. Required if a publishable key is used to retrieve the setup intent.

When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and is thus out of scope for SCA.

Control when to request 3D Secure on this SetupIntent.

Configuration for any card payments attempted on this SetupIntent.

An arbitrary string attached to the object. Often useful for displaying to users. This can be unset by updating the value to null and then saving.

A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this SetupIntent.

The list of payment method types that this SetupIntent is allowed to set up. If this is not provided, defaults to card.

This feature is not yet available in the API.

The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.

Whether or not the SKU is currently available for purchase. Defaults to true.

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

The URL of an image for this SKU, meant to be displayable to the customer.

Description of the SKU’s inventory.

Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

The dimensions of this SKU for shipping purposes.

The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a 0-decimal currency).

The ID of the product this SKU is associated with. The product must be currently active.

REQUIRED: The identifier of the source to be attached.

REQUIRED: The type of the source to create. One of type .

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single-use sources.

The currency associated with the source. This is the currency for which the source will be chargeable once ready.

The customer associated with the Source that you are trying to share with a Connected account. This only works with Stripe Connect as documented here.

The authentication flow of the source to create. Flow is one of . It is generally inferred unless a type supports multiple flows.

Information about a mandate possiblity attached to a source object (generally for bank debits) as well as its acceptance status.

A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about the source in a structured format.

The id of the Source that you are trying to share with a Connected account. This only works with Stripe Connect as documented here.

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

Optional parameters for the receiver flow. Can be set only if the source is a receiver.

Information about the items and shipping associated with the source.

An arbitrary string to be displayed on your customer’s statement.

An optional token used to create the source. When passed, token properties will override source parameters.

One of . Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while other may leave the option at creation. If an incompatible value is passed, an error will be returned.

The client secret of the source. Required if a publishable key is used to retrieve the source.

The amount (price) for this order item.

This currency of this order item. Required when amount is present.

Human-readable description for this order item.

The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.

The type of this order item. Must be sku, tax, or shipping.

List of items constituting the order.

The shipping address for the order. Present if the order is for goods to be shipped.

Information about a mandate possiblity attached to a source object (generally for bank debits) as well as its acceptance status.

A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about the source in a structured format. You can unset individual keys if you POST an empty value for that key. You can clear all keys if you POST an empty value for metadata.

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

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

Properties that can be updated on a Card Source.

The values needed to verify the source.

Usage threshold that triggers the subscription to create an invoice.

REQUIRED: The identifier of the subscription to modify.

REQUIRED: The ID of the subscription whose items will be retrieved.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if the invoice caused by the item creation cannot be paid. Otherwise use allow_incomplete.

REQUIRED: The identifier of the plan to add to the subscription.

Flag indicating whether to prorate switching plans during a billing cycle.

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

The quantity you’d like to apply to the subscription item you’re creating.

Ids of the tax rates to apply to this subscription item.

A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.

Indicates if your customer is on session in case this update causes an invoice to be created.

Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.

If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.

The identifier of the customer to create the subscription schedule for.

Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription’s plan(s), set to auto-renew using the subscription’s interval. Other parameters cannot be set since their values will be inferred from the subscription.

The date at which the subscription schedule starts.

The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice.

A filter on the list based on the object canceled_at field. The value can be a or a .

A filter on the list based on the object completed_at field. The value can be a or a .

Only return subscription schedules for the given customer.

A filter on the list based on the object released_at field. The value can be a or a .

Only return subscription schedules that have not started yet.

Plan ID for this item.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

Quantity for this item.

Ids of the tax rates to apply to this item for a phase on the subscription schedule.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically on creation.

The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

ID of the default payment method for the subscription schedule.

Ids of the tax rates to apply to this phase on the subscription schedule.

The date at which this phase of the subscription schedule ends. If set, iterations must not be set.

Define the default settings applied to invoices created by this subscription schedule.

Integer representing the multiplier applied to the plan interval. For example, iterations=2 applied to a plan with interval=month and interval_count=3 results in a phase of duration 2 * 3 months = 6 months. If set, end_date must not be set.

List of configuration items, each with an attached plan, to apply during this phase of the subscription schedule.

The date at which this phase of the subscription schedule starts.

A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount each billing period. For example, a plan which charges $10/month with a tax_percent of 20.0 will charge $12 per invoice.

If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.

Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with trial.

Keep any cancellation on the subscription that the schedule has set.

Interval at which to renew the subscription schedule for when it ends. Possible values are day, week, month, or year.

Number of intervals to renew the subscription schedule for when it ends.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

ID of the default payment method for the subscription schedule.

ID of the default source for the subscription schedule.

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are cancel, none, release and renew.

Define the default settings applied to invoices created by this subscription schedule.

A set of key/value pairs that you can attach to a subscription schedule object.

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.

Configures how the subscription schedule behaves when it ends. Possible values are none, release, or renew. renew will create a new subscription schedule revision by adding a new phase using the most recent phase’s plans applied to a duration set by renewal_interval. none will stop the subscription schedule and cancel the underlying subscription. release will stop the subscription schedule, but keep the underlying subscription running.

Configuration for renewing the subscription schedule when it ends. Must be set if renewal_behavior is renew. Otherwise, must not be set.

If the update changes the current phase, indicates if the changes should be prorated. Defaults to true.

Resets the subscription's billing cycle anchor to the current time.

Leaves the subscription's billing cycle anchor unchanged.

Monetary threshold that triggers the subscription to advance to a new billing period.

Indicates if the billing_reason should be reset when a threshold is reached. If true, billing_reason will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.

Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.

Boolean (default true). Use with a billing_cycle_anchor timestamp to determine whether the customer will be invoiced a prorated amount until the anchor date. If false, the anchor period will be free (similar to a trial).

For new subscriptions, a past timestamp to backdate the subscription’s start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

A future date to anchor the subscription’s billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.

REQUIRED: The identifier of the customer to subscribe.

List of subscription items, each with an attached plan.

Integer representing the number of trial period days before the customer is charged for the first time.

Plan ID for this item.

Quantity for this item.

Ids of the tax rates to apply to this subscription item.

SubscriptionItem to update.

Delete all usage for a given subscription item. Only allowed when deleted is set to true and the current plan’s usage_type is metered.

Delete the specified item if set to true.

A set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.

Plan ID for this item.

Quantity for this item.

A filter on the list based on the collection method for subscriptions. Either charge_automatically, or send_invoice.

A filter on the list based on the object current_period_end field. The value can be a or a .

A filter on the list based on the object current_period_start field. The value can be a or a .

The ID of the customer whose subscriptions will be retrieved.

The ID of the plan whose subscriptions will be retrieved.

The status of the subscriptions to retrieve. One of or all. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of all will return subscriptions of all statuses.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

A timestamp at which the subscription should cancel. If set to a date before the current period ends this will cause a proration if prorate=true.

Boolean indicating whether this subscription should cancel at the end of the current period.

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 invoices for this subscription to the customer with payment instructions. Defaults to charge_automatically.

The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

Number of days a customer has to pay invoices generated by this subscription. Only valid for subscriptions where billing=send_invoice.

ID of the default payment method for the subscription.

Ids of the tax rates to apply to this subscription.

A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.

Indicates if a customer is on session while an invoice payment is attempted.

Use allow_incomplete to create subscriptions with status=incomplete if its first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior. Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, will override the default trial period of the plan the customer is being subscribed to. The special value can be provided to end the customer’s trial immediately.

Boolean. Decide whether to use the default trial on the plan when creating a subscription.

Special value used to end a customer's trial immediately.

One of . Setting the value to resets the subscription’s billing cycle anchor to the current time. For more information, see the billing cycle documentation.

List of subscription items, each with an attached plan.

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.

Type of the tax ID, one of eu_vat, nz_gst or au_abn.

Value of the tax ID.

Whether the tax rate is currently available for new subscriptions.

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

This specifies if the tax rate is inclusive or exclusive.

The jurisdiction for the tax rate.

A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.

This represents the tax rate percent out of 100.

Optional flag to filter by tax rates that are either active or not active (archived).

Optional flag to filter by tax rates that are inclusive or not.

A filter on the list based on the object percentage field. The value can be a or a .

Whether the tax rate is currently available for new subscriptions.

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

The jurisdiction for the tax rate.

A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.

If you pass a card id, you must also pass the customer id.

The company’s primary address.

The Kana variation of the company’s primary address (Japan only).

The Kanji variation of the company’s primary address (Japan only).

Whether the company’s directors have been provided. Set this to true after creating all the company’s directors for this account.

The company’s legal name.

The Kana variation of the company’s legal name (Japan only).

The Kanji variation of the company’s legal name (Japan only).

Whether the company’s owners have been provided. Set this to true after creating all the company’s owners for this account.

The company’s phone number (used for verification).

The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.).

The jurisdiction in which the tax id is registered (Germany-based companies only).

The VAT number of the company.

Information on the verification state of the company.

The back of a document returned by a file upload with a purpose value of additional_verification.

The front of a document returned by a file upload with a purpose value of additional_verification.

A document verifying the business.

The business type. Can be individual or company.

Information about the company or business.

Information about the person representing the account.

Whether the user described by the data in the token has been shown the Stripe Connected Account Agreement. When creating an account token to create a new Connect account, this value must be true.

Information for the account this token will represent.

The bank account this token will represent. If you also pass in a customer, the bank account must be the ID of a bank account belonging to the customer. Otherwise, if you do not pass in a customer, this is a instance containing a user's bank account details.

The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a instance containing a user's credit card details.

The customer (owned by the application's account) for which to create a token. For use only with Stripe Connect. Also, this can be used only with an OAuth access token or Stripe-Account header. For more details, see Shared Customers.

Information for the account this token will represent.

The person’s address.

The Kana variation of the person’s address (Japan only).

The Kanji variation of the person’s address (Japan only).

The person’s date of birth.

The person’s email address.

The person’s first name.

The Kana variation of the person’s first name (Japan only).

The Kanji variation of the person’s first name (Japan only).

The person’s gender (International regulations require either male or female).

The person’s last name.

The Kana variation of the person’s last name (Japan only).

The Kanji variation of the person’s last name (Japan only).

The person’s maiden name.

The person’s phone number.

The relationship that this person has with the account’s legal entity.

The last 4 digits of the person’s social security number.

The person’s verification status.

Whether the person is a director of the account’s legal entity..

Whether the person has significant responsibility to control, manage, or direct the organization.

Whether the person is an owner of the account’s legal entity..

The percent owned by the person of the account’s legal entity.

The person’s title (e.g., CEO, Support Engineer).

The back of a document returned by a file upload with a purpose value of identity_document.

The front of a document returned by a file upload with a purpose value of identity_document.

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

An identifying document, either a passport or local ID card.

A positive integer in the smallest currency unit (e.g., 100 cents to top up $1.00 or 100 to top up ¥100, a 0-decimal currency) representing how much to top up your Stripe balance.

3-letter ISO code for currency.

An arbitrary string which you can attach to a Top-up object. It is displayed when in the web interface alongside the Top-up.

A set of key/value pairs that you can attach to a Top-up object. It can be useful for storing additional information in a structured format.

The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see Testing Top-ups).

Extra information about a top-up for the source’s bank statement. Limited to 15 ASCII characters.

Events sent to this endpoint will be generated with this API version instead of your account's default API version. We recommend that you set this to the API version that the library is pinned to in .

Whether this endpoint should receive events from connected accounts or your account.

Abstract base class for AnyOf<> generic classes.

Gets the value of the current object.

The value of the current object.

Gets the type of the current object.

The type of the current object.

Returns a string that represents the current object.

A string that represents the current object.

is a generic class that can hold a value of one of two different types. It uses implicit conversion operators to seamlessly accept or return either type. This is used to represent polymorphic request parameters, i.e. parameters that can be different types (typically a string or an options class).

The first possible type of the value. The second possible type of the value.

Initializes a new instance of the class with type T1.

The value to hold.

Initializes a new instance of the class with type T2.

The value to hold.

Gets the value of the current object.

The value of the current object.

Gets the type of the current object.

The type of the current object.

Converts a value of type T1 to an object.

The value to convert. An object that holds the value.

Converts a value of type T2 to an object.

The value to convert. An object that holds the value.

Converts an object to a value of type T1.

The object to convert. A value of type T1. If the object currently holds a value of a different type, the default value for type T1 is returned.

Converts a value of type T2 to an object.

The object to convert. A value of type T2. If the object currently holds a value of a different type, the default value for type T2 is returned.

is a generic class that can hold a value of one of three different types. It uses implicit conversion operators to seamlessly accept or return any of the possible types. This is used to represent polymorphic request parameters, i.e. parameters that can be different types (typically a string or an options class).

The first possible type of the value. The second possible type of the value. The third possible type of the value.

Initializes a new instance of the class with type T1.

The value to hold.

Initializes a new instance of the class with type T2.

The value to hold.

Initializes a new instance of the class with type T3.

The value to hold.

Gets the value of the current object.

The value of the current object.

Gets the type of the current object.

The type of the current object.

Converts a value of type T1 to an object.

The value to convert. An object that holds the value.

Converts a value of type T2 to an object.

The value to convert. An object that holds the value.

Converts a value of type T3 to an object.

The value to convert. An object that holds the value.

Converts an object to a value of type T1.

The object to convert. A value of type T1. If the object currently holds a value of a different type, the default value for type T3 is returned.

Converts an object to a value of type T2.

The object to convert. A value of type T2. If the object currently holds a value of a different type, the default value for type T3 is returned.

Converts an object to a value of type T3.

The object to convert. A value of type T3. If the object currently holds a value of a different type, the default value for type T3 is returned.

Base class for Stripe options classes, i.e. classes representing parameters for Stripe API requests.

Specifies which fields in the response should be expanded.

Dictionary containing extra request parameters.

Adds an expand value to the request, to request expansion of a specific field in the response. When requesting expansions in a list request, don't forget to prefix the field names with data..

The name of the field to expand.

Adds a collection of expand values to the request, to request expansion of specific fields in the response. When requesting expansions in a list request, don't forget to prefix the field names with data..

The collection of names of the fields to expand.

Adds an extra parameter to the request. This can be useful if you need to use parameters not available in regular options classes, e.g. for beta features.

The parameter's key. The parameter's value.

A limit on the number of objects to be returned, between 1 and 100.

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 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 filter on the list based on the object created field. The value can be a or a .

Abstract base class for all services.

The type of that this service returns.

Initializes a new instance of the class.

Initializes a new instance of the class with a custom .

The client used by the service to send requests.

Gets the client used by this service to send requests. If no client was set when the service instance was created, then the default client in is used instead.

Abstract base class for string enum parameters.

This class is used to define request parameters that can only take certain string values. We use it instead of defining a regular enum with annotations for serialization because enum is really an integer under the hood. This can be problematic in some cases, like when a parameter can be an integer OR a string enum (e.g. ). This sample shows how to define a new string enum type.


             public class FooBar : StringEnum
             {
                 public static readonly FooBar Foo = new FooBar("foo");
                 public static readonly FooBar Bar = new FooBar("bar");
            
                 private FooBar(string value) : base(value) {}
             }

Initializes a new instance of the class.

The serialized value for the instance.

Gets or sets the serialized value.

The serialized value.

Returns the serialized value.

The serialized value.

Gets or sets the API key to use for the request.

Get or sets the idempotency key to use for the request.

Get or sets the ID of the connected account to use for the request.

Gets or sets the base URL for the request.

This is an internal property. It is set by services or individual request methods when they need to send a request to a non-standard destination, e.g. files.stripe.com for file creation requests or connect.stripe.com for OAuth requests.

Gets or sets the API version for the request.

This is an internal property. For most requests, the API version is always set to the library's pinned version (). This property is only used for creating ephemeral keys, which require a specific API version.

Represents a value that may be of one of several different types.

Gets the value of the current object.

The value of the current object.

Gets the type of the current object.

The type of the current object.

The type of payment source. Should be "card".

City/District/Suburb/Town/Village.

Billing address country, if provided when creating card.

Address line 1 (Street address/PO Box/Company name).

Address line 2 (Apartment/Suite/Unit/Building).

State/County/Province/Region.

Zip/Postal Code.

USUALLY REQUIRED: Card security code. Highly recommended to always include this value, but it's only required for accounts based in European countries.

REQUIRED: Two digit number representing the card's expiration month.

REQUIRED: Two or four digit number representing the card's expiration year.

A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.

Cardholder's full name.

REQUIRED: The card number, as a string without any separators.

This parameter is used to create a Source from an issuing card mostly in Test mode.