stripe 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1

data/lib/stripe/params/subscription_schedule_amend_params.rb

@@ -77,6 +77,29 @@ module Stripe
         end
       end
 
+      class BillingSchedulesAction < ::Stripe::RequestParams
+        class AppliesTo < ::Stripe::RequestParams
+          # The ID of the price object.
+          attr_accessor :price
+          # Controls which subscription items the billing schedule applies to.
+          attr_accessor :type
+
+          def initialize(price: nil, type: nil)
+            @price = price
+            @type = type
+          end
+        end
+        # Specify which subscription items the billing schedule applies to.
+        attr_accessor :applies_to
+        # Select the action.
+        attr_accessor :type
+
+        def initialize(applies_to: nil, type: nil)
+          @applies_to = applies_to
+          @type = type
+        end
+      end
+
       class DiscountAction < ::Stripe::RequestParams
         class Add < ::Stripe::RequestParams
           class DiscountEnd < ::Stripe::RequestParams
@@ -217,7 +240,7 @@ module Stripe
           end
           # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
           attr_accessor :discounts
-          # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+          # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
           attr_accessor :metadata
           # The ID of the price object.
           attr_accessor :price
@@ -227,6 +250,8 @@ module Stripe
           attr_accessor :tax_rates
           # Options that configure the trial on the subscription item.
           attr_accessor :trial
+          # The ID of the trial offer to apply to the configuration item.
+          attr_accessor :trial_offer
 
           def initialize(
             discounts: nil,
@@ -234,7 +259,8 @@ module Stripe
             price: nil,
             quantity: nil,
             tax_rates: nil,
-            trial: nil
+            trial: nil,
+            trial_offer: nil
           )
             @discounts = discounts
             @metadata = metadata
@@ -242,6 +268,7 @@ module Stripe
             @quantity = quantity
             @tax_rates = tax_rates
             @trial = trial
+            @trial_offer = trial_offer
           end
         end
 
@@ -321,6 +348,8 @@ module Stripe
           attr_accessor :tax_rates
           # If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
           attr_accessor :trial
+          # The ID of the trial offer to apply to the configuration item.
+          attr_accessor :trial_offer
 
           def initialize(
             discounts: nil,
@@ -328,7 +357,8 @@ module Stripe
             price: nil,
             quantity: nil,
             tax_rates: nil,
-            trial: nil
+            trial: nil,
+            trial_offer: nil
           )
             @discounts = discounts
             @metadata = metadata
@@ -336,6 +366,7 @@ module Stripe
             @quantity = quantity
             @tax_rates = tax_rates
             @trial = trial
+            @trial_offer = trial_offer
           end
         end
         # Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
@@ -415,8 +446,12 @@ module Stripe
       attr_accessor :amendment_start
       # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
       attr_accessor :billing_cycle_anchor
+      # Actions to apply to the billing schedules.
+      attr_accessor :billing_schedules_actions
       # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
       attr_accessor :discount_actions
+      # 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_accessor :effective_at
       # Changes to the subscription items during the amendment time span.
       attr_accessor :item_actions
       # Instructions for how to modify phase metadata
@@ -434,7 +469,9 @@ module Stripe
         amendment_end: nil,
         amendment_start: nil,
         billing_cycle_anchor: nil,
+        billing_schedules_actions: nil,
         discount_actions: nil,
+        effective_at: nil,
         item_actions: nil,
         metadata_actions: nil,
         proration_behavior: nil,
@@ -445,7 +482,9 @@ module Stripe
         @amendment_end = amendment_end
         @amendment_start = amendment_start
         @billing_cycle_anchor = billing_cycle_anchor
+        @billing_schedules_actions = billing_schedules_actions
         @discount_actions = discount_actions
+        @effective_at = effective_at
         @item_actions = item_actions
         @metadata_actions = metadata_actions
         @proration_behavior = proration_behavior

data/lib/stripe/params/subscription_schedule_create_params.rb

@@ -23,6 +23,58 @@ module Stripe
       end
     end
 
+    class BillingSchedule < ::Stripe::RequestParams
+      class AppliesTo < ::Stripe::RequestParams
+        # The ID of the price object.
+        attr_accessor :price
+        # Controls which subscription items the billing schedule applies to.
+        attr_accessor :type
+
+        def initialize(price: nil, type: nil)
+          @price = price
+          @type = type
+        end
+      end
+
+      class BillUntil < ::Stripe::RequestParams
+        class Duration < ::Stripe::RequestParams
+          # Specifies billing duration. Either `day`, `week`, `month` or `year`.
+          attr_accessor :interval
+          # The multiplier applied to the interval.
+          attr_accessor :interval_count
+
+          def initialize(interval: nil, interval_count: nil)
+            @interval = interval
+            @interval_count = interval_count
+          end
+        end
+        # Specifies the billing period.
+        attr_accessor :duration
+        # The end date of the billing schedule.
+        attr_accessor :timestamp
+        # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+        attr_accessor :type
+
+        def initialize(duration: nil, timestamp: nil, type: nil)
+          @duration = duration
+          @timestamp = timestamp
+          @type = type
+        end
+      end
+      # Configure billing schedule differently for individual subscription items.
+      attr_accessor :applies_to
+      # The end date for the billing schedule.
+      attr_accessor :bill_until
+      # Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
+      attr_accessor :key
+
+      def initialize(applies_to: nil, bill_until: nil, key: nil)
+        @applies_to = applies_to
+        @bill_until = bill_until
+        @key = key
+      end
+    end
+
     class DefaultSettings < ::Stripe::RequestParams
       class AutomaticTax < ::Stripe::RequestParams
         class Liability < ::Stripe::RequestParams
@@ -100,7 +152,7 @@ module Stripe
       attr_accessor :application_fee_percent
       # Default settings for automatic tax computation.
       attr_accessor :automatic_tax
-      # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+      # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
       attr_accessor :billing_cycle_anchor
       # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
       attr_accessor :billing_thresholds
@@ -114,6 +166,8 @@ module Stripe
       attr_accessor :invoice_settings
       # The account on behalf of which to charge, for each of the associated subscription's invoices.
       attr_accessor :on_behalf_of
+      # 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_accessor :phase_effective_at
       # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
       attr_accessor :transfer_data
 
@@ -127,6 +181,7 @@ module Stripe
         description: nil,
         invoice_settings: nil,
         on_behalf_of: nil,
+        phase_effective_at: nil,
         transfer_data: nil
       )
         @application_fee_percent = application_fee_percent
@@ -138,6 +193,7 @@ module Stripe
         @description = description
         @invoice_settings = invoice_settings
         @on_behalf_of = on_behalf_of
+        @phase_effective_at = phase_effective_at
         @transfer_data = transfer_data
       end
     end
@@ -227,7 +283,7 @@ module Stripe
           attr_accessor :currency
           # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
           attr_accessor :product
-          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+          # Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
           attr_accessor :tax_behavior
           # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
           attr_accessor :unit_amount
@@ -250,13 +306,13 @@ module Stripe
         end
         # The coupons to redeem into discounts for the item.
         attr_accessor :discounts
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata
         # The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
         attr_accessor :period
         # The ID of the price object. One of `price` or `price_data` is required.
         attr_accessor :price
-        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+        # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
         attr_accessor :price_data
         # Quantity for this item. Defaults to 1.
         attr_accessor :quantity
@@ -400,7 +456,7 @@ module Stripe
 
       class Item < ::Stripe::RequestParams
         class BillingThresholds < ::Stripe::RequestParams
-          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
+          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
           attr_accessor :usage_gte
 
           def initialize(usage_gte: nil)
@@ -469,7 +525,7 @@ module Stripe
           attr_accessor :product
           # The recurring components of a price such as `interval` and `interval_count`.
           attr_accessor :recurring
-          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+          # Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
           attr_accessor :tax_behavior
           # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
           attr_accessor :unit_amount
@@ -508,20 +564,22 @@ module Stripe
         attr_accessor :billing_thresholds
         # The coupons to redeem into discounts for the subscription item.
         attr_accessor :discounts
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
+        # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
         attr_accessor :metadata
         # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
         attr_accessor :plan
         # The ID of the price object.
         attr_accessor :price
-        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
+        # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
         attr_accessor :price_data
         # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
         attr_accessor :quantity
-        # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
+        # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
         attr_accessor :tax_rates
         # Options that configure the trial on the subscription item.
         attr_accessor :trial
+        # The ID of the trial offer to apply to the configuration item.
+        attr_accessor :trial_offer
 
         def initialize(
           billing_thresholds: nil,
@@ -532,7 +590,8 @@ module Stripe
           price_data: nil,
           quantity: nil,
           tax_rates: nil,
-          trial: nil
+          trial: nil,
+          trial_offer: nil
         )
           @billing_thresholds = billing_thresholds
           @discounts = discounts
@@ -543,6 +602,7 @@ module Stripe
           @quantity = quantity
           @tax_rates = tax_rates
           @trial = trial
+          @trial_offer = trial_offer
         end
       end
 
@@ -589,7 +649,7 @@ module Stripe
       attr_accessor :application_fee_percent
       # Automatic tax settings for this phase.
       attr_accessor :automatic_tax
-      # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+      # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
       attr_accessor :billing_cycle_anchor
       # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
       attr_accessor :billing_thresholds
@@ -599,7 +659,7 @@ module Stripe
       attr_accessor :currency
       # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
       attr_accessor :default_payment_method
-      # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
+      # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
       attr_accessor :default_tax_rates
       # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
       attr_accessor :description
@@ -607,19 +667,21 @@ module Stripe
       attr_accessor :discounts
       # The number of intervals the phase should last. If set, `end_date` must not be set.
       attr_accessor :duration
-      # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
+      # 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_accessor :effective_at
+      # The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
       attr_accessor :end_date
       # All invoices will be billed using the specified settings.
       attr_accessor :invoice_settings
       # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
       attr_accessor :items
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
       attr_accessor :metadata
       # The account on behalf of which to charge, for each of the associated subscription's invoices.
       attr_accessor :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).
+      # 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://docs.stripe.com/billing/subscriptions/pause-payment).
       attr_accessor :pause_collection
-      # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
+      # Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
       attr_accessor :proration_behavior
       # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
       attr_accessor :transfer_data
@@ -645,6 +707,7 @@ module Stripe
         description: nil,
         discounts: nil,
         duration: nil,
+        effective_at: nil,
         end_date: nil,
         invoice_settings: nil,
         items: nil,
@@ -670,6 +733,7 @@ module Stripe
         @description = description
         @discounts = discounts
         @duration = duration
+        @effective_at = effective_at
         @end_date = end_date
         @invoice_settings = invoice_settings
         @items = items
@@ -700,6 +764,8 @@ module Stripe
     attr_accessor :billing_behavior
     # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
     attr_accessor :billing_mode
+    # Sets the billing schedules for the subscription schedule.
+    attr_accessor :billing_schedules
     # The identifier of the customer to create the subscription schedule for.
     attr_accessor :customer
     # The identifier of the account to create the subscription schedule for.
@@ -712,7 +778,7 @@ module Stripe
     attr_accessor :expand
     # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
     attr_accessor :from_subscription
-    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
     # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
     attr_accessor :phases
@@ -724,6 +790,7 @@ module Stripe
     def initialize(
       billing_behavior: nil,
       billing_mode: nil,
+      billing_schedules: nil,
       customer: nil,
       customer_account: nil,
       default_settings: nil,
@@ -737,6 +804,7 @@ module Stripe
     )
       @billing_behavior = billing_behavior
       @billing_mode = billing_mode
+      @billing_schedules = billing_schedules
       @customer = customer
       @customer_account = customer_account
       @default_settings = default_settings