stripe 18.0.0 → 18.1.0.pre.alpha.2

data/lib/stripe/resources/subscription_schedule.rb

@@ -171,6 +171,8 @@ module Stripe
       attr_reader :on_behalf_of
       # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
       attr_reader :transfer_data
+      # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+      attr_reader :phase_effective_at
 
       def self.inner_class_types
         @inner_class_types = {
@@ -186,18 +188,65 @@ 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 Phase < ::Stripe::StripeObject
       class AddInvoiceItem < ::Stripe::StripeObject
         class Discount < ::Stripe::StripeObject
+          class DiscountEnd < ::Stripe::StripeObject
+            # The discount end timestamp.
+            attr_reader :timestamp
+            # The discount end type.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
           # ID of the coupon to create a new discount for.
           attr_reader :coupon
           # ID of an existing discount on the object (or one of its ancestors) to reuse.
           attr_reader :discount
+          # Details to determine how long the discount should be applied for.
+          attr_reader :discount_end
           # ID of the promotion code to create a new discount for.
           attr_reader :promotion_code
 
           def self.inner_class_types
-            @inner_class_types = {}
+            @inner_class_types = { discount_end: DiscountEnd }
           end
 
           def self.field_remappings
@@ -317,15 +366,31 @@ module Stripe
       end
 
       class Discount < ::Stripe::StripeObject
+        class DiscountEnd < ::Stripe::StripeObject
+          # The discount end timestamp.
+          attr_reader :timestamp
+          # The discount end type.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # ID of the coupon to create a new discount for.
         attr_reader :coupon
         # ID of an existing discount on the object (or one of its ancestors) to reuse.
         attr_reader :discount
+        # Details to determine how long the discount should be applied for.
+        attr_reader :discount_end
         # ID of the promotion code to create a new discount for.
         attr_reader :promotion_code
 
         def self.inner_class_types
-          @inner_class_types = {}
+          @inner_class_types = { discount_end: DiscountEnd }
         end
 
         def self.field_remappings
@@ -379,13 +444,44 @@ module Stripe
         end
 
         class Discount < ::Stripe::StripeObject
+          class DiscountEnd < ::Stripe::StripeObject
+            # The discount end timestamp.
+            attr_reader :timestamp
+            # The discount end type.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
           # ID of the coupon to create a new discount for.
           attr_reader :coupon
           # ID of an existing discount on the object (or one of its ancestors) to reuse.
           attr_reader :discount
+          # Details to determine how long the discount should be applied for.
+          attr_reader :discount_end
           # ID of the promotion code to create a new discount for.
           attr_reader :promotion_code
 
+          def self.inner_class_types
+            @inner_class_types = { discount_end: DiscountEnd }
+          end
+
+          def self.field_remappings
+            @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
@@ -408,9 +504,30 @@ module Stripe
         attr_reader :quantity
         # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
         attr_reader :tax_rates
+        # Options that configure the trial on the subscription item.
+        attr_reader :trial
+        # The ID of the trial offer to apply to the configuration item.
+        attr_reader :trial_offer
+
+        def self.inner_class_types
+          @inner_class_types = {
+            billing_thresholds: BillingThresholds,
+            discounts: Discount,
+            trial: Trial,
+          }
+        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
 
         def self.inner_class_types
-          @inner_class_types = { billing_thresholds: BillingThresholds, discounts: Discount }
+          @inner_class_types = {}
         end
 
         def self.field_remappings
@@ -432,6 +549,31 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class TrialSettings < ::Stripe::StripeObject
+        class EndBehavior < ::Stripe::StripeObject
+          # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
+          attr_reader :prorate_up_front
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Defines how the subscription should behave when a trial ends.
+        attr_reader :end_behavior
+
+        def self.inner_class_types
+          @inner_class_types = { end_behavior: EndBehavior }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
       # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
       attr_reader :add_invoice_items
       # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.
@@ -464,14 +606,22 @@ module Stripe
       attr_reader :metadata
       # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
       attr_reader :on_behalf_of
+      # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
+      attr_reader :pause_collection
       # When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
       attr_reader :proration_behavior
       # The start of this phase of the subscription schedule.
       attr_reader :start_date
       # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
       attr_reader :transfer_data
+      # Specify behavior of the trial when crossing schedule phase boundaries
+      attr_reader :trial_continuation
       # When the trial ends within the phase.
       attr_reader :trial_end
+      # Settings related to any trials on the subscription during this phase.
+      attr_reader :trial_settings
+      # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+      attr_reader :effective_at
 
       def self.inner_class_types
         @inner_class_types = {
@@ -481,7 +631,9 @@ module Stripe
           discounts: Discount,
           invoice_settings: InvoiceSettings,
           items: Item,
+          pause_collection: PauseCollection,
           transfer_data: TransferData,
+          trial_settings: TrialSettings,
         }
       end
 
@@ -489,8 +641,112 @@ module Stripe
         @field_remappings = {}
       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 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
+        # The time the billing schedule applies from.
+        attr_reader :computed_timestamp
+        # 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`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillUntil < ::Stripe::StripeObject
+        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
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = { duration: Duration }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which subscription items the billing schedule applies to.
+      attr_reader :applies_to
+      # Specifies the start of the billing period.
+      attr_reader :bill_from
+      # Specifies the end of billing period.
+      attr_reader :bill_until
+      # Unique identifier for the billing schedule.
+      attr_reader :key
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # ID of the Connect Application that created the schedule.
     attr_reader :application
+    # Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
+    attr_reader :billing_behavior
     # The billing mode of the subscription.
     attr_reader :billing_mode
     # Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
@@ -503,12 +759,16 @@ module Stripe
     attr_reader :current_phase
     # ID of the customer who owns the subscription schedule.
     attr_reader :customer
+    # ID of the account who owns the subscription schedule.
+    attr_reader :customer_account
     # Attribute for field default_settings
     attr_reader :default_settings
     # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
     attr_reader :end_behavior
     # Unique identifier for the object.
     attr_reader :id
+    # Details of the most recent price migration that failed for the subscription schedule.
+    attr_reader :last_price_migration_error
     # 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
     # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
@@ -517,6 +777,8 @@ module Stripe
     attr_reader :object
     # Configuration for the subscription schedule's phases.
     attr_reader :phases
+    # Time period and invoice for a Subscription billed in advance.
+    attr_reader :prebilling
     # Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
     attr_reader :released_at
     # ID of the subscription once managed by the subscription schedule (if it is released).
@@ -527,6 +789,30 @@ module Stripe
     attr_reader :subscription
     # ID of the test clock this subscription schedule belongs to.
     attr_reader :test_clock
+    # Billing schedules for this subscription schedule.
+    attr_reader :billing_schedules
+    # The most recent invoice this subscription schedule has generated.
+    attr_reader :latest_invoice
+
+    # Amends an existing subscription schedule.
+    def amend(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Amends an existing subscription schedule.
+    def self.amend(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
     def cancel(params = {}, opts = {})
@@ -603,7 +889,10 @@ module Stripe
         billing_mode: BillingMode,
         current_phase: CurrentPhase,
         default_settings: DefaultSettings,
+        last_price_migration_error: LastPriceMigrationError,
         phases: Phase,
+        prebilling: Prebilling,
+        billing_schedules: BillingSchedule,
       }
     end
 

data/lib/stripe/resources/tax/form.rb

@@ -0,0 +1,264 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
+    #
+    # Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
+    class Form < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "tax.form"
+      def self.object_name
+        "tax.form"
+      end
+
+      class AuSerr < ::Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class CaMrdp < ::Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class EuDac7 < ::Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class FilingStatus < ::Stripe::StripeObject
+        class Jurisdiction < ::Stripe::StripeObject
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Indicates the level of the jurisdiction where the form was filed.
+          attr_reader :level
+          # [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States. Null for non-U.S. forms.
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time when the filing status was updated.
+        attr_reader :effective_at
+        # Attribute for field jurisdiction
+        attr_reader :jurisdiction
+        # The current status of the filed form.
+        attr_reader :value
+
+        def self.inner_class_types
+          @inner_class_types = { jurisdiction: Jurisdiction }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class GbMrdp < ::Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class NzMrdp < ::Stripe::StripeObject
+        # End date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_end_date
+        # Start date of the period represented by the information reported on the tax form.
+        attr_reader :reporting_period_start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Payee < ::Stripe::StripeObject
+        # The ID of the payee's Stripe account.
+        attr_reader :account
+        # The external reference to this payee.
+        attr_reader :external_reference
+        # Either `account` or `external_reference`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099K < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099Misc < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Us1099Nec < ::Stripe::StripeObject
+        # Year represented by the information reported on the tax form.
+        attr_reader :reporting_year
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field au_serr
+      attr_reader :au_serr
+      # Attribute for field ca_mrdp
+      attr_reader :ca_mrdp
+      # The form that corrects this form, if any.
+      attr_reader :corrected_by
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field eu_dac7
+      attr_reader :eu_dac7
+      # A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.
+      attr_reader :filing_statuses
+      # Attribute for field gb_mrdp
+      attr_reader :gb_mrdp
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # Attribute for field nz_mrdp
+      attr_reader :nz_mrdp
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Attribute for field payee
+      attr_reader :payee
+      # The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
+      attr_reader :type
+      # Attribute for field us_1099_k
+      attr_reader :us_1099_k
+      # Attribute for field us_1099_misc
+      attr_reader :us_1099_misc
+      # Attribute for field us_1099_nec
+      attr_reader :us_1099_nec
+
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/tax/forms", params: params, opts: opts)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Download the PDF for a tax form.
+      def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        execute_resource_request_stream(
+          :get,
+          format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          :files,
+          params,
+          opts,
+          &read_body_chunk_block
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          au_serr: AuSerr,
+          ca_mrdp: CaMrdp,
+          eu_dac7: EuDac7,
+          filing_statuses: FilingStatus,
+          gb_mrdp: GbMrdp,
+          nz_mrdp: NzMrdp,
+          payee: Payee,
+          us_1099_k: Us1099K,
+          us_1099_misc: Us1099Misc,
+          us_1099_nec: Us1099Nec,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end