stripe 15.5.0.pre.beta.2 → 15.6.0.pre.alpha.1

data/lib/stripe/resources/v2/billing/cadence.rb

@@ -0,0 +1,182 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class Cadence < APIResource
+        OBJECT_NAME = "v2.billing.cadence"
+        def self.object_name
+          "v2.billing.cadence"
+        end
+
+        class BillingCycle < Stripe::StripeObject
+          class Day < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            end
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Month < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            end
+            # The day to anchor the billing on for a type="month" billing cycle from 1-31.
+            # If this number is greater than the number of days in the month being billed,
+            # this will anchor to the last day of the month.
+            attr_reader :day_of_month
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Week < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            end
+            # The day of the week to bill the type=week billing cycle on.
+            # Numbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601 week day numbering.
+            attr_reader :day_of_week
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+
+          class Year < Stripe::StripeObject
+            class Time < Stripe::StripeObject
+              # The hour at which the billing cycle ends.
+              # This must be an integer between 0 and 23, inclusive.
+              # 0 represents midnight, and 23 represents 11 PM.
+              attr_reader :hour
+              # The minute at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :minute
+              # The second at which the billing cycle ends.
+              # Must be an integer between 0 and 59, inclusive.
+              attr_reader :second
+            end
+            # The day to anchor the billing on for a type="month" billing cycle from 1-31.
+            # If this number is greater than the number of days in the month being billed,
+            # this will anchor to the last day of the month.
+            attr_reader :day_of_month
+            # The month to bill on from 1-12. If not provided, this will default to the month the cadence was created.
+            attr_reader :month_of_year
+            # The time at which the billing cycle ends.
+            attr_reader :time
+          end
+          # The number of intervals (specified in the interval attribute) between cadence billings. For example, type=month and interval_count=3 bills every 3 months.
+          attr_reader :interval_count
+          # The frequency at which a cadence bills.
+          attr_reader :type
+          # Specific configuration for determining billing dates when type=day.
+          attr_reader :day
+          # Specific configuration for determining billing dates when type=month.
+          attr_reader :month
+          # Specific configuration for determining billing dates when type=week.
+          attr_reader :week
+          # Specific configuration for determining billing dates when type=year.
+          attr_reader :year
+        end
+
+        class InvoiceDiscountRule < Stripe::StripeObject
+          class PercentOff < Stripe::StripeObject
+            class MaximumApplications < Stripe::StripeObject
+              # Max applications type of this discount, ex: indefinite.
+              attr_reader :type
+            end
+            # The maximum applications configuration for this discount.
+            attr_reader :maximum_applications
+            # Percent that will be taken off of the amount. For example, percent_off of 50.0 will make $100 amount $50 instead.
+            attr_reader :percent_off
+          end
+          # Unique identifier for the object.
+          attr_reader :id
+          # The type of the discount.
+          attr_reader :type
+          # Details if the discount is a percentage off.
+          attr_reader :percent_off
+        end
+
+        class Payer < Stripe::StripeObject
+          # The ID of the Billing Profile object which determines how a bill will be paid.
+          attr_reader :billing_profile
+          # The ID of the Customer object.
+          attr_reader :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_reader :type
+        end
+
+        class Settings < Stripe::StripeObject
+          class Bill < Stripe::StripeObject
+            # The ID of the referenced settings object.
+            attr_reader :id
+            # Returns the Settings Version when the cadence is pinned to a specific version.
+            attr_reader :version
+          end
+
+          class Collection < Stripe::StripeObject
+            # The ID of the referenced settings object.
+            attr_reader :id
+            # Returns the Settings Version when the cadence is pinned to a specific version.
+            attr_reader :version
+          end
+          # Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices.
+          attr_reader :bill
+          # Settings that configure and manage the behavior of collecting payments.
+          attr_reader :collection
+        end
+        # The billing cycle is the object that defines future billing cycle dates.
+        attr_reader :billing_cycle
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # The discount rules applied to all invoices for the cadence.
+        attr_reader :invoice_discount_rules
+        # Set of [key-value pairs](/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_reader :metadata
+        # The date that the billing cadence will next bill. Null if the cadence is not active.
+        attr_reader :next_billing_date
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The payer determines the entity financially responsible for the bill.
+        attr_reader :payer
+        # The settings associated with the cadence.
+        attr_reader :settings
+        # The current status of the cadence.
+        attr_reader :status
+        # The ID of the Test Clock.
+        attr_reader :test_clock
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/collection_setting.rb

@@ -0,0 +1,148 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # Settings that configure and manage the behavior of collecting payments.
+      class CollectionSetting < APIResource
+        OBJECT_NAME = "v2.billing.collection_setting"
+        def self.object_name
+          "v2.billing.collection_setting"
+        end
+
+        class EmailDelivery < Stripe::StripeObject
+          class PaymentDue < Stripe::StripeObject
+            # If true an email for the invoice would be generated and sent out.
+            attr_reader :enabled
+            # If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+            attr_reader :include_payment_link
+          end
+          # Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+          attr_reader :payment_due
+        end
+
+        class PaymentMethodOptions < Stripe::StripeObject
+          class AcssDebit < Stripe::StripeObject
+            class MandateOptions < Stripe::StripeObject
+              # Transaction type of the mandate.
+              attr_reader :transaction_type
+            end
+            # Additional fields for Mandate creation.
+            attr_reader :mandate_options
+            # Verification method.
+            attr_reader :verification_method
+          end
+
+          class Bancontact < Stripe::StripeObject
+            # Preferred language of the Bancontact authorization page that the customer is redirected to.
+            attr_reader :preferred_language
+          end
+
+          class Card < Stripe::StripeObject
+            class MandateOptions < Stripe::StripeObject
+              # Amount to be charged for future payments.
+              attr_reader :amount
+              # The AmountType for the mandate. One of `fixed` or `maximum`.
+              attr_reader :amount_type
+              # A description of the mandate that is meant to be displayed to the customer.
+              attr_reader :description
+            end
+            # Configuration options for setting up an eMandate for cards issued in India.
+            attr_reader :mandate_options
+            # Selected network to process the payment on. Depends on the available networks of the card.
+            attr_reader :network
+            # An advanced option 3D Secure. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers
+            # for authentication based on risk level and [other requirements](https://docs.corp.stripe.com/strong-customer-authentication).
+            # However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
+            # Read our guide on [manually requesting 3D Secure](https://docs.corp.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
+            attr_reader :request_three_d_secure
+          end
+
+          class CustomerBalance < Stripe::StripeObject
+            class BankTransfer < Stripe::StripeObject
+              class EuBankTransfer < Stripe::StripeObject
+                # The desired country code of the bank account information.
+                attr_reader :country
+              end
+              # Configuration for `eu_bank_transfer` funding type. Required if `type` is `eu_bank_transfer`.
+              attr_reader :eu_bank_transfer
+              # The bank transfer type that can be used for funding.
+              attr_reader :type
+            end
+            # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
+            attr_reader :bank_transfer
+            # The funding method type to be used when there are not enough funds in the customer balance. Currently the only supported value is `bank_transfer`.
+            attr_reader :funding_type
+          end
+
+          class Konbini < Stripe::StripeObject; end
+          class SepaDebit < Stripe::StripeObject; end
+
+          class UsBankAccount < Stripe::StripeObject
+            class FinancialConnections < Stripe::StripeObject
+              class Filters < Stripe::StripeObject
+                # The account subcategories to use to filter for selectable accounts.
+                attr_reader :account_subcategories
+              end
+              # Provide filters for the linked accounts that the customer can select for the payment method.
+              attr_reader :filters
+              # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included.
+              attr_reader :permissions
+              # List of data features that you would like to retrieve upon account creation.
+              attr_reader :prefetch
+            end
+            # Additional fields for Financial Connections Session creation.
+            attr_reader :financial_connections
+            # Verification method.
+            attr_reader :verification_method
+          end
+          # This sub-hash contains details about the Canadian pre-authorized debit payment method options.
+          attr_reader :acss_debit
+          # This sub-hash contains details about the Bancontact payment method.
+          attr_reader :bancontact
+          # This sub-hash contains details about the Card payment method options.
+          attr_reader :card
+          # This sub-hash contains details about the Bank transfer payment method options.
+          attr_reader :customer_balance
+          # This sub-hash contains details about the Konbini payment method options.
+          attr_reader :konbini
+          # This sub-hash contains details about the SEPA Direct Debit payment method options.
+          attr_reader :sepa_debit
+          # This sub-hash contains details about the ACH direct debit payment method options.
+          attr_reader :us_bank_account
+        end
+        # Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this
+        # bill at the end of the period using the payment method attached to the payer profile. When sending an invoice,
+        # Stripe will email your payer profile an invoice with payment instructions.
+        # Defaults to automatic.
+        attr_reader :collection_method
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # An optional field for adding a display name for the CollectionSetting object.
+        attr_reader :display_name
+        # Email delivery settings.
+        attr_reader :email_delivery
+        # The ID of the CollectionSetting.
+        attr_reader :id
+        # The latest version of the current settings object. This will be
+        # Updated every time an attribute of the settings is updated.
+        attr_reader :latest_version
+        # The current live version of the settings object. This can be different from
+        # latest_version if settings are updated without setting live_version='latest'.
+        attr_reader :live_version
+        # A lookup key used to retrieve settings dynamically from a static string.
+        # This may be up to 200 characters.
+        attr_reader :lookup_key
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.
+        attr_reader :payment_method_configuration
+        # Payment Method specific configuration stored on the object.
+        attr_reader :payment_method_options
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/collection_setting_version.rb

@@ -0,0 +1,136 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CollectionSettingVersion < APIResource
+        OBJECT_NAME = "v2.billing.collection_setting_version"
+        def self.object_name
+          "v2.billing.collection_setting_version"
+        end
+
+        class EmailDelivery < Stripe::StripeObject
+          class PaymentDue < Stripe::StripeObject
+            # If true an email for the invoice would be generated and sent out.
+            attr_reader :enabled
+            # If true the payment link to hosted invocie page would be included in email and PDF of the invoice.
+            attr_reader :include_payment_link
+          end
+          # Controls emails for when the payment is due. For example after the invoice is finilized and transition to Open state.
+          attr_reader :payment_due
+        end
+
+        class PaymentMethodOptions < Stripe::StripeObject
+          class AcssDebit < Stripe::StripeObject
+            class MandateOptions < Stripe::StripeObject
+              # Transaction type of the mandate.
+              attr_reader :transaction_type
+            end
+            # Additional fields for Mandate creation.
+            attr_reader :mandate_options
+            # Verification method.
+            attr_reader :verification_method
+          end
+
+          class Bancontact < Stripe::StripeObject
+            # Preferred language of the Bancontact authorization page that the customer is redirected to.
+            attr_reader :preferred_language
+          end
+
+          class Card < Stripe::StripeObject
+            class MandateOptions < Stripe::StripeObject
+              # Amount to be charged for future payments.
+              attr_reader :amount
+              # The AmountType for the mandate. One of `fixed` or `maximum`.
+              attr_reader :amount_type
+              # A description of the mandate that is meant to be displayed to the customer.
+              attr_reader :description
+            end
+            # Configuration options for setting up an eMandate for cards issued in India.
+            attr_reader :mandate_options
+            # Selected network to process the payment on. Depends on the available networks of the card.
+            attr_reader :network
+            # An advanced option 3D Secure. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers
+            # for authentication based on risk level and [other requirements](https://docs.corp.stripe.com/strong-customer-authentication).
+            # However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
+            # Read our guide on [manually requesting 3D Secure](https://docs.corp.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
+            attr_reader :request_three_d_secure
+          end
+
+          class CustomerBalance < Stripe::StripeObject
+            class BankTransfer < Stripe::StripeObject
+              class EuBankTransfer < Stripe::StripeObject
+                # The desired country code of the bank account information.
+                attr_reader :country
+              end
+              # Configuration for `eu_bank_transfer` funding type. Required if `type` is `eu_bank_transfer`.
+              attr_reader :eu_bank_transfer
+              # The bank transfer type that can be used for funding.
+              attr_reader :type
+            end
+            # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
+            attr_reader :bank_transfer
+            # The funding method type to be used when there are not enough funds in the customer balance. Currently the only supported value is `bank_transfer`.
+            attr_reader :funding_type
+          end
+
+          class Konbini < Stripe::StripeObject; end
+          class SepaDebit < Stripe::StripeObject; end
+
+          class UsBankAccount < Stripe::StripeObject
+            class FinancialConnections < Stripe::StripeObject
+              class Filters < Stripe::StripeObject
+                # The account subcategories to use to filter for selectable accounts.
+                attr_reader :account_subcategories
+              end
+              # Provide filters for the linked accounts that the customer can select for the payment method.
+              attr_reader :filters
+              # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included.
+              attr_reader :permissions
+              # List of data features that you would like to retrieve upon account creation.
+              attr_reader :prefetch
+            end
+            # Additional fields for Financial Connections Session creation.
+            attr_reader :financial_connections
+            # Verification method.
+            attr_reader :verification_method
+          end
+          # This sub-hash contains details about the Canadian pre-authorized debit payment method options.
+          attr_reader :acss_debit
+          # This sub-hash contains details about the Bancontact payment method.
+          attr_reader :bancontact
+          # This sub-hash contains details about the Card payment method options.
+          attr_reader :card
+          # This sub-hash contains details about the Bank transfer payment method options.
+          attr_reader :customer_balance
+          # This sub-hash contains details about the Konbini payment method options.
+          attr_reader :konbini
+          # This sub-hash contains details about the SEPA Direct Debit payment method options.
+          attr_reader :sepa_debit
+          # This sub-hash contains details about the ACH direct debit payment method options.
+          attr_reader :us_bank_account
+        end
+        # Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this
+        # bill at the end of the period using the payment method attached to the payer profile. When sending an invoice,
+        # Stripe will email your payer profile an invoice with payment instructions.
+        # Defaults to automatic.
+        attr_reader :collection_method
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Email delivery settings.
+        attr_reader :email_delivery
+        # The ID of the CollectionSettingVersion object.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.
+        attr_reader :payment_method_configuration
+        # Payment Method specific configuration stored on the object.
+        attr_reader :payment_method_options
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/custom_pricing_unit.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # The Custom Pricing Unit object.
+      class CustomPricingUnit < APIResource
+        OBJECT_NAME = "v2.billing.custom_pricing_unit"
+        def self.object_name
+          "v2.billing.custom_pricing_unit"
+        end
+
+        # Whether the custom pricing unit is active.
+        attr_reader :active
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Description that customers will see in the invoice line item.
+        # Maximum length of 10 characters.
+        attr_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # An internal key you can use to search for a particular Custom Pricing Unit.
+        # Maximum length of 200 characters.
+        attr_reader :lookup_key
+        # Set of [key-value pairs](/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/intent.rb

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class Intent < APIResource
+        OBJECT_NAME = "v2.billing.intent"
+        def self.object_name
+          "v2.billing.intent"
+        end
+
+        class AmountDetails < Stripe::StripeObject
+          # Three-letter ISO currency code, in lowercase. Must be a supported currency.
+          attr_reader :currency
+          # Amount of discount applied.
+          attr_reader :discount
+          # Amount of shipping charges.
+          attr_reader :shipping
+          # Subtotal amount before tax and discounts.
+          attr_reader :subtotal
+          # Amount of tax.
+          attr_reader :tax
+          # Total amount for the Billing Intent.
+          attr_reader :total
+        end
+
+        class StatusTransitions < Stripe::StripeObject
+          # Time at which the Billing Intent was canceled.
+          attr_reader :canceled_at
+          # Time at which the Billing Intent was committed.
+          attr_reader :committed_at
+          # Time at which the Billing Intent was drafted.
+          attr_reader :drafted_at
+          # Time at which the Billing Intent was reserved.
+          attr_reader :reserved_at
+        end
+        # Breakdown of the amount for this Billing Intent.
+        attr_reader :amount_details
+        # Time at which the object was created.
+        attr_reader :created
+        # Three-letter ISO currency code, in lowercase. Must be a supported currency.
+        attr_reader :currency
+        # Unique identifier for the object.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Current status of the Billing Intent.
+        attr_reader :status
+        # Timestamps for status transitions of the Billing Intent.
+        attr_reader :status_transitions
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # ID of an existing Cadence to use.
+        attr_reader :cadence
+      end
+    end
+  end
+end