stripe 17.2.0 → 17.3.0.pre.alpha.2

data/lib/stripe/resources/subscription.rb

@@ -97,6 +97,173 @@ module Stripe
       end
     end
 
+    class BillingSchedule < ::Stripe::StripeObject
+      class AppliesTo < ::Stripe::StripeObject
+        # The billing schedule will apply to the subscription item with the given price ID.
+        attr_reader :price
+        # Controls which subscription items the billing schedule applies to.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillFrom < ::Stripe::StripeObject
+        class AmendmentStart < ::Stripe::StripeObject
+          # Use an index to specify the position of an amendment to start prebilling with.
+          attr_reader :index
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class LineStartsAt < ::Stripe::StripeObject
+          # Unique identifier for the object.
+          attr_reader :id
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Relative < ::Stripe::StripeObject
+          # Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
+          attr_reader :interval
+          # The multiplier applied to the interval.
+          attr_reader :interval_count
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Use an index to specify the position of an amendment to start prebilling with.
+        attr_reader :amendment_start
+        # The time the billing schedule applies from.
+        attr_reader :computed_timestamp
+        # Lets you bill the period starting from a particular Quote line.
+        attr_reader :line_starts_at
+        # Timestamp is calculated from the request time.
+        attr_reader :relative
+        # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+        attr_reader :timestamp
+        # Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amendment_start: AmendmentStart,
+            line_starts_at: LineStartsAt,
+            relative: Relative,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillUntil < ::Stripe::StripeObject
+        class AmendmentEnd < ::Stripe::StripeObject
+          # Use an index to specify the position of an amendment to end prebilling with.
+          attr_reader :index
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Duration < ::Stripe::StripeObject
+          # Specifies billing duration. Either `day`, `week`, `month` or `year`.
+          attr_reader :interval
+          # The multiplier applied to the interval.
+          attr_reader :interval_count
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class LineEndsAt < ::Stripe::StripeObject
+          # Unique identifier for the object.
+          attr_reader :id
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The timestamp the billing schedule will apply until.
+        attr_reader :computed_timestamp
+        # Specifies the billing period.
+        attr_reader :duration
+        # If specified, the billing schedule will apply until the specified timestamp.
+        attr_reader :timestamp
+        # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+        attr_reader :type
+        # Use an index to specify the position of an amendment to end prebilling with.
+        attr_reader :amendment_end
+        # Lets you bill the period ending at a particular Quote line.
+        attr_reader :line_ends_at
+
+        def self.inner_class_types
+          @inner_class_types = {
+            duration: Duration,
+            amendment_end: AmendmentEnd,
+            line_ends_at: LineEndsAt,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which subscription items the billing schedule applies to.
+      attr_reader :applies_to
+      # Specifies the billing period.
+      attr_reader :bill_until
+      # Unique identifier for the billing schedule.
+      attr_reader :key
+      # Specifies the start of the billing period.
+      attr_reader :bill_from
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo, bill_until: BillUntil, bill_from: BillFrom }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class BillingThresholds < ::Stripe::StripeObject
       # Monetary threshold that triggers the subscription to create an invoice
       attr_reader :amount_gte
@@ -158,6 +325,37 @@ module Stripe
       end
     end
 
+    class LastPriceMigrationError < ::Stripe::StripeObject
+      class FailedTransition < ::Stripe::StripeObject
+        # The original price to be migrated.
+        attr_reader :source_price
+        # The intended resulting price of the migration.
+        attr_reader :target_price
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The time at which the price migration encountered an error.
+      attr_reader :errored_at
+      # The involved price pairs in each failed transition.
+      attr_reader :failed_transitions
+      # The type of error encountered by the price migration.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { failed_transitions: FailedTransition }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class PauseCollection < ::Stripe::StripeObject
       # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
       attr_reader :behavior
@@ -289,6 +487,16 @@ module Stripe
           end
         end
 
+        class IdBankTransfer < ::Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Konbini < ::Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
@@ -299,6 +507,37 @@ module Stripe
           end
         end
 
+        class Pix < ::Stripe::StripeObject
+          class MandateOptions < ::Stripe::StripeObject
+            # Amount to be charged for future payments.
+            attr_reader :amount
+            # Determines if the amount includes the IOF tax.
+            attr_reader :amount_includes_iof
+            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+            attr_reader :end_date
+            # Schedule at which the future payments will be charged.
+            attr_reader :payment_schedule
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field mandate_options
+          attr_reader :mandate_options
+
+          def self.inner_class_types
+            @inner_class_types = { mandate_options: MandateOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class SepaDebit < ::Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
@@ -309,11 +548,44 @@ module Stripe
           end
         end
 
+        class Upi < ::Stripe::StripeObject
+          class MandateOptions < ::Stripe::StripeObject
+            # Amount to be charged for future payments.
+            attr_reader :amount
+            # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+            attr_reader :amount_type
+            # A description of the mandate or subscription that is meant to be displayed to the customer.
+            attr_reader :description
+            # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_reader :end_date
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field mandate_options
+          attr_reader :mandate_options
+
+          def self.inner_class_types
+            @inner_class_types = { mandate_options: MandateOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class UsBankAccount < ::Stripe::StripeObject
           class FinancialConnections < ::Stripe::StripeObject
             class Filters < ::Stripe::StripeObject
               # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
               attr_reader :account_subcategories
+              # The institution to use to filter for possible accounts to link.
+              attr_reader :institution
 
               def self.inner_class_types
                 @inner_class_types = {}
@@ -359,10 +631,16 @@ module Stripe
         attr_reader :card
         # This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
         attr_reader :customer_balance
+        # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
+        attr_reader :id_bank_transfer
         # This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
         attr_reader :konbini
+        # This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
+        attr_reader :pix
         # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
         attr_reader :sepa_debit
+        # This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
+        attr_reader :upi
         # This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
         attr_reader :us_bank_account
 
@@ -372,8 +650,11 @@ module Stripe
             bancontact: Bancontact,
             card: Card,
             customer_balance: CustomerBalance,
+            id_bank_transfer: IdBankTransfer,
             konbini: Konbini,
+            pix: Pix,
             sepa_debit: SepaDebit,
+            upi: Upi,
             us_bank_account: UsBankAccount,
           }
         end
@@ -418,6 +699,8 @@ module Stripe
       attr_reader :billing_cycle_anchor
       # The point after which the changes reflected by this update will be discarded and no longer applied.
       attr_reader :expires_at
+      # The number of iterations of prebilling to apply.
+      attr_reader :prebilling_iterations
       # List of subscription items, each with an attached plan, that will be set if the update is applied.
       attr_reader :subscription_items
       # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
@@ -434,6 +717,25 @@ module Stripe
       end
     end
 
+    class Prebilling < ::Stripe::StripeObject
+      # ID of the prebilling invoice.
+      attr_reader :invoice
+      # The end of the last period for which the invoice pre-bills.
+      attr_reader :period_end
+      # The start of the first period for which the invoice pre-bills.
+      attr_reader :period_start
+      # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
+      attr_reader :update_behavior
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class TransferData < ::Stripe::StripeObject
       # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
       attr_reader :amount_percent
@@ -479,12 +781,16 @@ module Stripe
     attr_reader :application_fee_percent
     # Attribute for field automatic_tax
     attr_reader :automatic_tax
+    # The Billing Cadence which controls the timing of recurring invoice generation for this subscription.If unset, the subscription will bill according to its own configured schedule and create its own invoices.If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
+    attr_reader :billing_cadence
     # The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
     attr_reader :billing_cycle_anchor
     # The fixed values used to calculate the `billing_cycle_anchor`.
     attr_reader :billing_cycle_anchor_config
     # The billing mode of the subscription.
     attr_reader :billing_mode
+    # Billing schedules for this subscription.
+    attr_reader :billing_schedules
     # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
     attr_reader :billing_thresholds
     # A date in the future at which the subscription will automatically get canceled
@@ -503,6 +809,8 @@ module Stripe
     attr_reader :currency
     # ID of the customer who owns the subscription.
     attr_reader :customer
+    # ID of the account who owns the subscription.
+    attr_reader :customer_account
     # Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
     attr_reader :days_until_due
     # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
@@ -523,6 +831,8 @@ module Stripe
     attr_reader :invoice_settings
     # List of subscription items, each with an attached price.
     attr_reader :items
+    # Details of the most recent price migration that failed for the subscription.
+    attr_reader :last_price_migration_error
     # The most recent invoice this subscription has generated.
     attr_reader :latest_invoice
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -545,6 +855,8 @@ module Stripe
     attr_reader :pending_setup_intent
     # If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
     attr_reader :pending_update
+    # Time period and invoice for a Subscription billed in advance.
+    attr_reader :prebilling
     # The schedule attached to the subscription
     attr_reader :schedule
     # Date when the subscription was first created. The date might differ from the `created` date due to backdating.
@@ -572,6 +884,26 @@ module Stripe
     # If the subscription has a trial, the beginning of that trial.
     attr_reader :trial_start
 
+    # Attach a Billing Cadence to an existing subscription. When attached, the subscription is billed by the Billing Cadence, potentially sharing invoices with the other subscriptions linked to the Billing Cadence.
+    def attach_cadence(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/attach_cadence", { subscription: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Attach a Billing Cadence to an existing subscription. When attached, the subscription is billed by the Billing Cadence, potentially sharing invoices with the other subscriptions linked to the Billing Cadence.
+    def self.attach_cadence(subscription, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/attach_cadence", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
     #
     # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
@@ -726,13 +1058,16 @@ module Stripe
         automatic_tax: AutomaticTax,
         billing_cycle_anchor_config: BillingCycleAnchorConfig,
         billing_mode: BillingMode,
+        billing_schedules: BillingSchedule,
         billing_thresholds: BillingThresholds,
         cancellation_details: CancellationDetails,
         invoice_settings: InvoiceSettings,
+        last_price_migration_error: LastPriceMigrationError,
         pause_collection: PauseCollection,
         payment_settings: PaymentSettings,
         pending_invoice_item_interval: PendingInvoiceItemInterval,
         pending_update: PendingUpdate,
+        prebilling: Prebilling,
         transfer_data: TransferData,
         trial_settings: TrialSettings,
       }

data/lib/stripe/resources/subscription_item.rb

@@ -27,6 +27,23 @@ module Stripe
         @field_remappings = {}
       end
     end
+
+    class Trial < ::Stripe::StripeObject
+      # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
+      attr_reader :converts_to
+      # Determines the type of trial for this item.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The time period the subscription item has been billed for.
+    attr_reader :billed_until
     # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
     attr_reader :billing_thresholds
     # Time at which the object was created. Measured in seconds since the Unix epoch.
@@ -65,6 +82,8 @@ module Stripe
     attr_reader :subscription
     # The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
     attr_reader :tax_rates
+    # Options that configure the trial on the subscription item.
+    attr_reader :trial
     # Always true for a deleted object
     attr_reader :deleted
 
@@ -119,7 +138,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = { billing_thresholds: BillingThresholds }
+      @inner_class_types = { billing_thresholds: BillingThresholds, trial: Trial }
     end
 
     def self.field_remappings