diff --git a/API_VERSION b/API_VERSION index 6df7aed6..2ecdba01 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -b2c5026cbcd9404c94b31197152f479d279410a8 \ No newline at end of file +d6534f3d076849c4f6df1414d4c477334e431ffd \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 8a7edbe6..e9d12fff 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2100 \ No newline at end of file +v2103 \ No newline at end of file diff --git a/lib/stripe/api_version.rb b/lib/stripe/api_version.rb index eb5e03d7..8327ecc3 100644 --- a/lib/stripe/api_version.rb +++ b/lib/stripe/api_version.rb @@ -3,6 +3,6 @@ module Stripe module ApiVersion - CURRENT = "2025-09-30.preview" + CURRENT = "2025-10-29.preview" end end diff --git a/lib/stripe/params/charge_capture_params.rb b/lib/stripe/params/charge_capture_params.rb index a1189cd9..7fd054a0 100644 --- a/lib/stripe/params/charge_capture_params.rb +++ b/lib/stripe/params/charge_capture_params.rb @@ -676,7 +676,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -684,7 +686,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/charge_update_params.rb b/lib/stripe/params/charge_update_params.rb index 3d669483..aac33c92 100644 --- a/lib/stripe/params/charge_update_params.rb +++ b/lib/stripe/params/charge_update_params.rb @@ -685,7 +685,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -693,7 +695,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/payment_intent_capture_params.rb b/lib/stripe/params/payment_intent_capture_params.rb index 4044cfa4..65902f01 100644 --- a/lib/stripe/params/payment_intent_capture_params.rb +++ b/lib/stripe/params/payment_intent_capture_params.rb @@ -79,26 +79,32 @@ module Stripe end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_accessor :discount_amount # Payment method-specific information for line items. attr_accessor :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_accessor :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_accessor :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity # Contains information about the tax on the item. attr_accessor :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_accessor :unit_cost # A unit of measure for the line item, such as gallons, feet, meters, etc. attr_accessor :unit_of_measure @@ -125,11 +131,11 @@ module Stripe end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_accessor :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :to_postal_code def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil) @@ -140,14 +146,18 @@ module Stripe end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_accessor :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_accessor :line_items @@ -862,7 +872,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -870,7 +882,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/payment_intent_confirm_params.rb b/lib/stripe/params/payment_intent_confirm_params.rb index 260a27ca..34487aad 100644 --- a/lib/stripe/params/payment_intent_confirm_params.rb +++ b/lib/stripe/params/payment_intent_confirm_params.rb @@ -79,26 +79,32 @@ module Stripe end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_accessor :discount_amount # Payment method-specific information for line items. attr_accessor :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_accessor :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_accessor :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity # Contains information about the tax on the item. attr_accessor :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_accessor :unit_cost # A unit of measure for the line item, such as gallons, feet, meters, etc. attr_accessor :unit_of_measure @@ -125,11 +131,11 @@ module Stripe end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_accessor :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :to_postal_code def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil) @@ -140,14 +146,18 @@ module Stripe end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_accessor :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_accessor :line_items @@ -901,7 +911,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -909,7 +921,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/payment_intent_create_params.rb b/lib/stripe/params/payment_intent_create_params.rb index de934efb..3e194747 100644 --- a/lib/stripe/params/payment_intent_create_params.rb +++ b/lib/stripe/params/payment_intent_create_params.rb @@ -79,26 +79,32 @@ module Stripe end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_accessor :discount_amount # Payment method-specific information for line items. attr_accessor :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_accessor :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_accessor :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity # Contains information about the tax on the item. attr_accessor :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_accessor :unit_cost # A unit of measure for the line item, such as gallons, feet, meters, etc. attr_accessor :unit_of_measure @@ -125,11 +131,11 @@ module Stripe end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_accessor :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :to_postal_code def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil) @@ -140,14 +146,18 @@ module Stripe end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_accessor :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_accessor :line_items @@ -915,7 +925,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -923,7 +935,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/payment_intent_increment_authorization_params.rb b/lib/stripe/params/payment_intent_increment_authorization_params.rb index 27fb6d2f..d14e1f0c 100644 --- a/lib/stripe/params/payment_intent_increment_authorization_params.rb +++ b/lib/stripe/params/payment_intent_increment_authorization_params.rb @@ -79,26 +79,32 @@ module Stripe end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_accessor :discount_amount # Payment method-specific information for line items. attr_accessor :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_accessor :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_accessor :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity # Contains information about the tax on the item. attr_accessor :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_accessor :unit_cost # A unit of measure for the line item, such as gallons, feet, meters, etc. attr_accessor :unit_of_measure @@ -125,11 +131,11 @@ module Stripe end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_accessor :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :to_postal_code def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil) @@ -140,14 +146,18 @@ module Stripe end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_accessor :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_accessor :line_items @@ -190,9 +200,15 @@ module Stripe end class PaymentDetails < ::Stripe::RequestParams - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference def initialize(customer_reference: nil, order_reference: nil) diff --git a/lib/stripe/params/payment_intent_update_params.rb b/lib/stripe/params/payment_intent_update_params.rb index 0b9023ec..b9774fda 100644 --- a/lib/stripe/params/payment_intent_update_params.rb +++ b/lib/stripe/params/payment_intent_update_params.rb @@ -79,26 +79,32 @@ module Stripe end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_accessor :discount_amount # Payment method-specific information for line items. attr_accessor :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_accessor :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_accessor :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity # Contains information about the tax on the item. attr_accessor :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_accessor :unit_cost # A unit of measure for the line item, such as gallons, feet, meters, etc. attr_accessor :unit_of_measure @@ -125,11 +131,11 @@ module Stripe end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_accessor :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_accessor :to_postal_code def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil) @@ -140,14 +146,18 @@ module Stripe end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_accessor :total_tax_amount def initialize(total_tax_amount: nil) @total_tax_amount = total_tax_amount end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_accessor :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_accessor :line_items @@ -893,7 +903,9 @@ module Stripe end # Car rental details for this PaymentIntent. attr_accessor :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_accessor :customer_reference # Event details for this PaymentIntent attr_accessor :event_details @@ -901,7 +913,11 @@ module Stripe attr_accessor :flight # Lodging reservation details for this PaymentIntent attr_accessor :lodging - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_accessor :order_reference # Subscription details for this PaymentIntent attr_accessor :subscription diff --git a/lib/stripe/params/v2/core/account_update_params.rb b/lib/stripe/params/v2/core/account_update_params.rb index 74485e2d..cc32a3f4 100644 --- a/lib/stripe/params/v2/core/account_update_params.rb +++ b/lib/stripe/params/v2/core/account_update_params.rb @@ -1308,6 +1308,21 @@ module Stripe end end + class CryptoStorer < ::Stripe::RequestParams + # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + attr_accessor :date + # The IP address from which the Account's representative accepted the terms of service. + attr_accessor :ip + # The user agent of the browser from which the Account's representative accepted the terms of service. + attr_accessor :user_agent + + def initialize(date: nil, ip: nil, user_agent: nil) + @date = date + @ip = ip + @user_agent = user_agent + end + end + class Storer < ::Stripe::RequestParams # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. attr_accessor :date @@ -1324,11 +1339,14 @@ module Stripe end # Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). attr_accessor :account + # Details on the Account's acceptance of Crypto-storer-specific terms of service. + attr_accessor :crypto_storer # Details on the Account's acceptance of Treasury-specific terms of service. attr_accessor :storer - def initialize(account: nil, storer: nil) + def initialize(account: nil, crypto_storer: nil, storer: nil) @account = account + @crypto_storer = crypto_storer @storer = storer end end diff --git a/lib/stripe/resources/payment_intent.rb b/lib/stripe/resources/payment_intent.rb index 46a54513..be1a6fbe 100644 --- a/lib/stripe/resources/payment_intent.rb +++ b/lib/stripe/resources/payment_intent.rb @@ -29,11 +29,11 @@ module Stripe class AmountDetails < ::Stripe::StripeObject class Shipping < ::Stripe::StripeObject - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. attr_reader :amount - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. attr_reader :from_postal_code - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. attr_reader :to_postal_code def self.inner_class_types @@ -46,7 +46,9 @@ module Stripe end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_reader :total_tax_amount def self.inner_class_types @@ -70,7 +72,9 @@ module Stripe @field_remappings = {} end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. attr_reader :discount_amount # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. attr_reader :line_items @@ -1514,11 +1518,17 @@ module Stripe end # Attribute for field car_rental attr_reader :car_rental - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. attr_reader :customer_reference # Attribute for field event_details attr_reader :event_details - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. attr_reader :order_reference # Attribute for field subscription attr_reader :subscription diff --git a/lib/stripe/resources/payment_intent_amount_details_line_item.rb b/lib/stripe/resources/payment_intent_amount_details_line_item.rb index 659606c4..0989f5ce 100644 --- a/lib/stripe/resources/payment_intent_amount_details_line_item.rb +++ b/lib/stripe/resources/payment_intent_amount_details_line_item.rb @@ -89,7 +89,9 @@ module Stripe end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. attr_reader :total_tax_amount def self.inner_class_types @@ -100,7 +102,9 @@ module Stripe @field_remappings = {} end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. attr_reader :discount_amount # Unique identifier for the object. attr_reader :id @@ -108,17 +112,19 @@ module Stripe attr_reader :object # Payment method-specific information for line items. attr_reader :payment_method_options - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. attr_reader :product_code - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. attr_reader :product_name - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. attr_reader :quantity # Contains information about the tax on the item. attr_reader :tax - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. attr_reader :unit_cost - # A unit of measure for the line item, such as gallons, feet, meters, etc. + # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long. attr_reader :unit_of_measure def self.inner_class_types diff --git a/rbi/stripe.rbi b/rbi/stripe.rbi index 4d342296..d4e4c3ff 100644 --- a/rbi/stripe.rbi +++ b/rbi/stripe.rbi @@ -27983,13 +27983,13 @@ module Stripe class PaymentIntent < APIResource class AmountDetails < ::Stripe::StripeObject class Shipping < ::Stripe::StripeObject - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(Integer)) } def amount; end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end def self.inner_class_types @@ -28000,7 +28000,9 @@ module Stripe end end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(T.nilable(Integer)) } def total_tax_amount; end def self.inner_class_types @@ -28021,7 +28023,9 @@ module Stripe @field_remappings = {} end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. @@ -29614,13 +29618,19 @@ module Stripe # Attribute for field car_rental sig { returns(T.nilable(CarRental)) } def car_rental; end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end # Attribute for field event_details sig { returns(T.nilable(EventDetails)) } def event_details; end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end # Attribute for field subscription @@ -32078,7 +32088,9 @@ module Stripe end end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end def self.inner_class_types @@ -32088,7 +32100,9 @@ module Stripe @field_remappings = {} end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end # Unique identifier for the object. @@ -32100,22 +32114,24 @@ module Stripe # Payment method-specific information for line items. sig { returns(T.nilable(PaymentMethodOptions)) } def payment_method_options; end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end # Contains information about the tax on the item. sig { returns(T.nilable(Tax)) } def tax; end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end - # A unit of measure for the line item, such as gallons, feet, meters, etc. + # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long. sig { returns(T.nilable(String)) } def unit_of_measure; end end @@ -84003,7 +84019,9 @@ module Stripe params(_car_rental: T.nilable(ChargeUpdateParams::PaymentDetails::CarRental)).returns(T.nilable(ChargeUpdateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -84029,7 +84047,11 @@ module Stripe params(_lodging: T.nilable(ChargeUpdateParams::PaymentDetails::Lodging)).returns(T.nilable(ChargeUpdateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -85237,7 +85259,9 @@ module Stripe params(_car_rental: T.nilable(ChargeCaptureParams::PaymentDetails::CarRental)).returns(T.nilable(ChargeCaptureParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -85263,7 +85287,11 @@ module Stripe params(_lodging: T.nilable(ChargeCaptureParams::PaymentDetails::Lodging)).returns(T.nilable(ChargeCaptureParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -113838,7 +113866,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -113846,7 +113876,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -113860,17 +113892,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -113882,7 +113916,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -113907,19 +113941,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -113930,7 +113964,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -113938,7 +113974,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -115102,7 +115140,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentCreateParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentCreateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -115128,7 +115168,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentCreateParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentCreateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -119588,7 +119632,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -119596,7 +119642,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -119610,17 +119658,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -119632,7 +119682,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -119657,19 +119707,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -119680,7 +119730,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -119688,7 +119740,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -120819,7 +120873,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentUpdateParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentUpdateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -120845,7 +120901,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentUpdateParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentUpdateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -125277,7 +125337,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -125285,7 +125347,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -125299,17 +125363,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -125321,7 +125387,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -125346,19 +125412,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -125369,7 +125435,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -125377,7 +125445,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -126465,7 +126535,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentCaptureParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentCaptureParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -126491,7 +126563,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentCaptureParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentCaptureParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -126729,7 +126805,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -126737,7 +126815,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -126751,17 +126831,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -126773,7 +126855,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -126798,19 +126880,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -126821,7 +126903,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -126829,7 +126913,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -127979,7 +128065,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentConfirmParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentConfirmParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -128005,7 +128093,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentConfirmParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentConfirmParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -132437,7 +132529,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -132445,7 +132539,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -132459,17 +132555,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -132483,7 +132581,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -132508,19 +132606,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -132531,7 +132629,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -132539,7 +132639,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -132614,12 +132716,18 @@ module Stripe def initialize(inputs: nil); end end class PaymentDetails < ::Stripe::RequestParams - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } def customer_reference=(_customer_reference); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -193512,6 +193620,27 @@ module Stripe } def initialize(date: nil, ip: nil, user_agent: nil); end end + class CryptoStorer < ::Stripe::RequestParams + # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + sig { returns(T.nilable(String)) } + def date; end + sig { params(_date: T.nilable(String)).returns(T.nilable(String)) } + def date=(_date); end + # The IP address from which the Account's representative accepted the terms of service. + sig { returns(T.nilable(String)) } + def ip; end + sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) } + def ip=(_ip); end + # The user agent of the browser from which the Account's representative accepted the terms of service. + sig { returns(T.nilable(String)) } + def user_agent; end + sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) } + def user_agent=(_user_agent); end + sig { + params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void + } + def initialize(date: nil, ip: nil, user_agent: nil); end + end class Storer < ::Stripe::RequestParams # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. sig { returns(T.nilable(String)) } @@ -193542,6 +193671,15 @@ module Stripe params(_account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account)).returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account)) } def account=(_account); end + # Details on the Account's acceptance of Crypto-storer-specific terms of service. + sig { + returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)) + } + def crypto_storer; end + sig { + params(_crypto_storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)).returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)) + } + def crypto_storer=(_crypto_storer); end # Details on the Account's acceptance of Treasury-specific terms of service. sig { returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)) @@ -193552,9 +193690,9 @@ module Stripe } def storer=(_storer); end sig { - params(account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account), storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)).void + params(account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account), crypto_storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer), storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)).void } - def initialize(account: nil, storer: nil); end + def initialize(account: nil, crypto_storer: nil, storer: nil); end end # This hash is used to attest that the directors information provided to Stripe is both current and correct. sig { diff --git a/rbi/stripe/params/charge_capture_params.rbi b/rbi/stripe/params/charge_capture_params.rbi index 7f15aada..2069b026 100644 --- a/rbi/stripe/params/charge_capture_params.rbi +++ b/rbi/stripe/params/charge_capture_params.rbi @@ -1010,7 +1010,9 @@ module Stripe params(_car_rental: T.nilable(ChargeCaptureParams::PaymentDetails::CarRental)).returns(T.nilable(ChargeCaptureParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1036,7 +1038,11 @@ module Stripe params(_lodging: T.nilable(ChargeCaptureParams::PaymentDetails::Lodging)).returns(T.nilable(ChargeCaptureParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/charge_update_params.rbi b/rbi/stripe/params/charge_update_params.rbi index 4205b7f7..5f7deb1f 100644 --- a/rbi/stripe/params/charge_update_params.rbi +++ b/rbi/stripe/params/charge_update_params.rbi @@ -1017,7 +1017,9 @@ module Stripe params(_car_rental: T.nilable(ChargeUpdateParams::PaymentDetails::CarRental)).returns(T.nilable(ChargeUpdateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1043,7 +1045,11 @@ module Stripe params(_lodging: T.nilable(ChargeUpdateParams::PaymentDetails::Lodging)).returns(T.nilable(ChargeUpdateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/payment_intent_capture_params.rbi b/rbi/stripe/params/payment_intent_capture_params.rbi index 2acb07e9..eaa67bde 100644 --- a/rbi/stripe/params/payment_intent_capture_params.rbi +++ b/rbi/stripe/params/payment_intent_capture_params.rbi @@ -119,7 +119,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -127,7 +129,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -141,17 +145,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -163,7 +169,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentCaptureParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -188,19 +194,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -211,7 +217,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -219,7 +227,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -1307,7 +1317,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentCaptureParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentCaptureParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1333,7 +1345,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentCaptureParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentCaptureParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/payment_intent_confirm_params.rbi b/rbi/stripe/params/payment_intent_confirm_params.rbi index 9e6cff05..0c4b65d2 100644 --- a/rbi/stripe/params/payment_intent_confirm_params.rbi +++ b/rbi/stripe/params/payment_intent_confirm_params.rbi @@ -119,7 +119,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -127,7 +129,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -141,17 +145,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -163,7 +169,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentConfirmParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -188,19 +194,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -211,7 +217,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -219,7 +227,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -1369,7 +1379,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentConfirmParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentConfirmParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1395,7 +1407,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentConfirmParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentConfirmParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/payment_intent_create_params.rbi b/rbi/stripe/params/payment_intent_create_params.rbi index 854a1842..16cc36fe 100644 --- a/rbi/stripe/params/payment_intent_create_params.rbi +++ b/rbi/stripe/params/payment_intent_create_params.rbi @@ -119,7 +119,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -127,7 +129,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -141,17 +145,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -163,7 +169,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentCreateParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -188,19 +194,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -211,7 +217,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -219,7 +227,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -1383,7 +1393,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentCreateParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentCreateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1409,7 +1421,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentCreateParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentCreateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/payment_intent_increment_authorization_params.rbi b/rbi/stripe/params/payment_intent_increment_authorization_params.rbi index 87d68bc1..fc3c7321 100644 --- a/rbi/stripe/params/payment_intent_increment_authorization_params.rbi +++ b/rbi/stripe/params/payment_intent_increment_authorization_params.rbi @@ -119,7 +119,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -127,7 +129,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -141,17 +145,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -165,7 +171,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -190,19 +196,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -213,7 +219,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -221,7 +229,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -296,12 +306,18 @@ module Stripe def initialize(inputs: nil); end end class PaymentDetails < ::Stripe::RequestParams - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } def customer_reference=(_customer_reference); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/payment_intent_update_params.rbi b/rbi/stripe/params/payment_intent_update_params.rbi index b12b89dc..a6da8a3e 100644 --- a/rbi/stripe/params/payment_intent_update_params.rbi +++ b/rbi/stripe/params/payment_intent_update_params.rbi @@ -119,7 +119,9 @@ module Stripe def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil); end end class Tax < ::Stripe::RequestParams - # The total tax on an item. Non-negative integer. + # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -127,7 +129,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end sig { params(_discount_amount: T.nilable(Integer)).returns(T.nilable(Integer)) } @@ -141,17 +145,19 @@ module Stripe params(_payment_method_options: T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions)).returns(T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions)) } def payment_method_options=(_payment_method_options); end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end sig { params(_product_code: T.nilable(String)).returns(T.nilable(String)) } def product_code=(_product_code); end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } def product_name=(_product_name); end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end sig { params(_quantity: Integer).returns(Integer) } @@ -163,7 +169,7 @@ module Stripe params(_tax: T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::Tax)).returns(T.nilable(PaymentIntentUpdateParams::AmountDetails::LineItem::Tax)) } def tax=(_tax); end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end sig { params(_unit_cost: Integer).returns(Integer) } @@ -188,19 +194,19 @@ module Stripe ); end end class Shipping < ::Stripe::RequestParams - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(T.any(String, Integer))) } def amount; end sig { params(_amount: T.nilable(T.any(String, Integer))).returns(T.nilable(T.any(String, Integer))) } def amount=(_amount); end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end sig { params(_from_postal_code: T.nilable(String)).returns(T.nilable(String)) } def from_postal_code=(_from_postal_code); end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end sig { params(_to_postal_code: T.nilable(String)).returns(T.nilable(String)) } @@ -211,7 +217,9 @@ module Stripe def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil); end end class Tax < ::Stripe::RequestParams - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end sig { params(_total_tax_amount: Integer).returns(Integer) } @@ -219,7 +227,9 @@ module Stripe sig { params(total_tax_amount: Integer).void } def initialize(total_tax_amount: nil); end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(T.any(String, Integer))) } def discount_amount; end sig { @@ -1350,7 +1360,9 @@ module Stripe params(_car_rental: T.nilable(PaymentIntentUpdateParams::PaymentDetails::CarRental)).returns(T.nilable(PaymentIntentUpdateParams::PaymentDetails::CarRental)) } def car_rental=(_car_rental); end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end sig { params(_customer_reference: T.nilable(String)).returns(T.nilable(String)) } @@ -1376,7 +1388,11 @@ module Stripe params(_lodging: T.nilable(PaymentIntentUpdateParams::PaymentDetails::Lodging)).returns(T.nilable(PaymentIntentUpdateParams::PaymentDetails::Lodging)) } def lodging=(_lodging); end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end sig { params(_order_reference: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/v2/core/account_update_params.rbi b/rbi/stripe/params/v2/core/account_update_params.rbi index 3af09dba..1a2957b3 100644 --- a/rbi/stripe/params/v2/core/account_update_params.rbi +++ b/rbi/stripe/params/v2/core/account_update_params.rbi @@ -1987,6 +1987,27 @@ module Stripe } def initialize(date: nil, ip: nil, user_agent: nil); end end + class CryptoStorer < ::Stripe::RequestParams + # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + sig { returns(T.nilable(String)) } + def date; end + sig { params(_date: T.nilable(String)).returns(T.nilable(String)) } + def date=(_date); end + # The IP address from which the Account's representative accepted the terms of service. + sig { returns(T.nilable(String)) } + def ip; end + sig { params(_ip: T.nilable(String)).returns(T.nilable(String)) } + def ip=(_ip); end + # The user agent of the browser from which the Account's representative accepted the terms of service. + sig { returns(T.nilable(String)) } + def user_agent; end + sig { params(_user_agent: T.nilable(String)).returns(T.nilable(String)) } + def user_agent=(_user_agent); end + sig { + params(date: T.nilable(String), ip: T.nilable(String), user_agent: T.nilable(String)).void + } + def initialize(date: nil, ip: nil, user_agent: nil); end + end class Storer < ::Stripe::RequestParams # The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. sig { returns(T.nilable(String)) } @@ -2017,6 +2038,15 @@ module Stripe params(_account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account)).returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account)) } def account=(_account); end + # Details on the Account's acceptance of Crypto-storer-specific terms of service. + sig { + returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)) + } + def crypto_storer; end + sig { + params(_crypto_storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)).returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer)) + } + def crypto_storer=(_crypto_storer); end # Details on the Account's acceptance of Treasury-specific terms of service. sig { returns(T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)) @@ -2027,9 +2057,9 @@ module Stripe } def storer=(_storer); end sig { - params(account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account), storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)).void + params(account: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Account), crypto_storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::CryptoStorer), storer: T.nilable(V2::Core::AccountUpdateParams::Identity::Attestations::TermsOfService::Storer)).void } - def initialize(account: nil, storer: nil); end + def initialize(account: nil, crypto_storer: nil, storer: nil); end end # This hash is used to attest that the directors information provided to Stripe is both current and correct. sig { diff --git a/rbi/stripe/resources/payment_intent.rbi b/rbi/stripe/resources/payment_intent.rbi index 81f30cd5..44a9e2bd 100644 --- a/rbi/stripe/resources/payment_intent.rbi +++ b/rbi/stripe/resources/payment_intent.rbi @@ -17,13 +17,13 @@ module Stripe class PaymentIntent < APIResource class AmountDetails < ::Stripe::StripeObject class Shipping < ::Stripe::StripeObject - # Portion of the amount that is for shipping. + # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. sig { returns(T.nilable(Integer)) } def amount; end - # The postal code that represents the shipping source. + # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def from_postal_code; end - # The postal code that represents the shipping destination. + # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. sig { returns(T.nilable(String)) } def to_postal_code; end def self.inner_class_types @@ -34,7 +34,9 @@ module Stripe end end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(T.nilable(Integer)) } def total_tax_amount; end def self.inner_class_types @@ -55,7 +57,9 @@ module Stripe @field_remappings = {} end end - # The total discount applied on the transaction. + # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. @@ -1648,13 +1652,19 @@ module Stripe # Attribute for field car_rental sig { returns(T.nilable(CarRental)) } def car_rental; end - # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field. + # A unique value to identify the customer. This field is available only for card payments. + # + # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. sig { returns(T.nilable(String)) } def customer_reference; end # Attribute for field event_details sig { returns(T.nilable(EventDetails)) } def event_details; end - # A unique value assigned by the business to identify the transaction. + # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + # + # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + # + # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. sig { returns(T.nilable(String)) } def order_reference; end # Attribute for field subscription diff --git a/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi b/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi index 8ff3747d..fd814c40 100644 --- a/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi +++ b/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi @@ -84,7 +84,9 @@ module Stripe end end class Tax < ::Stripe::StripeObject - # Total portion of the amount that is for tax. + # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + # + # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. sig { returns(Integer) } def total_tax_amount; end def self.inner_class_types @@ -94,7 +96,9 @@ module Stripe @field_remappings = {} end end - # The amount an item was discounted for. Positive integer. + # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + # + # This field is mutually exclusive with the `amount_details[discount_amount]` field. sig { returns(T.nilable(Integer)) } def discount_amount; end # Unique identifier for the object. @@ -106,22 +110,24 @@ module Stripe # Payment method-specific information for line items. sig { returns(T.nilable(PaymentMethodOptions)) } def payment_method_options; end - # Unique identifier of the product. At most 12 characters long. + # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. sig { returns(T.nilable(String)) } def product_code; end - # Name of the product. At most 100 characters long. + # The product name of the line item. Required for L3 rates. At most 1024 characters long. + # + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end - # Number of items of the product. Positive integer. + # The quantity of items. Required for L3 rates. An integer greater than 0. sig { returns(Integer) } def quantity; end # Contains information about the tax on the item. sig { returns(T.nilable(Tax)) } def tax; end - # Cost of the product. Non-negative integer. + # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. sig { returns(Integer) } def unit_cost; end - # A unit of measure for the line item, such as gallons, feet, meters, etc. + # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long. sig { returns(T.nilable(String)) } def unit_of_measure; end end