Returns a list of PaymentMethods for a given Customer
operationId: getCustomersCustomerPaymentMethods parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: 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. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 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. in: query name: starting_after required: false schema: type: string style: form - description: An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. in: query name: type required: false schema: enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetCustomersCustomerPaymentMethodsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/CustomerPaymentMethodResourceList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Customers Customer Payment Methods x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/customers/{customer}/payment_methods/{payment_method}: get: description:Retrieves a PaymentMethod object for a given Customer.
operationId: getCustomersCustomerPaymentMethodsPaymentMethod parameters: - in: path name: customer required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetCustomersCustomerPaymentMethodsPaymentMethodRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Customers Customer Payment Methods Payment Method x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_intents: get: description:Returns a list of PaymentIntents.
operationId: getPaymentIntents parameters: - description: A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. explode: true in: query name: created required: false schema: anyOf: - properties: gt: type: integer gte: type: integer lt: type: integer lte: type: integer title: range_query_specs type: object - type: integer style: deepObject - description: Only return PaymentIntents for the customer that this customer ID specifies. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: 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. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 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. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentIntentsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentFlowsPaymentIntentList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Intents x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description: 'Creates a PaymentIntent object.
After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.
When you use confirm=true during creation, it’s equivalent to creating
and confirming the PaymentIntent in the same call. You can use any parameters
available in the confirm API when you supply
confirm=true.
Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
' operationId: getPaymentIntentsSearch parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. in: query name: page required: false schema: maxLength: 5000 type: string style: form - description: The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). in: query name: query required: true schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentIntentsSearchRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/SearchResult' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Intents Search x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_intents/{intent}: get: description: 'Retrieves the details of a PaymentIntent that has previously been created.
You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.
If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.
' operationId: getPaymentIntentsIntent parameters: - description: The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. in: query name: client_secret required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentIntentsIntentRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Intents x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description: 'Updates properties on a PaymentIntent object without confirming.
Depending on which properties you update, you might need to confirm the
PaymentIntent again. For example, updating the payment_method
always requires you to confirm the PaymentIntent again. If you prefer to
update and confirm at the same time, we recommend updating properties through
the confirm API instead.
Manually reconcile the remaining amount for a customer_balance PaymentIntent.
You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.
' operationId: postPaymentIntentsIntentCancel parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentIntentsIntentCancelRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Intents Cancel x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_intents/{intent}/capture: post: description: 'Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
Learn more about separate authorization and capture.
' operationId: postPaymentIntentsIntentCapture parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentIntentsIntentCaptureRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Intents Capture x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_intents/{intent}/confirm: post: description: 'Confirm that your customer intends to pay with current or provided
payment method. Upon confirmation, the PaymentIntent will attempt to initiate
a payment.
If the selected payment method requires additional authentication steps, the
PaymentIntent will transition to the requires_action status and
suggest additional actions via next_action. If payment fails,
the PaymentIntent transitions to the requires_payment_method status or the
canceled status if the confirmation limit is reached. If
payment succeeds, the PaymentIntent will transition to the succeeded
status (or requires_capture, if capture_method is set to manual).
If the confirmation_method is automatic, payment may be attempted
using our client SDKs
and the PaymentIntent’s client_secret.
After next_actions are handled by the client, no additional
confirmation is required to complete the payment.
If the confirmation_method is manual, all payment attempts must be
initiated using a secret key.
If any actions are required for the payment, the PaymentIntent will
return to the requires_confirmation state
after those actions are completed. Your server needs to then
explicitly re-confirm the PaymentIntent to initiate the next payment
attempt. Read the expanded documentation
to learn more about manual confirmation.
Perform an incremental authorization on an eligible
PaymentIntent. To be eligible, the
PaymentIntent’s status must be requires_capture and
incremental_authorization_supported
must be true.
Incremental authorizations attempt to increase the authorized amount on
your customer’s card to the new, higher amount provided. Similar to the
initial authorization, incremental authorizations can be declined. A
single PaymentIntent can call this endpoint multiple times to further
increase the authorized amount.
If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.
Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.
Learn more about incremental authorizations.
' operationId: postPaymentIntentsIntentIncrementAuthorization parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject metadata: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentIntentsIntentIncrementAuthorizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Intents Increment Authorization x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_intents/{intent}/verify_microdeposits: post: description:Verifies microdeposits on a PaymentIntent object.
operationId: postPaymentIntentsIntentVerifyMicrodeposits parameters: - in: path name: intent required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: amounts: explode: true style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentIntentsIntentVerifyMicrodepositsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_intent' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Intents Verify Microdeposits x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_links: get: description:Returns a list of your payment links.
operationId: getPaymentLinks parameters: - description: Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). in: query name: active required: false schema: type: boolean style: form - description: 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. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 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. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentLinksRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentLinksResourcePaymentLinkList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Links x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Creates a payment link.
operationId: postPaymentLinks requestBody: content: application/x-www-form-urlencoded: encoding: after_completion: explode: true style: deepObject automatic_tax: explode: true style: deepObject consent_collection: explode: true style: deepObject custom_fields: explode: true style: deepObject custom_text: explode: true style: deepObject expand: explode: true style: deepObject invoice_creation: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject payment_intent_data: explode: true style: deepObject payment_method_types: explode: true style: deepObject phone_number_collection: explode: true style: deepObject restrictions: explode: true style: deepObject shipping_address_collection: explode: true style: deepObject shipping_options: explode: true style: deepObject subscription_data: explode: true style: deepObject tax_id_collection: explode: true style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentLinksRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Links x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_links/{payment_link}: get: description:Retrieve a payment link.
operationId: getPaymentLinksPaymentLink parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentLinksPaymentLinkRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Links x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Updates a payment link.
operationId: postPaymentLinksPaymentLink parameters: - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: after_completion: explode: true style: deepObject automatic_tax: explode: true style: deepObject custom_fields: explode: true style: deepObject custom_text: explode: true style: deepObject expand: explode: true style: deepObject inactive_message: explode: true style: deepObject invoice_creation: explode: true style: deepObject line_items: explode: true style: deepObject metadata: explode: true style: deepObject payment_intent_data: explode: true style: deepObject payment_method_types: explode: true style: deepObject restrictions: explode: true style: deepObject shipping_address_collection: explode: true style: deepObject subscription_data: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentLinksPaymentLinkRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_link' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Links x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_links/{payment_link}/line_items: get: description:When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
operationId: getPaymentLinksPaymentLinkLineItems parameters: - description: 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. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - in: path name: payment_link required: true schema: maxLength: 5000 type: string style: simple - description: 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. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentLinksPaymentLinkLineItemsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentLinksResourceListLineItems' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Links Line Items x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_method_configurations: get: description:List payment method configurations
operationId: getPaymentMethodConfigurations parameters: - description: The Connect application to filter by. explode: true in: query name: application required: false schema: anyOf: - maxLength: 100 type: string - enum: - '' type: string style: deepObject - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodConfigurationsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentMethodConfigResourcePaymentMethodConfigurationsList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Method Configurations x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Creates a payment method configuration
operationId: postPaymentMethodConfigurations requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject apple_pay: explode: true style: deepObject apple_pay_later: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cartes_bancaires: explode: true style: deepObject cashapp: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject google_pay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject jcb: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodConfigurationsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Method Configurations x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_method_configurations/{configuration}: get: description:Retrieve payment method configuration
operationId: getPaymentMethodConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodConfigurationsConfigurationRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Method Configurations x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Update payment method configuration
operationId: postPaymentMethodConfigurationsConfiguration parameters: - in: path name: configuration required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject apple_pay: explode: true style: deepObject apple_pay_later: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cartes_bancaires: explode: true style: deepObject cashapp: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject google_pay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject jcb: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodConfigurationsConfigurationRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_configuration' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Method Configurations x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_method_domains: get: description:Lists the details of existing payment method domains.
operationId: getPaymentMethodDomains parameters: - description: The domain name that this payment method domain object represents. in: query name: domain_name required: false schema: maxLength: 5000 type: string style: form - description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements in: query name: enabled required: false schema: type: boolean style: form - description: 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. in: query name: ending_before required: false schema: maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 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. in: query name: starting_after required: false schema: maxLength: 5000 type: string style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodDomainsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentMethodDomainResourcePaymentMethodDomainList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Method Domains x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Creates a payment method domain.
operationId: postPaymentMethodDomains requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodDomainsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Method Domains x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_method_domains/{payment_method_domain}: get: description:Retrieves the details of an existing payment method domain.
operationId: getPaymentMethodDomainsPaymentMethodDomain parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodDomainsPaymentMethodDomainRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Method Domains x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Updates an existing payment method domain.
operationId: postPaymentMethodDomainsPaymentMethodDomain parameters: - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodDomainsPaymentMethodDomainRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Method Domains x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_method_domains/{payment_method_domain}/validate: post: description: 'Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: Payment method domains.
' operationId: postPaymentMethodDomainsPaymentMethodDomainValidate parameters: - in: path name: payment_method_domain required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodDomainsPaymentMethodDomainValidateRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method_domain' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Method Domains Validate x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_methods: get: description:Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
operationId: getPaymentMethods parameters: - description: The ID of the customer whose PaymentMethods will be retrieved. in: query name: customer required: false schema: maxLength: 5000 type: string style: form - description: 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. in: query name: ending_before required: false schema: type: string style: form - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. in: query name: limit required: false schema: type: integer style: form - description: 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. in: query name: starting_after required: false schema: type: string style: form - description: An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. in: query name: type required: false schema: enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true style: form requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodsRequest' required: false responses: '200': content: application/json: schema: description: '' x-expandableFields: - data $ref: '#/components/schemas/PaymentFlowsPaymentMethodList' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Methods x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description: 'Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.
' operationId: postPaymentMethods requestBody: content: application/x-www-form-urlencoded: encoding: acss_debit: explode: true style: deepObject affirm: explode: true style: deepObject afterpay_clearpay: explode: true style: deepObject alipay: explode: true style: deepObject au_becs_debit: explode: true style: deepObject bacs_debit: explode: true style: deepObject bancontact: explode: true style: deepObject billing_details: explode: true style: deepObject blik: explode: true style: deepObject boleto: explode: true style: deepObject card: explode: true style: deepObject cashapp: explode: true style: deepObject customer_balance: explode: true style: deepObject eps: explode: true style: deepObject expand: explode: true style: deepObject fpx: explode: true style: deepObject giropay: explode: true style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject interac_present: explode: true style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject link: explode: true style: deepObject metadata: explode: true style: deepObject oxxo: explode: true style: deepObject p24: explode: true style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject pix: explode: true style: deepObject promptpay: explode: true style: deepObject radar_options: explode: true style: deepObject revolut_pay: explode: true style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject zip: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Methods x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_methods/{payment_method}: get: description:Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods
operationId: getPaymentMethodsPaymentMethod parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query name: expand required: false schema: items: maxLength: 5000 type: string type: array style: deepObject - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: additionalProperties: false $ref: '#/components/schemas/GetPaymentMethodsPaymentMethodRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Get Payment Methods x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments post: description:Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
operationId: postPaymentMethodsPaymentMethod parameters: - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: billing_details: explode: true style: deepObject card: explode: true style: deepObject expand: explode: true style: deepObject link: explode: true style: deepObject metadata: explode: true style: deepObject us_bank_account: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodsPaymentMethodRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Methods x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments /v1/payment_methods/{payment_method}/attach: post: description: 'Attaches a PaymentMethod object to a Customer.
To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent
or a PaymentIntent with setup_future_usage.
These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
future use, which makes later declines and payment friction more likely.
See Optimizing cards for future payments for more information about setting up
future payments.
To use this PaymentMethod as the default for invoice or subscription payments,
set invoice_settings.default_payment_method,
on the Customer to the PaymentMethod’s ID.
Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
operationId: postPaymentMethodsPaymentMethodDetach parameters: - in: path name: payment_method required: true schema: maxLength: 5000 type: string style: simple requestBody: content: application/x-www-form-urlencoded: encoding: expand: explode: true style: deepObject schema: additionalProperties: false $ref: '#/components/schemas/PostPaymentMethodsPaymentMethodDetachRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_method' description: Successful response. default: content: application/json: schema: $ref: '#/components/schemas/error' description: Error response. summary: Stripe Post Payment Methods Detach x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true tags: - Payments components: schemas: PostPaymentMethodDomainsPaymentMethodDomainValidateRequest: type: object properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_method_configuration: description: 'PaymentMethodConfigurations control which payment methods are displayed to your customers when you don''t explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges): **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter. Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. Related guides: - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)' properties: acss_debit: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' active: description: Whether the configuration can be used for new payments. type: boolean affirm: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' afterpay_clearpay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' alipay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' apple_pay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' application: description: For child configs, the Connect application associated with the configuration. maxLength: 5000 nullable: true type: string au_becs_debit: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' bacs_debit: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' bancontact: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' blik: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' boleto: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' card: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' cartes_bancaires: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' cashapp: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' eps: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' fpx: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' giropay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' google_pay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' grabpay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' id: description: Unique identifier for the object. maxLength: 5000 type: string ideal: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' is_default: description: The default configuration is used whenever a payment method configuration is not specified. type: boolean jcb: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' klarna: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' konbini: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' link: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean name: description: The configuration's name. maxLength: 5000 type: string object: description: String representing the object's type. Objects of the same type share the same value. enum: - payment_method_configuration type: string oxxo: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' p24: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' parent: description: For child configs, the configuration's parent configuration. maxLength: 5000 nullable: true type: string paynow: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' paypal: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' promptpay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' revolut_pay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' sepa_debit: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' sofort: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' us_bank_account: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' wechat_pay: $ref: '#/components/schemas/payment_method_config_resource_payment_method_properties' required: - active - id - is_default - livemode - name - object title: PaymentMethodConfigResourcePaymentMethodConfiguration type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - apple_pay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cartes_bancaires - cashapp - eps - fpx - giropay - google_pay - grabpay - ideal - jcb - klarna - konbini - link - oxxo - p24 - paynow - paypal - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay x-resourceId: payment_method_configuration GetPaymentLinksPaymentLinkLineItemsRequest: type: object properties: {} GetPaymentLinksPaymentLinkRequest: type: object properties: {} PostPaymentLinksRequest: type: object required: - line_items properties: after_completion: description: Behavior after the purchase is complete. properties: hosted_confirmation: properties: custom_message: maxLength: 500 type: string title: after_completion_confirmation_page_params type: object redirect: properties: url: maxLength: 2048 type: string required: - url title: after_completion_redirect_params type: object type: enum: - hosted_confirmation - redirect type: string required: - type title: after_completion_params type: object allow_promotion_codes: description: Enables user redeemable promotion codes. type: boolean application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. type: integer application_fee_percent: description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. type: number automatic_tax: description: Configuration for automatic tax collection. properties: enabled: type: boolean required: - enabled title: automatic_tax_params type: object billing_address_collection: description: Configuration for collecting the customer's billing address. enum: - auto - required type: string consent_collection: description: Configure fields to gather active consent from customers. properties: payment_method_reuse_agreement: properties: position: enum: - auto - hidden type: string required: - position title: payment_method_reuse_agreement_params type: object promotions: enum: - auto - none type: string terms_of_service: enum: - none - required type: string title: consent_collection_params type: object currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. type: string custom_fields: description: Collect additional information from your customer using custom fields. Up to 2 fields are supported. items: properties: dropdown: properties: options: items: properties: label: maxLength: 100 type: string value: maxLength: 100 type: string required: - label - value title: custom_field_option_param type: object type: array required: - options title: custom_field_dropdown_param type: object key: maxLength: 200 type: string label: properties: custom: maxLength: 50 type: string type: enum: - custom type: string required: - custom - type title: custom_field_label_param type: object numeric: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_numeric_param type: object optional: type: boolean text: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_text_param type: object type: enum: - dropdown - numeric - text type: string required: - key - label - type title: custom_field_param type: object type: array custom_text: description: Display additional text for your customers using custom text. properties: after_submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string shipping_address: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string terms_of_service_acceptance: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string title: custom_text_param type: object customer_creation: description: Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). enum: - always - if_required type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array inactive_message: description: The custom message to be displayed to a customer when a payment link is no longer active. maxLength: 500 type: string invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: enabled: type: boolean invoice_data: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string custom_fields: anyOf: - items: properties: name: maxLength: 30 type: string value: maxLength: 30 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: maxLength: 1500 type: string footer: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: rendering_options_param type: object - enum: - '' type: string title: invoice_settings_params type: object required: - enabled title: invoice_creation_create_params type: object line_items: description: The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. items: properties: adjustable_quantity: properties: enabled: type: boolean maximum: type: integer minimum: type: integer required: - enabled title: adjustable_quantity_params type: object price: maxLength: 5000 type: string quantity: type: integer required: - price - quantity title: line_items_create_params type: object type: array metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. type: object on_behalf_of: description: The account on behalf of which to charge. type: string payment_intent_data: description: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: capture_method: enum: - automatic - automatic_async - manual type: string description: maxLength: 1000 type: string metadata: additionalProperties: type: string type: object setup_future_usage: enum: - off_session - on_session type: string statement_descriptor: maxLength: 22 type: string statement_descriptor_suffix: maxLength: 22 type: string transfer_group: maxLength: 5000 type: string title: payment_intent_data_params type: object payment_method_collection: description: 'Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. If you''d like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).' enum: - always - if_required type: string payment_method_types: description: The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array phone_number_collection: description: 'Controls phone number collection settings during checkout. We recommend that you review your privacy policy and check with your legal contacts.' properties: enabled: type: boolean required: - enabled title: phone_number_collection_params type: object restrictions: description: Settings that restrict the usage of a payment link. properties: completed_sessions: properties: limit: type: integer required: - limit title: completed_sessions_params type: object required: - completed_sessions title: restrictions_params type: object shipping_address_collection: description: Configuration for collecting the customer's shipping address. properties: allowed_countries: items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: shipping_address_collection_params type: object shipping_options: description: The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. items: properties: shipping_rate: maxLength: 5000 type: string title: shipping_option_params type: object type: array submit_type: description: 'Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).' enum: - auto - book - donate - pay type: string subscription_data: description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. properties: description: maxLength: 500 type: string metadata: additionalProperties: type: string type: object trial_period_days: type: integer trial_settings: properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object title: subscription_data_params type: object tax_id_collection: description: Controls tax ID collection during checkout. properties: enabled: type: boolean required: - enabled title: tax_id_collection_params type: object transfer_data: description: The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. properties: amount: type: integer destination: type: string required: - destination title: transfer_data_params type: object PostPaymentIntentsIntentCancelRequest: type: object properties: cancellation_reason: description: 'Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`' enum: - abandoned - duplicate - fraudulent - requested_by_customer maxLength: 5000 type: string x-stripeBypassValidation: true expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array PaymentLinksResourceListLineItems: type: object required: - data - has_more - object - url properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string GetCustomersCustomerPaymentMethodsPaymentMethodRequest: type: object properties: {} GetPaymentMethodsRequest: type: object properties: {} PostPaymentMethodConfigurationsRequest: type: object properties: acss_debit: description: Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object affirm: description: '[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.' properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object afterpay_clearpay: description: Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object alipay: description: Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay: description: Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay_later: description: Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object au_becs_debit: description: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bacs_debit: description: Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bancontact: description: Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object blik: description: BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object boleto: description: Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object card: description: Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cartes_bancaires: description: Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cashapp: description: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object eps: description: EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object giropay: description: giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object google_pay: description: Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object grabpay: description: GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object ideal: description: iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object jcb: description: JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object klarna: description: Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object konbini: description: Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object link: description: '[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.' properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object name: description: Configuration name. maxLength: 100 type: string oxxo: description: OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object p24: description: Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object parent: description: Configuration's parent configuration. Specify to create a child configuration. maxLength: 100 type: string paynow: description: PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paypal: description: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object promptpay: description: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object revolut_pay: description: Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sepa_debit: description: The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sofort: description: Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object us_bank_account: description: Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object wechat_pay: description: WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object PostPaymentMethodsPaymentMethodAttachRequest: type: object required: - customer properties: customer: description: The ID of the customer to which to attach the PaymentMethod. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_method_domain: description: 'A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown. Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).' properties: apple_pay: $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status' created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer domain_name: description: The domain name that this payment method domain object represents. maxLength: 5000 type: string enabled: description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean google_pay: $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status' id: description: Unique identifier for the object. maxLength: 5000 type: string link: $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. enum: - payment_method_domain type: string paypal: $ref: '#/components/schemas/payment_method_domain_resource_payment_method_status' required: - apple_pay - created - domain_name - enabled - google_pay - id - link - livemode - object - paypal title: PaymentMethodDomainResourcePaymentMethodDomain type: object x-expandableFields: - apple_pay - google_pay - link - paypal x-resourceId: payment_method_domain PostPaymentMethodsRequest: type: object properties: acss_debit: description: If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: description: If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. properties: {} title: param type: object afterpay_clearpay: description: If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. properties: {} title: param type: object alipay: description: If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. properties: {} title: param type: object au_becs_debit: description: If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: description: If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: description: If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. properties: {} title: param type: object billing_details: description: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: description: If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. properties: {} title: param type: object boleto: description: If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object card: anyOf: - properties: cvc: maxLength: 5000 type: string exp_month: type: integer exp_year: type: integer number: maxLength: 5000 type: string required: - exp_month - exp_year - number title: card_details_params type: object - properties: token: maxLength: 5000 type: string required: - token title: token_params type: object description: 'If this is a `card` PaymentMethod, this hash contains the user''s card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.' x-stripeBypassValidation: true cashapp: description: If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. properties: {} title: param type: object customer: description: The `Customer` to whom the original PaymentMethod is attached. maxLength: 5000 type: string customer_balance: description: If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. properties: {} title: param type: object eps: description: If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. properties: bank: enum: - arzte_und_apotheker_bank - austrian_anadi_bank_ag - bank_austria - bankhaus_carl_spangler - bankhaus_schelhammer_und_schattera_ag - bawag_psk_ag - bks_bank_ag - brull_kallmus_bank_ag - btv_vier_lander_bank - capital_bank_grawe_gruppe_ag - deutsche_bank_ag - dolomitenbank - easybank_ag - erste_bank_und_sparkassen - hypo_alpeadriabank_international_ag - hypo_bank_burgenland_aktiengesellschaft - hypo_noe_lb_fur_niederosterreich_u_wien - hypo_oberosterreich_salzburg_steiermark - hypo_tirol_bank_ag - hypo_vorarlberg_bank_ag - marchfelder_bank - oberbank_ag - raiffeisen_bankengruppe_osterreich - schoellerbank_ag - sparda_bank_wien - volksbank_gruppe - volkskreditbank_ag - vr_bank_braunau maxLength: 5000 type: string title: param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. properties: bank: enum: - affin_bank - agrobank - alliance_bank - ambank - bank_islam - bank_muamalat - bank_of_china - bank_rakyat - bsn - cimb - deutsche_bank - hong_leong_bank - hsbc - kfh - maybank2e - maybank2u - ocbc - pb_enterprise - public_bank - rhb - standard_chartered - uob maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: description: If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. properties: {} title: param type: object grabpay: description: If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. properties: {} title: param type: object ideal: description: If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: description: If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. properties: {} title: param type: object klarna: description: If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: description: If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. properties: {} title: param type: object link: description: If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. properties: {} title: param type: object metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. type: object oxxo: description: If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. properties: {} title: param type: object p24: description: If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. properties: bank: enum: - alior_bank - bank_millennium - bank_nowy_bfg_sa - bank_pekao_sa - banki_spbdzielcze - blik - bnp_paribas - boz - citi_handlowy - credit_agricole - envelobank - etransfer_pocztowy24 - getin_bank - ideabank - ing - inteligo - mbank_mtransfer - nest_przelew - noble_pay - pbac_z_ipko - plus_bank - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank - volkswagen_bank type: string x-stripeBypassValidation: true title: param type: object payment_method: description: The PaymentMethod to share. maxLength: 5000 type: string paynow: description: If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. properties: {} title: param type: object paypal: description: If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. properties: {} title: param type: object pix: description: If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. properties: {} title: param type: object promptpay: description: If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. properties: {} title: param type: object radar_options: description: Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. properties: session: maxLength: 5000 type: string title: radar_options type: object revolut_pay: description: If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. properties: {} title: param type: object sepa_debit: description: If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: description: If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object type: description: 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. enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: description: If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: description: If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. properties: {} title: param type: object zip: description: If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. properties: {} title: param type: object PostPaymentLinksPaymentLinkRequest: type: object properties: active: description: Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. type: boolean after_completion: description: Behavior after the purchase is complete. properties: hosted_confirmation: properties: custom_message: maxLength: 500 type: string title: after_completion_confirmation_page_params type: object redirect: properties: url: maxLength: 2048 type: string required: - url title: after_completion_redirect_params type: object type: enum: - hosted_confirmation - redirect type: string required: - type title: after_completion_params type: object allow_promotion_codes: description: Enables user redeemable promotion codes. type: boolean automatic_tax: description: Configuration for automatic tax collection. properties: enabled: type: boolean required: - enabled title: automatic_tax_params type: object billing_address_collection: description: Configuration for collecting the customer's billing address. enum: - auto - required type: string custom_fields: anyOf: - items: properties: dropdown: properties: options: items: properties: label: maxLength: 100 type: string value: maxLength: 100 type: string required: - label - value title: custom_field_option_param type: object type: array required: - options title: custom_field_dropdown_param type: object key: maxLength: 200 type: string label: properties: custom: maxLength: 50 type: string type: enum: - custom type: string required: - custom - type title: custom_field_label_param type: object numeric: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_numeric_param type: object optional: type: boolean text: properties: maximum_length: type: integer minimum_length: type: integer title: custom_field_text_param type: object type: enum: - dropdown - numeric - text type: string required: - key - label - type title: custom_field_param type: object type: array - enum: - '' type: string description: Collect additional information from your customer using custom fields. Up to 2 fields are supported. custom_text: description: Display additional text for your customers using custom text. properties: after_submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string shipping_address: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string submit: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string terms_of_service_acceptance: anyOf: - properties: message: maxLength: 1200 type: string required: - message title: custom_text_position_param type: object - enum: - '' type: string title: custom_text_param type: object customer_creation: description: Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). enum: - always - if_required type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array inactive_message: anyOf: - maxLength: 500 type: string - enum: - '' type: string description: The custom message to be displayed to a customer when a payment link is no longer active. invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: enabled: type: boolean invoice_data: properties: account_tax_ids: anyOf: - items: maxLength: 5000 type: string type: array - enum: - '' type: string custom_fields: anyOf: - items: properties: name: maxLength: 30 type: string value: maxLength: 30 type: string required: - name - value title: custom_field_params type: object type: array - enum: - '' type: string description: maxLength: 1500 type: string footer: maxLength: 5000 type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string rendering_options: anyOf: - properties: amount_tax_display: enum: - '' - exclude_tax - include_inclusive_tax type: string title: rendering_options_param type: object - enum: - '' type: string title: invoice_settings_params type: object required: - enabled title: invoice_creation_update_params type: object line_items: description: The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. items: properties: adjustable_quantity: properties: enabled: type: boolean maximum: type: integer minimum: type: integer required: - enabled title: adjustable_quantity_params type: object id: maxLength: 5000 type: string quantity: type: integer required: - id title: line_items_update_params type: object type: array metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. type: object payment_intent_data: description: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: description: anyOf: - maxLength: 1000 type: string - enum: - '' type: string metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string statement_descriptor: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix: anyOf: - maxLength: 22 type: string - enum: - '' type: string transfer_group: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: payment_intent_data_update_params type: object payment_method_collection: description: 'Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. If you''d like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).' enum: - always - if_required type: string payment_method_types: anyOf: - items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true type: array - enum: - '' type: string description: The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). restrictions: anyOf: - properties: completed_sessions: properties: limit: type: integer required: - limit title: completed_sessions_params type: object required: - completed_sessions title: restrictions_params type: object - enum: - '' type: string description: Settings that restrict the usage of a payment link. shipping_address_collection: anyOf: - properties: allowed_countries: items: enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MK - ML - MM - MN - MO - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW - ZZ type: string type: array required: - allowed_countries title: shipping_address_collection_params type: object - enum: - '' type: string description: Configuration for collecting the customer's shipping address. subscription_data: description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. properties: metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string trial_settings: anyOf: - properties: end_behavior: properties: missing_payment_method: enum: - cancel - create_invoice - pause type: string required: - missing_payment_method title: end_behavior type: object required: - end_behavior title: trial_settings_config type: object - enum: - '' type: string title: subscription_data_update_params type: object GetPaymentMethodDomainsPaymentMethodDomainRequest: type: object properties: {} PaymentMethodConfigResourcePaymentMethodConfigurationsList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_method_configuration' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string GetPaymentMethodConfigurationsRequest: type: object properties: {} GetPaymentLinksRequest: type: object properties: {} PostPaymentMethodsPaymentMethodRequest: type: object properties: billing_details: description: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object card: description: If this is a `card` PaymentMethod, this hash contains the user's card details. properties: exp_month: type: integer exp_year: type: integer title: update_api_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array link: description: If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. properties: {} title: param type: object metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. us_bank_account: description: If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. properties: account_holder_type: enum: - company - individual type: string title: update_param type: object GetPaymentIntentsIntentRequest: type: object properties: {} SearchResult: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_intent' type: array has_more: type: boolean next_page: maxLength: 5000 nullable: true type: string object: description: String representing the object's type. Objects of the same type share the same value. enum: - search_result type: string total_count: description: The total number of objects that match the query, only accurate up to 10,000. type: integer url: maxLength: 5000 type: string deleted_customer: description: '' properties: deleted: description: Always true for a deleted object enum: - true type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string object: description: String representing the object's type. Objects of the same type share the same value. enum: - customer type: string required: - deleted - id - object title: DeletedCustomer type: object x-expandableFields: [] x-resourceId: deleted_customer GetCustomersCustomerPaymentMethodsRequest: type: object properties: {} GetPaymentMethodDomainsRequest: type: object properties: {} customer: description: 'This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)' properties: address: anyOf: - $ref: '#/components/schemas/address' description: The customer's address. nullable: true balance: description: The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. type: integer cash_balance: anyOf: - $ref: '#/components/schemas/cash_balance' description: The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. nullable: true created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. maxLength: 5000 nullable: true type: string default_source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: 'ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' x-stripeBypassValidation: true delinquent: description: 'Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn''t reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.' nullable: true type: boolean description: description: An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string discount: anyOf: - $ref: '#/components/schemas/discount' description: Describes the current discount active on the customer, if there is one. nullable: true email: description: The customer's email address. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string invoice_credit_balance: additionalProperties: type: integer description: The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. type: object invoice_prefix: description: The prefix for the customer used to generate unique invoice numbers. maxLength: 5000 nullable: true type: string invoice_settings: $ref: '#/components/schemas/invoice_setting_customer_setting' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object name: description: The customer's full name or business name. maxLength: 5000 nullable: true type: string next_invoice_sequence: description: The suffix of the customer's next invoice number (for example, 0001). type: integer object: description: String representing the object's type. Objects of the same type share the same value. enum: - customer type: string phone: description: The customer's phone number. maxLength: 5000 nullable: true type: string preferred_locales: description: The customer's preferred locales (languages), ordered by preference. items: maxLength: 5000 type: string nullable: true type: array shipping: anyOf: - $ref: '#/components/schemas/shipping' description: Mailing and shipping address for the customer. Appears on invoices emailed to this customer. nullable: true sources: description: The customer's payment sources, if any. properties: data: description: Details about each object. items: anyOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' title: Polymorphic x-stripeBypassValidation: true type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: ApmsSourcesSourceList type: object x-expandableFields: - data subscriptions: description: The customer's current subscriptions, if any. properties: data: description: Details about each object. items: $ref: '#/components/schemas/subscription' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: SubscriptionList type: object x-expandableFields: - data tax: $ref: '#/components/schemas/customer_tax' tax_exempt: description: 'Describes the customer''s tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.' enum: - exempt - none - reverse nullable: true type: string tax_ids: description: The customer's tax IDs. properties: data: description: Details about each object. items: $ref: '#/components/schemas/tax_id' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: TaxIDsList type: object x-expandableFields: - data test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock that this customer belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' required: - created - id - livemode - object title: Customer type: object x-expandableFields: - address - cash_balance - default_source - discount - invoice_settings - shipping - sources - subscriptions - tax - tax_ids - test_clock x-resourceId: customer PostPaymentMethodsPaymentMethodDetachRequest: type: object properties: expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array GetPaymentMethodConfigurationsConfigurationRequest: type: object properties: {} PostPaymentIntentsRequest: type: object required: - amount - currency properties: amount: description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: integer automatic_payment_methods: description: When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters. properties: allow_redirects: enum: - always - never type: string enabled: type: boolean required: - enabled title: automatic_payment_methods_param type: object capture_method: description: Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string confirm: description: Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). type: boolean confirmation_method: description: Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. enum: - automatic - manual type: string currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string customer: description: 'ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.' maxLength: 5000 type: string description: description: An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string error_on_requires_action: description: Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate: description: ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). maxLength: 5000 type: string mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string description: This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. type: object off_session: anyOf: - type: boolean - enum: - one_off - recurring maxLength: 5000 type: string description: Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). on_behalf_of: description: The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: string payment_method: description: 'ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. If you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent''s payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.' maxLength: 5000 type: string payment_method_configuration: description: The ID of the payment method configuration to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.' properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - arzte_und_apotheker_bank - austrian_anadi_bank_ag - bank_austria - bankhaus_carl_spangler - bankhaus_schelhammer_und_schattera_ag - bawag_psk_ag - bks_bank_ag - brull_kallmus_bank_ag - btv_vier_lander_bank - capital_bank_grawe_gruppe_ag - deutsche_bank_ag - dolomitenbank - easybank_ag - erste_bank_und_sparkassen - hypo_alpeadriabank_international_ag - hypo_bank_burgenland_aktiengesellschaft - hypo_noe_lb_fur_niederosterreich_u_wien - hypo_oberosterreich_salzburg_steiermark - hypo_tirol_bank_ag - hypo_vorarlberg_bank_ag - marchfelder_bank - oberbank_ag - raiffeisen_bankengruppe_osterreich - schoellerbank_ag - sparda_bank_wien - volksbank_gruppe - volkskreditbank_ag - vr_bank_braunau maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - affin_bank - agrobank - alliance_bank - ambank - bank_islam - bank_muamalat - bank_of_china - bank_rakyat - bsn - cimb - deutsche_bank - hong_leong_bank - hsbc - kfh - maybank2e - maybank2u - ocbc - pb_enterprise - public_bank - rhb - standard_chartered - uob maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - alior_bank - bank_millennium - bank_nowy_bfg_sa - bank_pekao_sa - banki_spbdzielcze - blik - bnp_paribas - boz - citi_handlowy - credit_agricole - envelobank - etransfer_pocztowy24 - getin_bank - ideabank - ing - inteligo - mbank_mtransfer - nest_przelew - noble_pay - pbac_z_ipko - plus_bank - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank - volkswagen_bank type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - N - R - U - Y type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array radar_options: description: Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object receipt_email: description: Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails). type: string return_url: description: 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 can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). type: string setup_future_usage: description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).' enum: - off_session - on_session type: string shipping: description: Shipping information for this PaymentIntent. properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object statement_descriptor: description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: Provides information about a card payment 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. The concatenated descriptor must contain 1-22 characters. maxLength: 22 type: string transfer_data: description: 'The parameters that you can use to automatically create a Transfer. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).' properties: amount: type: integer destination: type: string required: - destination title: transfer_data_creation_params type: object transfer_group: description: A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). type: string use_stripe_sdk: description: Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean card: description: 'You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' address_city: description: City/District/Suburb/Town/Village. maxLength: 5000 nullable: true type: string address_country: description: Billing address country, if provided when creating card. maxLength: 5000 nullable: true type: string address_line1: description: Address line 1 (Street address/PO Box/Company name). maxLength: 5000 nullable: true type: string address_line1_check: description: 'If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.' maxLength: 5000 nullable: true type: string address_line2: description: Address line 2 (Apartment/Suite/Unit/Building). maxLength: 5000 nullable: true type: string address_state: description: State/County/Province/Region. maxLength: 5000 nullable: true type: string address_zip: description: ZIP or postal code. maxLength: 5000 nullable: true type: string address_zip_check: description: 'If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.' maxLength: 5000 nullable: true type: string available_payout_methods: description: A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. items: enum: - instant - standard type: string nullable: true type: array brand: description: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. maxLength: 5000 type: string country: description: 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. maxLength: 5000 nullable: true type: string currency: description: Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. nullable: true type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' cvc_check: description: 'If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn''t been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).' maxLength: 5000 nullable: true type: string default_for_currency: description: Whether this card is the default external account for its currency. nullable: true type: boolean dynamic_last4: description: (For tokenized numbers only.) The last four digits of the device account number. maxLength: 5000 nullable: true type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: '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. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same cardone for India and one for the rest of the world.*' maxLength: 5000 nullable: true type: string funding: description: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. maxLength: 5000 type: string id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last four digits of the card. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object name: description: Cardholder name. maxLength: 5000 nullable: true type: string object: description: String representing the object's type. Objects of the same type share the same value. enum: - card type: string status: description: For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. maxLength: 5000 nullable: true type: string tokenization_method: description: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. maxLength: 5000 nullable: true type: string required: - brand - exp_month - exp_year - funding - id - last4 - object title: Card type: object x-expandableFields: - account - customer x-resourceId: card PaymentFlowsPaymentMethodList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_method' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_methods type: string GetPaymentMethodsPaymentMethodRequest: type: object properties: {} PostPaymentMethodDomainsRequest: type: object required: - domain_name properties: domain_name: description: The domain name that this payment method domain object represents. maxLength: 5000 type: string enabled: description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array PostPaymentMethodConfigurationsConfigurationRequest: type: object properties: acss_debit: description: Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object active: description: Whether the configuration can be used for new payments. type: boolean affirm: description: '[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.' properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object afterpay_clearpay: description: Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object alipay: description: Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay: description: Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object apple_pay_later: description: Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object au_becs_debit: description: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bacs_debit: description: Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object bancontact: description: Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object blik: description: BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object boleto: description: Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object card: description: Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cartes_bancaires: description: Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cashapp: description: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object eps: description: EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array fpx: description: Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object giropay: description: giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object google_pay: description: Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object grabpay: description: GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object ideal: description: iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object jcb: description: JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object klarna: description: Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object konbini: description: Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object link: description: '[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.' properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object name: description: Configuration name. maxLength: 100 type: string oxxo: description: OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object p24: description: Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paynow: description: PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object paypal: description: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object promptpay: description: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object revolut_pay: description: Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sepa_debit: description: The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object sofort: description: Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object us_bank_account: description: Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object wechat_pay: description: WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. properties: display_preference: properties: preference: enum: - none - 'off' - 'on' type: string title: display_preference_param type: object title: payment_method_param type: object cash_balance: description: A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. properties: available: additionalProperties: type: integer description: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). nullable: true type: object customer: description: The ID of the customer whose cash balance this object represents. maxLength: 5000 type: string livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. enum: - cash_balance type: string settings: $ref: '#/components/schemas/customer_balance_customer_balance_settings' required: - customer - livemode - object - settings title: cash_balance type: object x-expandableFields: - settings x-resourceId: cash_balance PostPaymentIntentsIntentVerifyMicrodepositsRequest: type: object properties: amounts: description: Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. items: type: integer type: array client_secret: description: The client secret of the PaymentIntent. maxLength: 5000 type: string descriptor_code: description: A six-character code starting with SM present in the microdeposit sent to the bank account. maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array PostPaymentIntentsIntentApplyCustomerBalanceRequest: type: object properties: amount: description: 'Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.' type: integer currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array subscription: description: 'Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)' properties: application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: ID of the Connect Application that created the subscription. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_percent: description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. nullable: true type: number automatic_tax: $ref: '#/components/schemas/subscription_automatic_tax' billing_cycle_anchor: description: Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. format: unix-time type: integer billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' description: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period nullable: true cancel_at: description: A date in the future at which the subscription will automatically get canceled format: unix-time nullable: true type: integer cancel_at_period_end: description: If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. type: boolean canceled_at: description: If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. format: unix-time nullable: true type: integer cancellation_details: anyOf: - $ref: '#/components/schemas/cancellation_details' description: Details about why this subscription was cancelled nullable: true collection_method: description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. enum: - charge_automatically - send_invoice type: string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string current_period_end: description: End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. format: unix-time type: integer current_period_start: description: Start of the current period that the subscription has been invoiced for. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: ID of the customer who owns the subscription. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' days_until_due: description: Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. nullable: true type: integer default_payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' default_source: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/bank_account' - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' x-stripeBypassValidation: true default_tax_rates: description: 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. items: $ref: '#/components/schemas/tax_rate' nullable: true type: array description: description: The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. maxLength: 500 nullable: true type: string discount: anyOf: - $ref: '#/components/schemas/discount' description: 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. nullable: true ended_at: description: If the subscription has ended, the date the subscription ended. format: unix-time nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string items: description: List of subscription items, each with an attached price. properties: data: description: Details about each object. items: $ref: '#/components/schemas/subscription_item' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: SubscriptionItemList type: object x-expandableFields: - data latest_invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: The most recent invoice this subscription has generated. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object next_pending_invoice_item_invoice: description: Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. format: unix-time nullable: true type: integer object: description: String representing the object's type. Objects of the same type share the same value. enum: - subscription type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' pause_collection: anyOf: - $ref: '#/components/schemas/subscriptions_resource_pause_collection' description: If specified, payment collection for this subscription will be paused. nullable: true payment_settings: anyOf: - $ref: '#/components/schemas/subscriptions_resource_payment_settings' description: Payment settings passed on to invoices created by the subscription. nullable: true pending_invoice_item_interval: anyOf: - $ref: '#/components/schemas/subscription_pending_invoice_item_interval' description: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. nullable: true pending_setup_intent: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/setup_intent' description: You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/setup_intent' pending_update: anyOf: - $ref: '#/components/schemas/subscriptions_resource_pending_update' description: If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. nullable: true schedule: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription_schedule' description: The schedule attached to the subscription nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription_schedule' start_date: description: Date when the subscription was first created. The date might differ from the `created` date due to backdating. format: unix-time type: integer status: description: "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices." enum: - active - canceled - incomplete - incomplete_expired - past_due - paused - trialing - unpaid type: string test_clock: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' description: ID of the test clock this subscription belongs to. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' transfer_data: anyOf: - $ref: '#/components/schemas/subscription_transfer_data' description: The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. nullable: true trial_end: description: If the subscription has a trial, the end of that trial. format: unix-time nullable: true type: integer trial_settings: anyOf: - $ref: '#/components/schemas/subscriptions_trials_resource_trial_settings' description: Settings related to subscription trials. nullable: true trial_start: description: If the subscription has a trial, the beginning of that trial. format: unix-time nullable: true type: integer required: - automatic_tax - billing_cycle_anchor - cancel_at_period_end - collection_method - created - currency - current_period_end - current_period_start - customer - id - items - livemode - metadata - object - start_date - status title: Subscription type: object x-expandableFields: - application - automatic_tax - billing_thresholds - cancellation_details - customer - default_payment_method - default_source - default_tax_rates - discount - items - latest_invoice - on_behalf_of - pause_collection - payment_settings - pending_invoice_item_interval - pending_setup_intent - pending_update - schedule - test_clock - transfer_data - trial_settings x-resourceId: subscription bank_account: description: 'These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)' properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The ID of the account that the bank account is associated with. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' account_holder_name: description: The name of the person or business that owns the bank account. maxLength: 5000 nullable: true type: string account_holder_type: description: The type of entity that holds the account. This can be either `individual` or `company`. maxLength: 5000 nullable: true type: string account_type: description: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. maxLength: 5000 nullable: true type: string available_payout_methods: description: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. items: enum: - instant - standard type: string nullable: true type: array bank_name: description: Name of the bank associated with the routing number (e.g., `WELLS FARGO`). maxLength: 5000 nullable: true type: string country: description: Two-letter ISO code representing the country the bank account is located in. maxLength: 5000 type: string currency: description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer that the bank account is associated with. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' default_for_currency: description: Whether this bank account is the default external account for its currency. nullable: true type: boolean fingerprint: description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. maxLength: 5000 nullable: true type: string future_requirements: anyOf: - $ref: '#/components/schemas/external_account_requirements' description: Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. nullable: true id: description: Unique identifier for the object. maxLength: 5000 type: string last4: description: The last four digits of the bank account number. maxLength: 5000 type: string metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object object: description: String representing the object's type. Objects of the same type share the same value. enum: - bank_account type: string requirements: anyOf: - $ref: '#/components/schemas/external_account_requirements' description: Information about the requirements for the bank account, including what information needs to be collected. nullable: true routing_number: description: The routing transit number for the bank account. maxLength: 5000 nullable: true type: string status: description: 'For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn''t had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we''ll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can''t [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we''ll set the status to `verification_failed`. Other validations aren''t run against external accounts because they''re only used for payouts. This means the other statuses don''t apply.' maxLength: 5000 type: string required: - country - currency - id - last4 - object - status title: BankAccount type: object x-expandableFields: - account - customer - future_requirements - requirements x-resourceId: bank_account error: description: An error response from the Stripe API properties: error: $ref: '#/components/schemas/api_errors' required: - error type: object PaymentMethodDomainResourcePaymentMethodDomainList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_method_domain' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_method_domains type: string discount: description: 'A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)' properties: checkout_session: description: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. maxLength: 5000 nullable: true type: string coupon: $ref: '#/components/schemas/coupon' customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: The ID of the customer associated with this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' end: description: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. format: unix-time nullable: true type: integer id: description: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. maxLength: 5000 type: string invoice: description: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. maxLength: 5000 nullable: true type: string invoice_item: description: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. maxLength: 5000 nullable: true type: string object: description: String representing the object's type. Objects of the same type share the same value. enum: - discount type: string promotion_code: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/promotion_code' description: The promotion code applied to create this discount. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' start: description: Date that the coupon was applied. format: unix-time type: integer subscription: description: The subscription that this coupon is applied to, if it is applied to a particular subscription. maxLength: 5000 nullable: true type: string required: - coupon - id - object - start title: Discount type: object x-expandableFields: - coupon - customer - promotion_code x-resourceId: discount GetPaymentIntentsSearchRequest: type: object properties: {} PostPaymentMethodDomainsPaymentMethodDomainRequest: type: object properties: enabled: description: Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array payment_intent: description: 'A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)' properties: amount: description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer amount_capturable: description: Amount that can be captured from this PaymentIntent. type: integer amount_details: $ref: '#/components/schemas/payment_flows_amount_details' amount_received: description: Amount that this PaymentIntent collects. type: integer application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' description: ID of the Connect application that created the PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). nullable: true type: integer automatic_payment_methods: anyOf: - $ref: '#/components/schemas/payment_flows_automatic_payment_methods_payment_intent' description: Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) nullable: true canceled_at: description: Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. format: unix-time nullable: true type: integer cancellation_reason: description: 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`). enum: - abandoned - automatic - duplicate - failed_invoice - fraudulent - requested_by_customer - void_invoice nullable: true type: string capture_method: description: Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string client_secret: description: "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled." maxLength: 5000 nullable: true type: string confirmation_method: description: Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. enum: - automatic - manual type: string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: 'ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: description: An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 5000 nullable: true type: string id: description: Unique identifier for the object. maxLength: 5000 type: string invoice: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' description: ID of the invoice that created this PaymentIntent, if it exists. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/invoice' last_payment_error: anyOf: - $ref: '#/components/schemas/api_errors' description: The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. nullable: true latest_charge: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' description: The latest charge created by this PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). type: object next_action: anyOf: - $ref: '#/components/schemas/payment_intent_next_action' description: 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. nullable: true object: description: String representing the object's type. Objects of the same type share the same value. enum: - payment_intent type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_method: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' description: ID of the payment method used in this PaymentIntent. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' payment_method_configuration_details: anyOf: - $ref: '#/components/schemas/payment_method_config_biz_payment_method_configuration_details' description: Information about the payment method configuration used for this PaymentIntent. nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options' description: Payment-method-specific configuration for this PaymentIntent. nullable: true payment_method_types: description: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. items: maxLength: 5000 type: string type: array processing: anyOf: - $ref: '#/components/schemas/payment_intent_processing' description: If present, this property tells you about the processing state of the payment. nullable: true receipt_email: description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). maxLength: 5000 nullable: true type: string review: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/review' description: ID of the review associated with this PaymentIntent, if any. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/review' setup_future_usage: description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).' enum: - off_session - on_session nullable: true type: string shipping: anyOf: - $ref: '#/components/schemas/shipping' description: Shipping information for this PaymentIntent. nullable: true statement_descriptor: description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: Provides information about a card payment 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. maxLength: 5000 nullable: true type: string status: description: 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](https://stripe.com/docs/payments/intents#intent-statuses). enum: - canceled - processing - requires_action - requires_capture - requires_confirmation - requires_payment_method - succeeded type: string transfer_data: anyOf: - $ref: '#/components/schemas/transfer_data' description: The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). nullable: true transfer_group: description: A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). maxLength: 5000 nullable: true type: string required: - amount - capture_method - confirmation_method - created - currency - id - livemode - object - payment_method_types - status title: PaymentIntent type: object x-expandableFields: - amount_details - application - automatic_payment_methods - customer - invoice - last_payment_error - latest_charge - next_action - on_behalf_of - payment_method - payment_method_configuration_details - payment_method_options - processing - review - shipping - transfer_data x-resourceId: payment_intent PostPaymentIntentsIntentRequest: type: object properties: amount: description: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer application_fee_amount: anyOf: - type: integer - enum: - '' type: string description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). capture_method: description: Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string customer: description: 'ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent''s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.' maxLength: 5000 type: string description: description: An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. payment_method: description: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. maxLength: 5000 type: string payment_method_configuration: description: The ID of the payment method configuration to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.' properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - arzte_und_apotheker_bank - austrian_anadi_bank_ag - bank_austria - bankhaus_carl_spangler - bankhaus_schelhammer_und_schattera_ag - bawag_psk_ag - bks_bank_ag - brull_kallmus_bank_ag - btv_vier_lander_bank - capital_bank_grawe_gruppe_ag - deutsche_bank_ag - dolomitenbank - easybank_ag - erste_bank_und_sparkassen - hypo_alpeadriabank_international_ag - hypo_bank_burgenland_aktiengesellschaft - hypo_noe_lb_fur_niederosterreich_u_wien - hypo_oberosterreich_salzburg_steiermark - hypo_tirol_bank_ag - hypo_vorarlberg_bank_ag - marchfelder_bank - oberbank_ag - raiffeisen_bankengruppe_osterreich - schoellerbank_ag - sparda_bank_wien - volksbank_gruppe - volkskreditbank_ag - vr_bank_braunau maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - affin_bank - agrobank - alliance_bank - ambank - bank_islam - bank_muamalat - bank_of_china - bank_rakyat - bsn - cimb - deutsche_bank - hong_leong_bank - hsbc - kfh - maybank2e - maybank2u - ocbc - pb_enterprise - public_bank - rhb - standard_chartered - uob maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - alior_bank - bank_millennium - bank_nowy_bfg_sa - bank_pekao_sa - banki_spbdzielcze - blik - bnp_paribas - boz - citi_handlowy - credit_agricole - envelobank - etransfer_pocztowy24 - getin_bank - ideabank - ing - inteligo - mbank_mtransfer - nest_przelew - noble_pay - pbac_z_ipko - plus_bank - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank - volkswagen_bank type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment-method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - N - R - U - Y type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array receipt_email: anyOf: - type: string - enum: - '' type: string description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). setup_future_usage: description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.' enum: - '' - off_session - on_session type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object - enum: - '' type: string description: Shipping information for this PaymentIntent. statement_descriptor: description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: Provides information about a card payment 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. maxLength: 22 type: string transfer_data: description: Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). properties: amount: type: integer title: transfer_data_update_params type: object transfer_group: description: A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: string PostPaymentIntentsIntentConfirmRequest: type: object properties: capture_method: description: Controls when the funds will be captured from the customer's account. enum: - automatic - automatic_async - manual type: string client_secret: description: The client secret of the PaymentIntent. maxLength: 5000 type: string error_on_requires_action: description: Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). type: boolean expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array mandate: description: ID of the mandate that's used for this payment. maxLength: 5000 type: string mandate_data: anyOf: - properties: customer_acceptance: properties: accepted_at: format: unix-time type: integer offline: properties: {} title: offline_param type: object online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string required: - ip_address - user_agent title: online_param type: object type: enum: - offline - online maxLength: 5000 type: string required: - type title: customer_acceptance_param type: object required: - customer_acceptance title: secret_key_param type: object - enum: - '' type: string - description: This hash contains details about the Mandate to create properties: customer_acceptance: properties: online: properties: ip_address: type: string user_agent: maxLength: 5000 type: string title: online_param type: object type: enum: - online maxLength: 5000 type: string required: - online - type title: customer_acceptance_param type: object required: - customer_acceptance title: client_key_param type: object off_session: anyOf: - type: boolean - enum: - one_off - recurring maxLength: 5000 type: string description: Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). payment_method: description: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. maxLength: 5000 type: string payment_method_data: description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.' properties: acss_debit: properties: account_number: maxLength: 5000 type: string institution_number: maxLength: 5000 type: string transit_number: maxLength: 5000 type: string required: - account_number - institution_number - transit_number title: payment_method_param type: object affirm: properties: {} title: param type: object afterpay_clearpay: properties: {} title: param type: object alipay: properties: {} title: param type: object au_becs_debit: properties: account_number: maxLength: 5000 type: string bsb_number: maxLength: 5000 type: string required: - account_number - bsb_number title: param type: object bacs_debit: properties: account_number: maxLength: 5000 type: string sort_code: maxLength: 5000 type: string title: param type: object bancontact: properties: {} title: param type: object billing_details: properties: address: anyOf: - properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: billing_details_address type: object - enum: - '' type: string email: anyOf: - type: string - enum: - '' type: string name: anyOf: - maxLength: 5000 type: string - enum: - '' type: string phone: anyOf: - maxLength: 5000 type: string - enum: - '' type: string title: billing_details_inner_params type: object blik: properties: {} title: param type: object boleto: properties: tax_id: maxLength: 5000 type: string required: - tax_id title: param type: object cashapp: properties: {} title: param type: object customer_balance: properties: {} title: param type: object eps: properties: bank: enum: - arzte_und_apotheker_bank - austrian_anadi_bank_ag - bank_austria - bankhaus_carl_spangler - bankhaus_schelhammer_und_schattera_ag - bawag_psk_ag - bks_bank_ag - brull_kallmus_bank_ag - btv_vier_lander_bank - capital_bank_grawe_gruppe_ag - deutsche_bank_ag - dolomitenbank - easybank_ag - erste_bank_und_sparkassen - hypo_alpeadriabank_international_ag - hypo_bank_burgenland_aktiengesellschaft - hypo_noe_lb_fur_niederosterreich_u_wien - hypo_oberosterreich_salzburg_steiermark - hypo_tirol_bank_ag - hypo_vorarlberg_bank_ag - marchfelder_bank - oberbank_ag - raiffeisen_bankengruppe_osterreich - schoellerbank_ag - sparda_bank_wien - volksbank_gruppe - volkskreditbank_ag - vr_bank_braunau maxLength: 5000 type: string title: param type: object fpx: properties: bank: enum: - affin_bank - agrobank - alliance_bank - ambank - bank_islam - bank_muamalat - bank_of_china - bank_rakyat - bsn - cimb - deutsche_bank - hong_leong_bank - hsbc - kfh - maybank2e - maybank2u - ocbc - pb_enterprise - public_bank - rhb - standard_chartered - uob maxLength: 5000 type: string x-stripeBypassValidation: true required: - bank title: param type: object giropay: properties: {} title: param type: object grabpay: properties: {} title: param type: object ideal: properties: bank: enum: - abn_amro - asn_bank - bunq - handelsbanken - ing - knab - moneyou - n26 - rabobank - regiobank - revolut - sns_bank - triodos_bank - van_lanschot - yoursafe maxLength: 5000 type: string title: param type: object interac_present: properties: {} title: param type: object klarna: properties: dob: properties: day: type: integer month: type: integer year: type: integer required: - day - month - year title: date_of_birth type: object title: param type: object konbini: properties: {} title: param type: object link: properties: {} title: param type: object metadata: additionalProperties: type: string type: object oxxo: properties: {} title: param type: object p24: properties: bank: enum: - alior_bank - bank_millennium - bank_nowy_bfg_sa - bank_pekao_sa - banki_spbdzielcze - blik - bnp_paribas - boz - citi_handlowy - credit_agricole - envelobank - etransfer_pocztowy24 - getin_bank - ideabank - ing - inteligo - mbank_mtransfer - nest_przelew - noble_pay - pbac_z_ipko - plus_bank - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank - volkswagen_bank type: string x-stripeBypassValidation: true title: param type: object paynow: properties: {} title: param type: object paypal: properties: {} title: param type: object pix: properties: {} title: param type: object promptpay: properties: {} title: param type: object radar_options: properties: session: maxLength: 5000 type: string title: radar_options type: object revolut_pay: properties: {} title: param type: object sepa_debit: properties: iban: maxLength: 5000 type: string required: - iban title: param type: object sofort: properties: country: enum: - AT - BE - DE - ES - IT - NL type: string required: - country title: param type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: enum: - company - individual type: string account_number: maxLength: 5000 type: string account_type: enum: - checking - savings type: string financial_connections_account: maxLength: 5000 type: string routing_number: maxLength: 5000 type: string title: payment_method_param type: object wechat_pay: properties: {} title: param type: object zip: properties: {} title: param type: object required: - type title: payment_method_data_params type: object payment_method_options: description: Payment method-specific configuration for this PaymentIntent. properties: acss_debit: anyOf: - properties: mandate_options: properties: custom_mandate_url: anyOf: - type: string - enum: - '' type: string interval_description: maxLength: 500 type: string payment_schedule: enum: - combined - interval - sporadic type: string transaction_type: enum: - business - personal type: string title: payment_intent_payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string affirm: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: maxLength: 30 type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string afterpay_clearpay: anyOf: - properties: capture_method: enum: - '' - manual type: string reference: maxLength: 128 type: string setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string alipay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string au_becs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string bacs_debit: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string bancontact: anyOf: - properties: preferred_language: enum: - de - en - fr - nl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string blik: anyOf: - properties: code: maxLength: 5000 type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string boleto: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_method_options_param type: object - enum: - '' type: string card: anyOf: - properties: capture_method: enum: - '' - manual type: string cvc_token: maxLength: 5000 type: string installments: properties: enabled: type: boolean plan: anyOf: - properties: count: type: integer interval: enum: - month type: string type: enum: - fixed_count type: string required: - count - interval - type title: installment_plan type: object - enum: - '' type: string title: installments_param type: object mandate_options: properties: amount: type: integer amount_type: enum: - fixed - maximum type: string description: maxLength: 200 type: string end_date: format: unix-time type: integer interval: enum: - day - month - sporadic - week - year type: string interval_count: type: integer reference: maxLength: 80 type: string start_date: format: unix-time type: integer supported_types: items: enum: - india type: string type: array required: - amount - amount_type - interval - reference - start_date title: mandate_options_param type: object network: enum: - amex - cartes_bancaires - diners - discover - eftpos_au - interac - jcb - mastercard - unionpay - unknown - visa maxLength: 5000 type: string x-stripeBypassValidation: true request_extended_authorization: enum: - if_available - never type: string request_incremental_authorization: enum: - if_available - never type: string request_multicapture: enum: - if_available - never type: string request_overcapture: enum: - if_available - never type: string request_three_d_secure: enum: - any - automatic - challenge type: string x-stripeBypassValidation: true setup_future_usage: enum: - '' - none - off_session - on_session type: string statement_descriptor_suffix_kana: anyOf: - maxLength: 22 type: string - enum: - '' type: string statement_descriptor_suffix_kanji: anyOf: - maxLength: 17 type: string - enum: - '' type: string three_d_secure: properties: ares_trans_status: enum: - A - C - I - N - R - U - Y type: string cryptogram: maxLength: 5000 type: string electronic_commerce_indicator: enum: - '01' - '02' - '05' - '06' - '07' type: string x-stripeBypassValidation: true exemption_indicator: enum: - low_risk - none type: string network_options: properties: cartes_bancaires: properties: cb_avalgo: enum: - '0' - '1' - '2' - '3' - '4' - A type: string cb_exemption: maxLength: 4 type: string cb_score: type: integer required: - cb_avalgo title: cartes_bancaires_network_options_param type: object title: network_options_param type: object requestor_challenge_indicator: maxLength: 2 type: string transaction_id: maxLength: 5000 type: string version: enum: - 1.0.2 - 2.1.0 - 2.2.0 type: string x-stripeBypassValidation: true required: - cryptogram - transaction_id - version title: payment_method_options_param type: object title: payment_intent_param type: object - enum: - '' type: string card_present: anyOf: - properties: request_extended_authorization: type: boolean request_incremental_authorization_support: type: boolean title: payment_method_options_param type: object - enum: - '' type: string cashapp: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string customer_balance: anyOf: - properties: bank_transfer: properties: eu_bank_transfer: properties: country: maxLength: 5000 type: string required: - country title: eu_bank_transfer_params type: object requested_address_types: items: enum: - aba - iban - sepa - sort_code - spei - swift - zengin type: string x-stripeBypassValidation: true type: array type: enum: - eu_bank_transfer - gb_bank_transfer - jp_bank_transfer - mx_bank_transfer - us_bank_transfer type: string x-stripeBypassValidation: true required: - type title: bank_transfer_param type: object funding_type: enum: - bank_transfer type: string setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string eps: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string fpx: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string giropay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string grabpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string ideal: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string interac_present: anyOf: - properties: {} title: payment_method_options_param type: object - enum: - '' type: string klarna: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AT - en-AU - en-BE - en-CA - en-CH - en-CZ - en-DE - en-DK - en-ES - en-FI - en-FR - en-GB - en-GR - en-IE - en-IT - en-NL - en-NO - en-NZ - en-PL - en-PT - en-SE - en-US - es-ES - es-US - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - it-CH - it-IT - nb-NO - nl-BE - nl-NL - pl-PL - pt-PT - sv-FI - sv-SE type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: - '' type: string konbini: anyOf: - properties: confirmation_number: anyOf: - maxLength: 11 type: string - enum: - '' type: string expires_after_days: anyOf: - type: integer - enum: - '' type: string expires_at: anyOf: - format: unix-time type: integer - enum: - '' type: string product_description: anyOf: - maxLength: 22 type: string - enum: - '' type: string setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string link: anyOf: - properties: capture_method: enum: - '' - manual type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string oxxo: anyOf: - properties: expires_after_days: type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string p24: anyOf: - properties: setup_future_usage: enum: - none type: string tos_shown_and_accepted: type: boolean title: payment_method_options_param type: object - enum: - '' type: string paynow: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string paypal: anyOf: - properties: capture_method: enum: - '' - manual type: string preferred_locale: enum: - cs-CZ - da-DK - de-AT - de-DE - de-LU - el-GR - en-GB - en-US - es-ES - fi-FI - fr-BE - fr-FR - fr-LU - hu-HU - it-IT - nl-BE - nl-NL - pl-PL - pt-PT - sk-SK - sv-SE type: string x-stripeBypassValidation: true reference: maxLength: 127 type: string risk_correlation_id: maxLength: 32 type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string pix: anyOf: - properties: expires_after_seconds: type: integer expires_at: format: unix-time type: integer setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string promptpay: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string revolut_pay: anyOf: - properties: setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string sepa_debit: anyOf: - properties: mandate_options: properties: {} title: payment_method_options_mandate_options_param type: object setup_future_usage: enum: - '' - none - off_session - on_session type: string title: payment_intent_payment_method_options_param type: object - enum: - '' type: string sofort: anyOf: - properties: preferred_language: enum: - '' - de - en - es - fr - it - nl - pl type: string setup_future_usage: enum: - '' - none - off_session type: string title: payment_method_options_param type: object - enum: - '' type: string us_bank_account: anyOf: - properties: financial_connections: properties: permissions: items: enum: - balances - ownership - payment_method - transactions maxLength: 5000 type: string x-stripeBypassValidation: true type: array prefetch: items: enum: - balances - transactions type: string x-stripeBypassValidation: true type: array return_url: maxLength: 5000 type: string title: linked_account_options_param type: object mandate_options: properties: collection_method: enum: - '' - paper type: string x-stripeBypassValidation: true title: mandate_options_param type: object networks: properties: requested: items: enum: - ach - us_domestic_wire type: string type: array title: networks_options_param type: object preferred_settlement_speed: enum: - '' - fastest - standard type: string setup_future_usage: enum: - '' - none - off_session - on_session type: string verification_method: enum: - automatic - instant - microdeposits type: string x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: - '' type: string wechat_pay: anyOf: - properties: app_id: maxLength: 5000 type: string client: enum: - android - ios - web type: string x-stripeBypassValidation: true setup_future_usage: enum: - none type: string required: - client title: payment_method_options_param type: object - enum: - '' type: string zip: anyOf: - properties: setup_future_usage: enum: - none type: string title: payment_method_options_param type: object - enum: - '' type: string title: payment_method_options_param type: object payment_method_types: description: The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string type: array radar_options: description: Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). properties: session: maxLength: 5000 type: string title: radar_options_with_hidden_options type: object receipt_email: anyOf: - type: string - enum: - '' type: string description: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). return_url: description: '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.' type: string setup_future_usage: description: 'Indicates that you intend to make future payments with this PaymentIntent''s payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent''s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.' enum: - '' - off_session - on_session type: string shipping: anyOf: - properties: address: properties: city: maxLength: 5000 type: string country: maxLength: 5000 type: string line1: maxLength: 5000 type: string line2: maxLength: 5000 type: string postal_code: maxLength: 5000 type: string state: maxLength: 5000 type: string title: optional_fields_address type: object carrier: maxLength: 5000 type: string name: maxLength: 5000 type: string phone: maxLength: 5000 type: string tracking_number: maxLength: 5000 type: string required: - address - name title: optional_fields_shipping type: object - enum: - '' type: string description: Shipping information for this PaymentIntent. use_stripe_sdk: description: Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. type: boolean tax_id: description: 'You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related invoices and credit notes. Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)' properties: country: description: Two-letter ISO code representing the country of the tax ID. maxLength: 5000 nullable: true type: string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: ID of the customer. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' id: description: Unique identifier for the object. maxLength: 5000 type: string livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. enum: - tax_id type: string type: description: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` enum: - ad_nrt - ae_trn - ar_cuit - au_abn - au_arn - bg_uic - bo_tin - br_cnpj - br_cpf - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - ch_vat - cl_tin - cn_tin - co_nit - cr_tin - do_rcn - ec_ruc - eg_tin - es_cif - eu_oss_vat - eu_vat - gb_vat - ge_vat - hk_br - hu_tin - id_npwp - il_vat - in_gst - is_vat - jp_cn - jp_rn - jp_trn - ke_pin - kr_brn - li_uid - mx_rfc - my_frp - my_itn - my_sst - no_vat - nz_gst - pe_ruc - ph_tin - ro_tin - rs_pib - ru_inn - ru_kpp - sa_vat - sg_gst - sg_uen - si_tin - sv_nit - th_vat - tr_tin - tw_vat - ua_vat - unknown - us_ein - uy_ruc - ve_rif - vn_tin - za_vat type: string value: description: Value of the tax ID. maxLength: 5000 type: string verification: anyOf: - $ref: '#/components/schemas/tax_id_verification' description: Tax ID verification information. nullable: true required: - created - id - livemode - object - type - value title: tax_id type: object x-expandableFields: - customer - verification x-resourceId: tax_id PaymentFlowsPaymentIntentList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_intent' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_intents type: string payment_link: description: 'A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links. Related guide: [Payment Links API](https://stripe.com/docs/payment-links)' properties: active: description: Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. type: boolean after_completion: $ref: '#/components/schemas/payment_links_resource_after_completion' allow_promotion_codes: description: Whether user redeemable promotion codes are enabled. type: boolean application: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' description: The ID of the Connect application that created the Payment Link. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. nullable: true type: integer application_fee_percent: description: This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. nullable: true type: number automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: description: Configuration for collecting the customer's billing address. enum: - auto - required type: string consent_collection: anyOf: - $ref: '#/components/schemas/payment_links_resource_consent_collection' description: When set, provides configuration to gather active consent from customers. nullable: true currency: description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string custom_fields: description: Collect additional information from your customer using custom fields. Up to 2 fields are supported. items: $ref: '#/components/schemas/payment_links_resource_custom_fields' type: array custom_text: $ref: '#/components/schemas/payment_links_resource_custom_text' customer_creation: description: Configuration for Customer creation during checkout. enum: - always - if_required type: string id: description: Unique identifier for the object. maxLength: 5000 type: string inactive_message: description: The custom message to be displayed to a customer when a payment link is no longer active. maxLength: 5000 nullable: true type: string invoice_creation: anyOf: - $ref: '#/components/schemas/payment_links_resource_invoice_creation' description: Configuration for creating invoice for payment mode payment links. nullable: true line_items: description: The line items representing what is being sold. properties: data: description: Details about each object. items: $ref: '#/components/schemas/item' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string required: - data - has_more - object - url title: PaymentLinksResourceListLineItems type: object x-expandableFields: - data livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object object: description: String representing the object's type. Objects of the same type share the same value. enum: - payment_link type: string on_behalf_of: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' description: The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' payment_intent_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_payment_intent_data' description: Indicates the parameters to be passed to PaymentIntent creation during checkout. nullable: true payment_method_collection: description: Configuration for collecting a payment method during checkout. enum: - always - if_required type: string payment_method_types: description: The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). items: enum: - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - cashapp - eps - fpx - giropay - grabpay - ideal - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - sepa_debit - sofort - us_bank_account - wechat_pay type: string x-stripeBypassValidation: true nullable: true type: array phone_number_collection: $ref: '#/components/schemas/payment_links_resource_phone_number_collection' restrictions: anyOf: - $ref: '#/components/schemas/payment_links_resource_restrictions' description: Settings that restrict the usage of a payment link. nullable: true shipping_address_collection: anyOf: - $ref: '#/components/schemas/payment_links_resource_shipping_address_collection' description: Configuration for collecting the customer's shipping address. nullable: true shipping_options: description: The shipping rate options applied to the session. items: $ref: '#/components/schemas/payment_links_resource_shipping_option' type: array submit_type: description: Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. enum: - auto - book - donate - pay type: string subscription_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_subscription_data' description: When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. nullable: true tax_id_collection: $ref: '#/components/schemas/payment_links_resource_tax_id_collection' transfer_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_transfer_data' description: The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. nullable: true url: description: The public URL that can be shared with customers. maxLength: 5000 type: string required: - active - after_completion - allow_promotion_codes - automatic_tax - billing_address_collection - currency - custom_fields - custom_text - customer_creation - id - livemode - metadata - object - payment_method_collection - phone_number_collection - shipping_options - submit_type - tax_id_collection - url title: PaymentLink type: object x-expandableFields: - after_completion - application - automatic_tax - consent_collection - custom_fields - custom_text - invoice_creation - line_items - on_behalf_of - payment_intent_data - phone_number_collection - restrictions - shipping_address_collection - shipping_options - subscription_data - tax_id_collection - transfer_data x-resourceId: payment_link PostPaymentIntentsIntentCaptureRequest: type: object properties: amount_to_capture: description: The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. type: integer application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array final_capture: description: Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. type: boolean metadata: anyOf: - additionalProperties: type: string type: object - enum: - '' type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. statement_descriptor: description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string statement_descriptor_suffix: description: Provides information about a card payment 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. The concatenated descriptor must be 1-22 characters long. maxLength: 22 type: string transfer_data: description: 'The parameters that you can use to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).' properties: amount: type: integer title: transfer_data_update_params type: object CustomerPaymentMethodResourceList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_method' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 type: string GetPaymentIntentsRequest: type: object properties: {} PostPaymentIntentsIntentIncrementAuthorizationRequest: type: object required: - amount properties: amount: description: The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. type: integer application_fee_amount: description: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). type: integer description: description: An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. type: object statement_descriptor: description: For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 type: string transfer_data: description: 'The parameters used to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).' properties: amount: type: integer title: transfer_data_update_params type: object payment_method: description: 'PaymentMethod objects represent your customer''s payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).' properties: acss_debit: $ref: '#/components/schemas/payment_method_acss_debit' affirm: $ref: '#/components/schemas/payment_method_affirm' afterpay_clearpay: $ref: '#/components/schemas/payment_method_afterpay_clearpay' alipay: $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay' au_becs_debit: $ref: '#/components/schemas/payment_method_au_becs_debit' bacs_debit: $ref: '#/components/schemas/payment_method_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_bancontact' billing_details: $ref: '#/components/schemas/billing_details' blik: $ref: '#/components/schemas/payment_method_blik' boleto: $ref: '#/components/schemas/payment_method_boleto' card: $ref: '#/components/schemas/payment_method_card' card_present: $ref: '#/components/schemas/payment_method_card_present' cashapp: $ref: '#/components/schemas/payment_method_cashapp' created: description: Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' description: The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: $ref: '#/components/schemas/payment_method_eps' fpx: $ref: '#/components/schemas/payment_method_fpx' giropay: $ref: '#/components/schemas/payment_method_giropay' grabpay: $ref: '#/components/schemas/payment_method_grabpay' id: description: Unique identifier for the object. maxLength: 5000 type: string ideal: $ref: '#/components/schemas/payment_method_ideal' interac_present: $ref: '#/components/schemas/payment_method_interac_present' klarna: $ref: '#/components/schemas/payment_method_klarna' konbini: $ref: '#/components/schemas/payment_method_konbini' link: $ref: '#/components/schemas/payment_method_link' livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean metadata: additionalProperties: maxLength: 500 type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object object: description: String representing the object's type. Objects of the same type share the same value. enum: - payment_method type: string oxxo: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' paynow: $ref: '#/components/schemas/payment_method_paynow' paypal: $ref: '#/components/schemas/payment_method_paypal' pix: $ref: '#/components/schemas/payment_method_pix' promptpay: $ref: '#/components/schemas/payment_method_promptpay' radar_options: $ref: '#/components/schemas/radar_radar_options' revolut_pay: $ref: '#/components/schemas/payment_method_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: $ref: '#/components/schemas/payment_method_sofort' type: description: 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. enum: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - blik - boleto - card - card_present - cashapp - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip type: string x-stripeBypassValidation: true us_bank_account: $ref: '#/components/schemas/payment_method_us_bank_account' wechat_pay: $ref: '#/components/schemas/payment_method_wechat_pay' zip: $ref: '#/components/schemas/payment_method_zip' required: - billing_details - created - id - livemode - object - type title: PaymentMethod type: object x-expandableFields: - acss_debit - affirm - afterpay_clearpay - alipay - au_becs_debit - bacs_debit - bancontact - billing_details - blik - boleto - card - card_present - cashapp - customer - customer_balance - eps - fpx - giropay - grabpay - ideal - interac_present - klarna - konbini - link - oxxo - p24 - paynow - paypal - pix - promptpay - radar_options - revolut_pay - sepa_debit - sofort - us_bank_account - wechat_pay - zip x-resourceId: payment_method PaymentLinksResourcePaymentLinkList: type: object required: - data - has_more - object - url properties: data: items: $ref: '#/components/schemas/payment_link' type: array has_more: description: True if this list has another page of items after this one that can be fetched. type: boolean object: description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`. enum: - list type: string url: description: The URL where this list can be accessed. maxLength: 5000 pattern: ^/v1/payment_links type: string