Retrieve the entitlement summary for a customer
", - "operationId": "GetCustomersCustomerEntitlementSummary", - "parameters": [ - { - "description": "The ID of the customer.", - "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" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/customer_entitlement_summary" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/customers/{customer}/entitlements": { - "get": { - "description": "Retrieve a list of entitlements for a customer
", - "operationId": "GetCustomersCustomerEntitlements", - "parameters": [ - { - "description": "The ID of the customer.", - "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": { - "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, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/customer_entitlement" - }, - "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": "EntitlementsResourceCustomerEntitlementList", - "type": "object", - "x-expandableFields": [ - "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, "/v1/customers/{customer}/funding_instructions": { "post": { "description": "Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.
", @@ -93862,6 +94017,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -96139,6 +96295,142 @@ } } }, + "/v1/entitlements/active_entitlements": { + "get": { + "description": "Retrieve a list of active entitlements for a customer
", + "operationId": "GetEntitlementsActiveEntitlements", + "parameters": [ + { + "description": "The ID of the customer.", + "in": "query", + "name": "customer", + "required": true, + "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, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/entitlements.active_entitlement" + }, + "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": "EntitlementsResourceCustomerEntitlementList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/entitlements/features": { "get": { "description": "Retrieve a list of features
", @@ -96274,6 +96566,10 @@ "expand": { "explode": true, "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -96292,6 +96588,13 @@ "maxLength": 80, "type": "string" }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, "name": { "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", "maxLength": 80, @@ -98916,7 +99219,291 @@ "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.", + "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" + }, + { + "description": "A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:", + "explode": true, + "in": "query", + "name": "transacted_at", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "description": "Minimum value to filter by (exclusive)", + "type": "integer" + }, + "gte": { + "description": "Minimum value to filter by (inclusive)", + "type": "integer" + }, + "lt": { + "description": "Maximum value to filter by (exclusive)", + "type": "integer" + }, + "lte": { + "description": "Maximum value to filter by (inclusive)", + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object" + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, + { + "description": "A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:", + "explode": true, + "in": "query", + "name": "transaction_refresh", + "required": false, + "schema": { + "properties": { + "after": { + "description": "Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "after" + ], + "title": "transaction_refresh_params", + "type": "object" + }, + "style": "deepObject" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/financial_connections.transaction" + }, + "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/financial_connections/transactions", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BankConnectionsResourceTransactionList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/financial_connections/transactions/{transaction}": { + "get": { + "description": "Retrieves the details of a Financial Connections Transaction
Lists all ForwardingRequest objects.
", + "operationId": "GetForwardingRequests", + "parameters": [ + { + "description": "Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "properties": { + "gt": { + "description": "Return results where the `created` field is greater than this value.", + "type": "integer" + }, + "gte": { + "description": "Return results where the `created` field is greater than or equal to this value.", + "type": "integer" + }, + "lt": { + "description": "Return results where the `created` field is less than this value.", + "type": "integer" + }, + "lte": { + "description": "Return results where the `created` field is less than or equal to this value.", + "type": "integer" + } + }, + "title": "created_param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.", + "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 pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.", "in": "query", "name": "starting_after", "required": false, @@ -98925,65 +99512,6 @@ "type": "string" }, "style": "form" - }, - { - "description": "A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:", - "explode": true, - "in": "query", - "name": "transacted_at", - "required": false, - "schema": { - "anyOf": [ - { - "properties": { - "gt": { - "description": "Minimum value to filter by (exclusive)", - "type": "integer" - }, - "gte": { - "description": "Minimum value to filter by (inclusive)", - "type": "integer" - }, - "lt": { - "description": "Maximum value to filter by (exclusive)", - "type": "integer" - }, - "lte": { - "description": "Maximum value to filter by (inclusive)", - "type": "integer" - } - }, - "title": "range_query_specs", - "type": "object" - }, - { - "type": "integer" - } - ] - }, - "style": "deepObject" - }, - { - "description": "A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:", - "explode": true, - "in": "query", - "name": "transaction_refresh", - "required": false, - "schema": { - "properties": { - "after": { - "description": "Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "after" - ], - "title": "transaction_refresh_params", - "type": "object" - }, - "style": "deepObject" } ], "requestBody": { @@ -99004,12 +99532,11 @@ "content": { "application/json": { "schema": { - "description": "", + "description": "List of ForwardingRequest data.", "properties": { "data": { - "description": "Details about each object.", "items": { - "$ref": "#/components/schemas/financial_connections.transaction" + "$ref": "#/components/schemas/forwarding.request" }, "type": "array" }, @@ -99027,7 +99554,6 @@ "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, - "pattern": "^/v1/financial_connections/transactions", "type": "string" } }, @@ -99037,7 +99563,7 @@ "object", "url" ], - "title": "BankConnectionsResourceTransactionList", + "title": "ForwardingRequestList", "type": "object", "x-expandableFields": [ "data" @@ -99058,12 +99584,143 @@ "description": "Error response." } } + }, + "post": { + "description": "Creates a ForwardingRequest object.
", + "operationId": "PostForwardingRequests", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "replacements": { + "explode": true, + "style": "deepObject" + }, + "request": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", + "maxLength": 5000, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_method": { + "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", + "maxLength": 5000, + "type": "string" + }, + "replacements": { + "description": "The field kinds to be replaced in the forwarded request.", + "items": { + "enum": [ + "card_cvc", + "card_expiry", + "card_number", + "cardholder_name" + ], + "type": "string" + }, + "type": "array" + }, + "request": { + "description": "The request body and headers to be sent to the destination endpoint.", + "properties": { + "body": { + "description": "The body payload to send to the destination endpoint.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", + "items": { + "properties": { + "name": { + "description": "The header name.", + "maxLength": 5000, + "type": "string" + }, + "value": { + "description": "The header value.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "title": "header_param", + "type": "object" + }, + "type": "array" + } + }, + "title": "request_param", + "type": "object" + }, + "url": { + "description": "The destination URL for the forwarded request. Must be supported by the config.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "config", + "payment_method", + "replacements", + "url" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/forwarding.request" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } } }, - "/v1/financial_connections/transactions/{transaction}": { + "/v1/forwarding/requests/{id}": { "get": { - "description": "Retrieves the details of a Financial Connections Transaction
Retrieves a ForwardingRequest object.
", + "operationId": "GetForwardingRequestsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", @@ -99082,7 +99739,7 @@ }, { "in": "path", - "name": "transaction", + "name": "id", "required": true, "schema": { "maxLength": 5000, @@ -99109,7 +99766,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/financial_connections.transaction" + "$ref": "#/components/schemas/forwarding.request" } } }, @@ -105650,7 +106307,7 @@ "type": "string" }, "pause_collection": { - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", @@ -108938,7 +109595,7 @@ "type": "string" }, "pause_collection": { - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", @@ -112214,7 +112871,7 @@ "type": "string" }, "pause_collection": { - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", @@ -133453,6 +134110,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -133640,6 +134303,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -134978,6 +135642,38 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding 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.\n\nWhen 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).\n\nIf `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": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, "multibanco": { "anyOf": [ { @@ -137478,6 +138174,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -137665,6 +138367,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -139003,6 +139706,38 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding 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.\n\nWhen 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).\n\nIf `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": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, "multibanco": { "anyOf": [ { @@ -142439,6 +143174,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -142626,6 +143367,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -143964,6 +144706,38 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding 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.\n\nWhen 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).\n\nIf `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": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, "multibanco": { "anyOf": [ { @@ -150657,6 +151431,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -150855,6 +151630,10 @@ "explode": true, "style": "deepObject" }, + "mobilepay": { + "explode": true, + "style": "deepObject" + }, "multibanco": { "explode": true, "style": "deepObject" @@ -151420,6 +152199,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -151613,6 +152398,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -166853,6 +167639,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -167040,6 +167832,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -168313,6 +169106,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -168500,6 +169299,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -169805,6 +170605,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -169992,6 +170798,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -175114,7 +175921,7 @@ "type": "string" }, "pause_collection": { - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", @@ -176324,7 +177131,7 @@ "type": "string" }, "pause_collection": { - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "properties": { "behavior": { "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", @@ -180518,7 +181325,7 @@ "type": "string" } ], - "description": "If specified, payment collection for this subscription will be paused." + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", @@ -189533,6 +190340,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "multibanco": { "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", "properties": {}, @@ -189720,6 +190533,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -201916,7 +202730,6 @@ "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", - "customer.entitlement_summary.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", @@ -201937,6 +202750,7 @@ "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", @@ -202423,7 +203237,6 @@ "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", - "customer.entitlement_summary.updated", "customer.source.created", "customer.source.deleted", "customer.source.expiring", @@ -202444,6 +203257,7 @@ "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 7e12da09..95c48663 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -6148,6 +6148,406 @@ "type": "object", "x-expandableFields": [] }, + "confirmation_token": { + "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more or request access, visit the related guided: [Finalize payments on the server using Confirmation Tokens](https://stripe.com/docs/payments/finalize-payments-on-the-server-confirmation-tokens).", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "expires_at": { + "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, + "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" + }, + "mandate_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data" + } + ], + "description": "Data used for generating a Mandate.", + "nullable": true + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "confirmation_token" + ], + "type": "string" + }, + "payment_intent": { + "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "payment_method_preview": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview" + } + ], + "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.", + "nullable": true + }, + "return_url": { + "description": "Return URL used to confirm the Intent.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property 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.", + "enum": [ + "off_session", + "on_session" + ], + "nullable": true, + "type": "string" + }, + "setup_intent": { + "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "shipping": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_shipping" + } + ], + "description": "Shipping information collected on this ConfirmationToken.", + "nullable": true + }, + "use_stripe_sdk": { + "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.", + "type": "boolean" + } + }, + "required": [ + "created", + "id", + "livemode", + "object", + "use_stripe_sdk" + ], + "title": "ConfirmationTokensResourceConfirmationToken", + "type": "object", + "x-expandableFields": [ + "mandate_data", + "payment_method_preview", + "shipping" + ], + "x-resourceId": "confirmation_token" + }, + "confirmation_tokens_resource_mandate_data": { + "description": "Data used for generating a Mandate.", + "properties": { + "customer_acceptance": { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance" + } + }, + "required": [ + "customer_acceptance" + ], + "title": "ConfirmationTokensResourceMandateData", + "type": "object", + "x-expandableFields": [ + "customer_acceptance" + ] + }, + "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": { + "description": "This hash contains details about the customer acceptance of the Mandate.", + "properties": { + "online": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online" + } + ], + "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", + "nullable": true + }, + "type": { + "description": "The type of customer acceptance information included with the Mandate.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance", + "type": "object", + "x-expandableFields": [ + "online" + ] + }, + "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": { + "description": "This hash contains details about the online acceptance.", + "properties": { + "ip_address": { + "description": "The IP address from which the Mandate was accepted by the customer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_agent": { + "description": "The user agent of the browser from which the Mandate was accepted by the customer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline", + "type": "object", + "x-expandableFields": [] + }, + "confirmation_tokens_resource_payment_method_preview": { + "description": "Details of the PaymentMethod collected by Payment Element", + "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" + }, + "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" + }, + "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" + }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_mobilepay" + }, + "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" + }, + "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" + }, + "swish": { + "$ref": "#/components/schemas/payment_method_swish" + }, + "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", + "mobilepay", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "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", + "type" + ], + "title": "ConfirmationTokensResourcePaymentMethodPreview", + "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_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "interac_present", + "klarna", + "konbini", + "link", + "mobilepay", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "us_bank_account", + "wechat_pay", + "zip" + ] + }, + "confirmation_tokens_resource_shipping": { + "description": "", + "properties": { + "address": { + "$ref": "#/components/schemas/address" + }, + "name": { + "description": "Recipient name.", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "description": "Recipient phone (including extension).", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "ConfirmationTokensResourceShipping", + "type": "object", + "x-expandableFields": [ + "address" + ] + }, "connect_account_reference": { "description": "", "properties": { @@ -11253,6 +11653,213 @@ "type": "object", "x-expandableFields": [] }, + "forwarded_request_context": { + "description": "Metadata about the forwarded request.", + "properties": { + "destination_duration": { + "description": "The time it took in milliseconds for the destination endpoint to respond.", + "type": "integer" + }, + "destination_ip_address": { + "description": "The IP address of the destination.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "destination_duration", + "destination_ip_address" + ], + "title": "ForwardedRequestContext", + "type": "object", + "x-expandableFields": [] + }, + "forwarded_request_details": { + "description": "Details about the request forwarded to the destination endpoint.", + "properties": { + "body": { + "description": "The body payload to send to the destination endpoint.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", + "items": { + "$ref": "#/components/schemas/forwarded_request_header" + }, + "type": "array" + }, + "http_method": { + "description": "The HTTP method used to call the destination endpoint.", + "enum": [ + "POST" + ], + "type": "string" + } + }, + "required": [ + "body", + "headers", + "http_method" + ], + "title": "ForwardedRequestDetails", + "type": "object", + "x-expandableFields": [ + "headers" + ] + }, + "forwarded_request_header": { + "description": "Header data.", + "properties": { + "name": { + "description": "The header name.", + "maxLength": 5000, + "type": "string" + }, + "value": { + "description": "The header value.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "title": "ForwardedRequestHeader", + "type": "object", + "x-expandableFields": [] + }, + "forwarded_response_details": { + "description": "Details about the response from the destination endpoint.", + "properties": { + "body": { + "description": "The response body from the destination endpoint to Stripe.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "HTTP headers that the destination endpoint returned.", + "items": { + "$ref": "#/components/schemas/forwarded_request_header" + }, + "type": "array" + }, + "status": { + "description": "The HTTP status code that the destination endpoint returned.", + "type": "integer" + } + }, + "required": [ + "body", + "headers", + "status" + ], + "title": "ForwardedResponseDetails", + "type": "object", + "x-expandableFields": [ + "headers" + ] + }, + "forwarding.request": { + "description": "Instructs Stripe to make a request on your behalf using the destination URL and HTTP method in the config.\nA config is set up for each destination URL by Stripe at the time of onboarding. Stripe verifies requests with\nyour credentials in the config, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.", + "properties": { + "config": { + "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", + "maxLength": 5000, + "type": "string" + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "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": [ + "forwarding.request" + ], + "type": "string" + }, + "payment_method": { + "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", + "maxLength": 5000, + "type": "string" + }, + "replacements": { + "description": "The field kinds to be replaced in the forwarded request.", + "items": { + "enum": [ + "card_cvc", + "card_expiry", + "card_number", + "cardholder_name" + ], + "type": "string" + }, + "type": "array" + }, + "request_context": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_request_context" + } + ], + "description": "Context about the request from Stripe's servers to the destination endpoint.", + "nullable": true + }, + "request_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_request_details" + } + ], + "description": "The request that was sent to the destination endpoint. We redact any sensitive fields.", + "nullable": true + }, + "response_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_response_details" + } + ], + "description": "The response that the destination endpoint returned to us. We redact any sensitive fields.", + "nullable": true + }, + "url": { + "description": "The destination URL for the forwarded request. Must be supported by the config.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "config", + "created", + "id", + "livemode", + "object", + "payment_method", + "replacements" + ], + "title": "ForwardingRequest", + "type": "object", + "x-expandableFields": [ + "request_context", + "request_details", + "response_details" + ], + "x-resourceId": "forwarding.request" + }, "funding_instructions": { "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)", "properties": { @@ -12527,6 +13134,42 @@ "type": "object", "x-expandableFields": [] }, + "internal_card": { + "description": "", + "properties": { + "brand": { + "description": "Brand of the card used in the transaction", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "country": { + "description": "Two-letter ISO code representing the country of the card", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "exp_month": { + "description": "Two digit number representing the card's expiration month", + "nullable": true, + "type": "integer" + }, + "exp_year": { + "description": "Two digit number representing the card's expiration year", + "nullable": true, + "type": "integer" + }, + "last4": { + "description": "The last 4 digits of the card", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "internal_card", + "type": "object", + "x-expandableFields": [] + }, "invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { @@ -23275,6 +23918,16 @@ } ] }, + "mobilepay": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "oxxo": { "anyOf": [ { @@ -23431,6 +24084,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -23714,6 +24368,28 @@ "type": "object", "x-expandableFields": [] }, + "payment_intent_payment_method_options_mobilepay": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding 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.\n\nWhen 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": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_intent_payment_method_options_mobilepay", + "type": "object", + "x-expandableFields": [] + }, "payment_intent_payment_method_options_sepa_debit": { "description": "", "properties": { @@ -25350,6 +26026,9 @@ "nullable": true, "type": "object" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_mobilepay" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -25415,6 +26094,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -25477,6 +26157,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -26461,6 +27142,9 @@ "link": { "$ref": "#/components/schemas/payment_method_details_link" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_details_mobilepay" + }, "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, @@ -26545,6 +27229,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -28025,6 +28710,24 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_mobilepay": { + "description": "", + "properties": { + "card": { + "anyOf": [ + { + "$ref": "#/components/schemas/internal_card" + } + ], + "nullable": true + } + }, + "title": "payment_method_details_mobilepay", + "type": "object", + "x-expandableFields": [ + "card" + ] + }, "payment_method_details_multibanco": { "description": "", "properties": { @@ -28421,6 +29124,12 @@ "nullable": true, "type": "string" }, + "payment_reference": { + "description": "Reference number to locate ACH payments with customer's bank.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, @@ -28853,6 +29562,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_mobilepay": { + "description": "", + "properties": {}, + "title": "payment_method_mobilepay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_affirm": { "description": "", "properties": { @@ -39057,7 +39773,7 @@ "$ref": "#/components/schemas/subscriptions_resource_pause_collection" } ], - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "nullable": true }, "payment_settings": { @@ -39133,7 +39849,7 @@ "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.", + "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, 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\nA subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices. \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", @@ -64215,6 +64931,74 @@ } } }, + "/v1/confirmation_tokens/{confirmation_token}": { + "get": { + "description": "Retrieves an existing ConfirmationToken object
", + "operationId": "GetConfirmationTokensConfirmationToken", + "parameters": [ + { + "in": "path", + "name": "confirmation_token", + "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, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/confirmation_token" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/country_specs": { "get": { "description": "Lists all Country Spec objects available in the API.
", @@ -70606,6 +71390,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -73453,7 +74238,7 @@ "type": "string" } ], - "description": "If specified, payment collection for this subscription will be paused." + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", @@ -77608,6 +78393,352 @@ } } }, + "/v1/forwarding/requests": { + "get": { + "description": "Lists all ForwardingRequest objects.
", + "operationId": "GetForwardingRequests", + "parameters": [ + { + "description": "Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "properties": { + "gt": { + "type": "integer" + }, + "gte": { + "type": "integer" + }, + "lt": { + "type": "integer" + }, + "lte": { + "type": "integer" + } + }, + "title": "created_param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.", + "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 pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.", + "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, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List of ForwardingRequest data.", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/forwarding.request" + }, + "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": "ForwardingRequestList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a ForwardingRequest object.
", + "operationId": "PostForwardingRequests", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "replacements": { + "explode": true, + "style": "deepObject" + }, + "request": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", + "maxLength": 5000, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_method": { + "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", + "maxLength": 5000, + "type": "string" + }, + "replacements": { + "description": "The field kinds to be replaced in the forwarded request.", + "items": { + "enum": [ + "card_cvc", + "card_expiry", + "card_number", + "cardholder_name" + ], + "type": "string" + }, + "type": "array" + }, + "request": { + "description": "The request body and headers to be sent to the destination endpoint.", + "properties": { + "body": { + "maxLength": 5000, + "type": "string" + }, + "headers": { + "items": { + "properties": { + "name": { + "maxLength": 5000, + "type": "string" + }, + "value": { + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "title": "header_param", + "type": "object" + }, + "type": "array" + } + }, + "title": "request_param", + "type": "object" + }, + "url": { + "description": "The destination URL for the forwarded request. Must be supported by the config.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "config", + "payment_method", + "replacements", + "url" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/forwarding.request" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/forwarding/requests/{id}": { + "get": { + "description": "Retrieves a ForwardingRequest object.
", + "operationId": "GetForwardingRequestsId", + "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": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/forwarding.request" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/identity/verification_reports": { "get": { "description": "List all verification reports.
", @@ -95173,6 +96304,11 @@ ], "type": "string" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", + "maxLength": 5000, + "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" @@ -95660,6 +96796,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -95797,6 +96938,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -96937,6 +98079,35 @@ } ] }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -98286,6 +99457,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -98423,6 +99599,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -99563,6 +100740,35 @@ } ] }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -100555,6 +101761,11 @@ "maxLength": 5000, "type": "string" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", + "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" @@ -101051,6 +102262,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -101188,6 +102404,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -102328,6 +103545,35 @@ } ] }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -108377,6 +109623,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -108572,6 +109819,10 @@ "explode": true, "style": "deepObject" }, + "mobilepay": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -109078,6 +110329,12 @@ "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" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -109233,6 +110490,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -119001,6 +120259,11 @@ "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.", "type": "boolean" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", + "maxLength": 5000, + "type": "string" + }, "customer": { "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.", "maxLength": 5000, @@ -119470,6 +120733,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -119607,6 +120875,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -120650,6 +121919,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -120787,6 +122061,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -121378,6 +122653,11 @@ "maxLength": 5000, "type": "string" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.", + "maxLength": 5000, + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -121849,6 +123129,11 @@ }, "type": "object" }, + "mobilepay": { + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -121986,6 +123271,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -129642,7 +130928,7 @@ "type": "string" } ], - "description": "If specified, payment collection for this subscription will be paused." + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", @@ -137026,6 +138312,710 @@ } } }, + "/v1/test_helpers/confirmation_tokens": { + "post": { + "description": "Creates a test mode Confirmation Token server side for your integration tests.
", + "operationId": "PostTestHelpersConfirmationTokens", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "payment_method_data": { + "explode": true, + "style": "deepObject" + }, + "shipping": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_method": { + "description": "ID of an existing PaymentMethod.", + "maxLength": 5000, + "type": "string" + }, + "payment_method_data": { + "description": "If provided, this hash will be used to create a PaymentMethod.", + "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", + "nn", + "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" + }, + "mobilepay": { + "properties": {}, + "title": "param", + "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", + "velobank", + "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_with_hidden_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" + }, + "swish": { + "properties": {}, + "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", + "mobilepay", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "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" + }, + "return_url": { + "description": "Return URL used to confirm the Intent.", + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property 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.", + "enum": [ + "off_session", + "on_session" + ], + "type": "string" + }, + "shipping": { + "description": "Shipping information for this ConfirmationToken.", + "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" + }, + "name": { + "maxLength": 5000, + "type": "string" + }, + "phone": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "required": [ + "address", + "name" + ], + "title": "recipient_shipping_with_optional_fields_address", + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/confirmation_token" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/test_helpers/customers/{customer}/fund_cash_balance": { "post": { "description": "Create an incoming testmode bank transfer
",