Attaches a PaymentIntent to the invoice, adding it to the list of payments.\nWhen the PaymentIntent’s status changes to succeeded, the payment is credited\nto the invoice, increasing its amount_paid. When the invoice is fully paid, the\ninvoice’s status becomes paid.
If the PaymentIntent’s status is already succeeded when it is attached, it is\ncredited to the invoice immediately.
Related guide: Create an invoice payment
", - "operationId": "PostInvoicesInvoiceAttachPaymentIntent", + "description": "Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceAddLines", "parameters": [ { "in": "path", @@ -113060,15 +113199,19 @@ "expand": { "explode": true, "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { - "amount_requested": { - "description": "The portion of the PaymentIntent’s `amount` that should be applied to thisinvoice. Defaults to the entire amount.", - "type": "integer" - }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -113077,14 +113220,467 @@ }, "type": "array" }, - "payment_intent": { - "description": "The ID of the PaymentIntent to attach to the invoice.", - "maxLength": 5000, - "type": "string" + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to add.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "discount_end": { + "description": "Details to determine how long the discount should be applied for.", + "properties": { + "duration": { + "description": "Time span for the redeemed discount.", + "properties": { + "interval": { + "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", + "type": "integer" + } + }, + "required": [ + "interval", + "interval_count" + ], + "title": "discount_end_duration_specs", + "type": "object" + }, + "timestamp": { + "description": "A precise Unix timestamp for the discount to end. Must be in the future.", + "format": "unix-time", + "type": "integer" + }, + "type": { + "description": "The type of calculation made to determine when the discount ends.", + "enum": [ + "duration", + "timestamp" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "discount_end", + "type": "object" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "invoice_item": { + "description": "ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.", + "maxLength": 5000, + "type": "string" + }, + "margins": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item." + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "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" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "description": { + "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 50, + "type": "string" + }, + "percentage": { + "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "title": "lines_data_param", + "type": "object" + }, + "type": "array" } }, "required": [ - "payment_intent" + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/{invoice}/attach_payment_intent": { + "post": { + "description": "Attaches a PaymentIntent to the invoice, adding it to the list of payments.\nWhen the PaymentIntent’s status changes to succeeded, the payment is credited\nto the invoice, increasing its amount_paid. When the invoice is fully paid, the\ninvoice’s status becomes paid.
If the PaymentIntent’s status is already succeeded when it is attached, it is\ncredited to the invoice immediately.
Related guide: Create an invoice payment
", + "operationId": "PostInvoicesInvoiceAttachPaymentIntent", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "amount_requested": { + "description": "The portion of the PaymentIntent’s `amount` that should be applied to thisinvoice. Defaults to the entire amount.", + "type": "integer" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_intent": { + "description": "The ID of the PaymentIntent to attach to the invoice.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "payment_intent" ], "type": "object" } @@ -114166,6 +114762,128 @@ } } }, + "/v1/invoices/{invoice}/remove_lines": { + "post": { + "description": "Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceRemoveLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "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" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to remove.", + "items": { + "properties": { + "behavior": { + "description": "Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.", + "enum": [ + "delete", + "unassign" + ], + "type": "string" + }, + "id": { + "description": "ID of an existing line item to remove from this invoice.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "behavior", + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/{invoice}/send": { "post": { "description": "Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
\n\nRequests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
", - "operationId": "PostInvoicesInvoiceVoid", + "description": "Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceUpdateLines", "parameters": [ { "in": "path", @@ -114256,6 +114974,14 @@ "expand": { "explode": true, "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -114268,13 +114994,465 @@ "type": "string" }, "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to update.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "discount_end": { + "description": "Details to determine how long the discount should be applied for.", + "properties": { + "duration": { + "description": "Time span for the redeemed discount.", + "properties": { + "interval": { + "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", + "type": "integer" + } + }, + "required": [ + "interval", + "interval_count" + ], + "title": "discount_end_duration_specs", + "type": "object" + }, + "timestamp": { + "description": "A precise Unix timestamp for the discount to end. Must be in the future.", + "format": "unix-time", + "type": "integer" + }, + "type": { + "description": "The type of calculation made to determine when the discount ends.", + "enum": [ + "duration", + "timestamp" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "discount_end", + "type": "object" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "id": { + "description": "ID of an existing line item on the invoice.", + "maxLength": 5000, + "type": "string" + }, + "margins": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item." + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "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" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "description": { + "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 50, + "type": "string" + }, + "percentage": { + "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "required": [ + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" } }, + "required": [ + "lines" + ], "type": "object" } } }, - "required": false + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/{invoice}/void": { + "post": { + "description": "Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
", + "operationId": "PostInvoicesInvoiceVoid", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false }, "responses": { "200": { @@ -130771,6 +131949,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -130952,6 +132136,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -132289,6 +133474,30 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "multibanco": { + "anyOf": [ + { + "properties": { + "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 `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -134765,6 +135974,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -134946,6 +136161,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -136283,6 +137499,30 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "multibanco": { + "anyOf": [ + { + "properties": { + "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 `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -139695,6 +140935,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -139876,6 +141122,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -141213,6 +142460,30 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "multibanco": { + "anyOf": [ + { + "properties": { + "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 `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -145339,6 +146610,10 @@ "explode": true, "style": "deepObject" }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -145966,6 +147241,29 @@ "title": "payment_method_param", "type": "object" }, + "multibanco": { + "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "name": { "description": "Configuration name.", "maxLength": 100, @@ -146427,6 +147725,10 @@ "explode": true, "style": "deepObject" }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -147058,6 +148360,29 @@ "title": "payment_method_param", "type": "object" }, + "multibanco": { + "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "name": { "description": "Configuration name.", "maxLength": 100, @@ -147828,6 +149153,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -148025,6 +149351,10 @@ "explode": true, "style": "deepObject" }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -148586,6 +149916,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -148773,6 +150109,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -163728,6 +165065,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -163909,6 +165252,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -165181,6 +166525,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -165362,6 +166712,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -166666,6 +168017,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" }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, @@ -166847,6 +168204,7 @@ "klarna", "konbini", "link", + "multibanco", "oxxo", "p24", "paynow", @@ -174781,6 +176139,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -175001,8 +176363,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -175809,6 +177181,22 @@ ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." + }, "us_bank_account": { "anyOf": [ { @@ -176445,6 +177833,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -176681,8 +178073,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -177547,6 +178949,22 @@ ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." + }, "us_bank_account": { "anyOf": [ { @@ -185868,6 +187286,830 @@ } } }, + "/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": { + "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", + "properties": { + "account_number": { + "description": "Customer's bank account number.", + "maxLength": 5000, + "type": "string" + }, + "institution_number": { + "description": "Institution number of the customer's bank.", + "maxLength": 5000, + "type": "string" + }, + "transit_number": { + "description": "Transit number of the customer's bank.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "account_number", + "institution_number", + "transit_number" + ], + "title": "payment_method_param", + "type": "object" + }, + "affirm": { + "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "afterpay_clearpay": { + "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "alipay": { + "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "au_becs_debit": { + "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", + "properties": { + "account_number": { + "description": "The account number for the bank account.", + "maxLength": 5000, + "type": "string" + }, + "bsb_number": { + "description": "Bank-State-Branch number of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "account_number", + "bsb_number" + ], + "title": "param", + "type": "object" + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", + "properties": { + "account_number": { + "description": "Account number of the bank account that the funds will be debited from.", + "maxLength": 5000, + "type": "string" + }, + "sort_code": { + "description": "Sort code of the bank account. (e.g., `10-20-30`)", + "maxLength": 5000, + "type": "string" + } + }, + "title": "param", + "type": "object" + }, + "bancontact": { + "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "billing_details": { + "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", + "properties": { + "address": { + "anyOf": [ + { + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "billing_details_address", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Billing address." + }, + "email": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Email address." + }, + "name": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Full name." + }, + "phone": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Billing phone number (including extension)." + } + }, + "title": "billing_details_inner_params", + "type": "object" + }, + "blik": { + "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "boleto": { + "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", + "properties": { + "tax_id": { + "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "tax_id" + ], + "title": "param", + "type": "object" + }, + "cashapp": { + "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "customer_balance": { + "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "eps": { + "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", + "properties": { + "bank": { + "description": "The customer's 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": { + "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", + "properties": { + "account_holder_type": { + "description": "Account holder type for FPX transaction", + "enum": [ + "company", + "individual" + ], + "maxLength": 5000, + "type": "string" + }, + "bank": { + "description": "The customer's bank.", + "enum": [ + "affin_bank", + "agrobank", + "alliance_bank", + "ambank", + "bank_islam", + "bank_muamalat", + "bank_of_china", + "bank_rakyat", + "bsn", + "cimb", + "deutsche_bank", + "hong_leong_bank", + "hsbc", + "kfh", + "maybank2e", + "maybank2u", + "ocbc", + "pb_enterprise", + "public_bank", + "rhb", + "standard_chartered", + "uob" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "bank" + ], + "title": "param", + "type": "object" + }, + "giropay": { + "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "grabpay": { + "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "ideal": { + "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", + "properties": { + "bank": { + "description": "The customer's 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": { + "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "klarna": { + "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", + "properties": { + "dob": { + "description": "Customer's date of birth", + "properties": { + "day": { + "description": "The day of birth, between 1 and 31.", + "type": "integer" + }, + "month": { + "description": "The month of birth, between 1 and 12.", + "type": "integer" + }, + "year": { + "description": "The four-digit year of birth.", + "type": "integer" + } + }, + "required": [ + "day", + "month", + "year" + ], + "title": "date_of_birth", + "type": "object" + } + }, + "title": "param", + "type": "object" + }, + "konbini": { + "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "link": { + "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco 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": {}, + "title": "param", + "type": "object" + }, + "p24": { + "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", + "properties": { + "bank": { + "description": "The customer's 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": { + "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "paypal": { + "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "payto": { + "description": "If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.", + "properties": { + "account_number": { + "description": "The account number for the bank account.", + "maxLength": 5000, + "type": "string" + }, + "bsb_number": { + "description": "Bank-State-Branch number of the bank account.", + "maxLength": 5000, + "type": "string" + }, + "pay_id": { + "description": "The PayID alias for the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "param", + "type": "object" + }, + "pix": { + "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "promptpay": { + "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "radar_options": { + "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", + "properties": { + "session": { + "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "radar_options_with_hidden_options", + "type": "object" + }, + "revolut_pay": { + "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "sepa_debit": { + "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", + "properties": { + "iban": { + "description": "IBAN of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "iban" + ], + "title": "param", + "type": "object" + }, + "sofort": { + "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", + "properties": { + "country": { + "description": "Two-letter ISO code representing the country the bank account is located in.", + "enum": [ + "AT", + "BE", + "DE", + "ES", + "IT", + "NL" + ], + "type": "string" + } + }, + "required": [ + "country" + ], + "title": "param", + "type": "object" + }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a Twint PaymentMethod, this hash contains details about the Twint payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "type": { + "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", + "enum": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "us_bank_account": { + "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", + "properties": { + "account_holder_type": { + "description": "Account holder type: individual or company.", + "enum": [ + "company", + "individual" + ], + "type": "string" + }, + "account_number": { + "description": "Account number of the bank account.", + "maxLength": 5000, + "type": "string" + }, + "account_type": { + "description": "Account type: checkings or savings. Defaults to checking if omitted.", + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "financial_connections_account": { + "description": "The ID of a Financial Connections Account to use as a payment method.", + "maxLength": 5000, + "type": "string" + }, + "routing_number": { + "description": "Routing number of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "wechat_pay": { + "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" + } + }, + "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": { + "description": "Shipping address", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + "name": { + "description": "Recipient name.", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Recipient phone (including extension)" + } + }, + "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
", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 4a8794f8..fb161c30 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -6246,6 +6246,9 @@ "account_onboarding": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, + "documents": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" + }, "payment_details": { "$ref": "#/components/schemas/connect_embedded_payments_config" }, @@ -6258,6 +6261,7 @@ }, "required": [ "account_onboarding", + "documents", "payment_details", "payments", "payouts" @@ -6266,6 +6270,7 @@ "type": "object", "x-expandableFields": [ "account_onboarding", + "documents", "payment_details", "payments", "payouts" @@ -14948,6 +14953,26 @@ ], "type": "string" }, + "personalization_design": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/issuing.personalization_design" + } + ], + "description": "The personalization design object belonging to this card.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/issuing.personalization_design" + } + ] + } + }, "replaced_by": { "anyOf": [ { @@ -15060,6 +15085,7 @@ "type": "object", "x-expandableFields": [ "cardholder", + "personalization_design", "replaced_by", "replacement_for", "shipping", @@ -15320,6 +15346,197 @@ ], "x-resourceId": "issuing.dispute" }, + "issuing.personalization_design": { + "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.", + "properties": { + "card_logo": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/file" + } + ], + "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/file" + } + ] + } + }, + "carrier_text": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_personalization_design_carrier_text" + } + ], + "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", + "nullable": true + }, + "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" + }, + "lookup_key": { + "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "issuing.personalization_design" + ], + "type": "string" + }, + "physical_bundle": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/issuing.physical_bundle" + } + ], + "description": "The physical bundle object belonging to this personalization design.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/issuing.physical_bundle" + } + ] + } + }, + "preferences": { + "$ref": "#/components/schemas/issuing_personalization_design_preferences" + }, + "rejection_reasons": { + "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons" + }, + "status": { + "description": "Whether this personalization design can be used to create cards.", + "enum": [ + "active", + "inactive", + "rejected", + "review" + ], + "type": "string" + } + }, + "required": [ + "created", + "id", + "livemode", + "metadata", + "object", + "physical_bundle", + "preferences", + "rejection_reasons", + "status" + ], + "title": "IssuingPersonalizationDesign", + "type": "object", + "x-expandableFields": [ + "card_logo", + "carrier_text", + "physical_bundle", + "preferences", + "rejection_reasons" + ], + "x-resourceId": "issuing.personalization_design" + }, + "issuing.physical_bundle": { + "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.", + "properties": { + "features": { + "$ref": "#/components/schemas/issuing_physical_bundle_features" + }, + "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" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "issuing.physical_bundle" + ], + "type": "string" + }, + "status": { + "description": "Whether this physical bundle can be used to create cards.", + "enum": [ + "active", + "inactive", + "review" + ], + "type": "string" + }, + "type": { + "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you.", + "enum": [ + "custom", + "standard" + ], + "type": "string" + } + }, + "required": [ + "id", + "livemode", + "name", + "object", + "status", + "type" + ], + "title": "IssuingPhysicalBundle", + "type": "object", + "x-expandableFields": [ + "features" + ], + "x-resourceId": "issuing.physical_bundle" + }, "issuing.settlement": { "description": "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.", "properties": { @@ -19398,6 +19615,141 @@ "cardholder_address" ] }, + "issuing_personalization_design_carrier_text": { + "description": "", + "properties": { + "footer_body": { + "description": "The footer body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "footer_title": { + "description": "The footer title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_body": { + "description": "The header body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_title": { + "description": "The header title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "IssuingPersonalizationDesignCarrierText", + "type": "object", + "x-expandableFields": [] + }, + "issuing_personalization_design_preferences": { + "description": "", + "properties": { + "is_default": { + "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", + "type": "boolean" + }, + "is_platform_default": { + "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.", + "nullable": true, + "type": "boolean" + } + }, + "required": [ + "is_default" + ], + "title": "IssuingPersonalizationDesignPreferences", + "type": "object", + "x-expandableFields": [] + }, + "issuing_personalization_design_rejection_reasons": { + "description": "", + "properties": { + "card_logo": { + "description": "The reason(s) the card logo was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "carrier_text": { + "description": "The reason(s) the carrier text was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "title": "IssuingPersonalizationDesignRejectionReasons", + "type": "object", + "x-expandableFields": [] + }, + "issuing_physical_bundle_features": { + "description": "", + "properties": { + "card_logo": { + "description": "The policy for how to use card logo images in a card design with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + }, + "carrier_text": { + "description": "The policy for how to use carrier letter text in a card design with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + }, + "second_line": { + "description": "The policy for how to use a second line on a card with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + } + }, + "required": [ + "card_logo", + "carrier_text", + "second_line" + ], + "title": "IssuingPhysicalBundleFeatures", + "type": "object", + "x-expandableFields": [] + }, "issuing_transaction_amount_details": { "description": "", "properties": { @@ -39920,6 +40272,15 @@ "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.", "nullable": true }, + "sepa_debit": { + "anyOf": [ + { + "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.", + "nullable": true + }, "us_bank_account": { "anyOf": [ { @@ -39938,6 +40299,7 @@ "card", "customer_balance", "konbini", + "sepa_debit", "us_bank_account" ] }, @@ -71348,6 +71710,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -71467,8 +71833,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -71978,6 +72354,21 @@ } ] }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "us_bank_account": { "anyOf": [ { @@ -72430,6 +72821,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -72565,8 +72960,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -73178,6 +73583,21 @@ } ] }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "us_bank_account": { "anyOf": [ { @@ -87545,6 +87965,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "personalization_design", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "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", @@ -87717,6 +88147,11 @@ "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" }, + "personalization_design": { + "description": "The personalization design object belonging to this card.", + "maxLength": 5000, + "type": "string" + }, "pin": { "description": "The desired PIN for this card.", "properties": { @@ -88964,6 +89399,10 @@ ], "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`." }, + "personalization_design": { + "maxLength": 5000, + "type": "string" + }, "pin": { "description": "The desired new PIN for this card.", "properties": { @@ -91720,44 +92159,11 @@ } } }, - "/v1/issuing/settlements": { + "/v1/issuing/personalization_designs": { "get": { - "description": "Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
", + "operationId": "GetIssuingPersonalizationDesigns", "parameters": [ - { - "description": "Only return issuing settlements that were created during the given date interval.", - "explode": true, - "in": "query", - "name": "created", - "required": false, - "schema": { - "anyOf": [ - { - "properties": { - "gt": { - "type": "integer" - }, - "gte": { - "type": "integer" - }, - "lt": { - "type": "integer" - }, - "lte": { - "type": "integer" - } - }, - "title": "range_query_specs", - "type": "object" - }, - { - "type": "integer" - } - ] - }, - "style": "deepObject" - }, { "description": "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", @@ -91794,6 +92200,41 @@ }, "style": "form" }, + { + "description": "Only return personalization designs with the given lookup keys.", + "explode": true, + "in": "query", + "name": "lookup_keys", + "required": false, + "schema": { + "items": { + "maxLength": 200, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "Only return personalization designs with the given preferences.", + "explode": true, + "in": "query", + "name": "preferences", + "required": false, + "schema": { + "properties": { + "is_default": { + "type": "boolean" + }, + "is_platform_default": { + "type": "boolean" + } + }, + "title": "preferences_list_param", + "type": "object" + }, + "style": "deepObject" + }, { "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", @@ -91804,6 +92245,22 @@ "type": "string" }, "style": "form" + }, + { + "description": "Only return personalization designs with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "inactive", + "rejected", + "review" + ], + "type": "string" + }, + "style": "form" } ], "requestBody": { @@ -91828,7 +92285,7 @@ "properties": { "data": { "items": { - "$ref": "#/components/schemas/issuing.settlement" + "$ref": "#/components/schemas/issuing.personalization_design" }, "type": "array" }, @@ -91846,7 +92303,7 @@ "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, - "pattern": "^/v1/issuing/settlements", + "pattern": "^/v1/issuing/personalization_designs", "type": "string" } }, @@ -91856,7 +92313,7 @@ "object", "url" ], - "title": "IssuingSettlementList", + "title": "IssuingPersonalizationDesignList", "type": "object", "x-expandableFields": [ "data" @@ -91877,12 +92334,186 @@ "description": "Error response." } } + }, + "post": { + "description": "Creates a personalization design object.
", + "operationId": "PostIssuingPersonalizationDesigns", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "carrier_text": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + }, + "preferences": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "card_logo": { + "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", + "type": "string" + }, + "carrier_text": { + "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", + "properties": { + "footer_body": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "footer_title": { + "anyOf": [ + { + "maxLength": 30, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "header_body": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "header_title": { + "anyOf": [ + { + "maxLength": 30, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "carrier_text_param", + "type": "object" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "lookup_key": { + "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", + "maxLength": 200, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 200, + "type": "string" + }, + "physical_bundle": { + "description": "The physical bundle object belonging to this personalization design.", + "maxLength": 5000, + "type": "string" + }, + "preferences": { + "description": "Information on whether this personalization design is used to create cards when one is not specified.", + "properties": { + "is_default": { + "type": "boolean" + } + }, + "required": [ + "is_default" + ], + "title": "preferences_param", + "type": "object" + }, + "transfer_lookup_key": { + "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", + "type": "boolean" + } + }, + "required": [ + "physical_bundle" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } } }, - "/v1/issuing/settlements/{settlement}": { + "/v1/issuing/personalization_designs/{personalization_design}": { "get": { - "description": "Retrieves an Issuing Settlement object.
Retrieves a personalization design object.
", + "operationId": "GetIssuingPersonalizationDesignsPersonalizationDesign", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", @@ -91901,7 +92532,692 @@ }, { "in": "path", - "name": "settlement", + "name": "personalization_design", + "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/issuing.personalization_design" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates a card personalization object.
", + "operationId": "PostIssuingPersonalizationDesignsPersonalizationDesign", + "parameters": [ + { + "in": "path", + "name": "personalization_design", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "card_logo": { + "explode": true, + "style": "deepObject" + }, + "carrier_text": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "lookup_key": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + }, + "name": { + "explode": true, + "style": "deepObject" + }, + "preferences": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "card_logo": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`." + }, + "carrier_text": { + "anyOf": [ + { + "properties": { + "footer_body": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "footer_title": { + "anyOf": [ + { + "maxLength": 30, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "header_body": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "header_title": { + "anyOf": [ + { + "maxLength": 30, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "carrier_text_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Hash containing carrier text, for use with physical bundles that support carrier text." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "lookup_key": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters." + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "anyOf": [ + { + "maxLength": 200, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Friendly display name. Providing an empty string will set the field to null." + }, + "physical_bundle": { + "description": "The physical bundle object belonging to this personalization design.", + "maxLength": 5000, + "type": "string" + }, + "preferences": { + "description": "Information on whether this personalization design is used to create cards when one is not specified.", + "properties": { + "is_default": { + "type": "boolean" + } + }, + "required": [ + "is_default" + ], + "title": "preferences_param", + "type": "object" + }, + "transfer_lookup_key": { + "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/issuing/physical_bundles": { + "get": { + "description": "Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
", + "operationId": "GetIssuingPhysicalBundles", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "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": "Only return physical bundles with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "inactive", + "review" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "Only return physical bundles with the given type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "custom", + "standard" + ], + "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/issuing.physical_bundle" + }, + "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/issuing/physical_bundles", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "IssuingPhysicalBundleList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/issuing/physical_bundles/{physical_bundle}": { + "get": { + "description": "Retrieves a physical bundle object.
", + "operationId": "GetIssuingPhysicalBundlesPhysicalBundle", + "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": "physical_bundle", + "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/issuing.physical_bundle" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/issuing/settlements": { + "get": { + "description": "Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Settlement object.
Updates the status of the specified testmode personalization design object to active.
Updates the status of the specified testmode personalization design object to inactive.
Updates the status of the specified testmode personalization design object to rejected.
Allows the user to capture an arbitrary amount, also known as a forced capture.
",