stripe 15.1.0 → 15.2.0

data/lib/stripe/services/source_service.rb

@@ -640,7 +640,7 @@ module Stripe
 
     # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
     #
-    # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail.
+    # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail.
     def update(source, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/subscription_item_service.rb

@@ -28,6 +28,15 @@ module Stripe
     end
 
     class UpdateParams < 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))
+        attr_accessor :usage_gte
+
+        def initialize(usage_gte: nil)
+          @usage_gte = usage_gte
+        end
+      end
+
       class Discount < Stripe::RequestParams
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
@@ -84,6 +93,8 @@ module Stripe
           @unit_amount_decimal = unit_amount_decimal
         end
       end
+      # 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
       # The coupons to redeem into discounts for the subscription item.
       attr_accessor :discounts
       # Specifies which fields in the response should be expanded.
@@ -116,6 +127,7 @@ module Stripe
       attr_accessor :tax_rates
 
       def initialize(
+        billing_thresholds: nil,
         discounts: nil,
         expand: nil,
         metadata: nil,
@@ -129,6 +141,7 @@ module Stripe
         quantity: nil,
         tax_rates: nil
       )
+        @billing_thresholds = billing_thresholds
         @discounts = discounts
         @expand = expand
         @metadata = metadata
@@ -172,6 +185,15 @@ module Stripe
     end
 
     class CreateParams < 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))
+        attr_accessor :usage_gte
+
+        def initialize(usage_gte: nil)
+          @usage_gte = usage_gte
+        end
+      end
+
       class Discount < Stripe::RequestParams
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
@@ -228,6 +250,8 @@ module Stripe
           @unit_amount_decimal = unit_amount_decimal
         end
       end
+      # 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
       # The coupons to redeem into discounts for the subscription item.
       attr_accessor :discounts
       # Specifies which fields in the response should be expanded.
@@ -260,6 +284,7 @@ module Stripe
       attr_accessor :tax_rates
 
       def initialize(
+        billing_thresholds: nil,
         discounts: nil,
         expand: nil,
         metadata: nil,
@@ -273,6 +298,7 @@ module Stripe
         subscription: nil,
         tax_rates: nil
       )
+        @billing_thresholds = billing_thresholds
         @discounts = discounts
         @expand = expand
         @metadata = metadata

data/lib/stripe/services/subscription_schedule_service.rb

@@ -146,6 +146,18 @@ module Stripe
           end
         end
 
+        class BillingThresholds < Stripe::RequestParams
+          # Monetary threshold that triggers the subscription to advance to a new billing period
+          attr_accessor :amount_gte
+          # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
+          attr_accessor :reset_billing_cycle_anchor
+
+          def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
+            @amount_gte = amount_gte
+            @reset_billing_cycle_anchor = reset_billing_cycle_anchor
+          end
+        end
+
         class InvoiceSettings < Stripe::RequestParams
           class Issuer < Stripe::RequestParams
             # The connected account being referenced when `type` is `account`.
@@ -189,6 +201,8 @@ module Stripe
         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).
         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
         # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
         attr_accessor :collection_method
         # 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.
@@ -206,6 +220,7 @@ module Stripe
           application_fee_percent: nil,
           automatic_tax: nil,
           billing_cycle_anchor: nil,
+          billing_thresholds: nil,
           collection_method: nil,
           default_payment_method: nil,
           description: nil,
@@ -216,6 +231,7 @@ module Stripe
           @application_fee_percent = application_fee_percent
           @automatic_tax = automatic_tax
           @billing_cycle_anchor = billing_cycle_anchor
+          @billing_thresholds = billing_thresholds
           @collection_method = collection_method
           @default_payment_method = default_payment_method
           @description = description
@@ -311,6 +327,18 @@ module Stripe
           end
         end
 
+        class BillingThresholds < Stripe::RequestParams
+          # Monetary threshold that triggers the subscription to advance to a new billing period
+          attr_accessor :amount_gte
+          # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
+          attr_accessor :reset_billing_cycle_anchor
+
+          def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
+            @amount_gte = amount_gte
+            @reset_billing_cycle_anchor = reset_billing_cycle_anchor
+          end
+        end
+
         class Discount < Stripe::RequestParams
           # ID of the coupon to create a new discount for.
           attr_accessor :coupon
@@ -353,6 +381,15 @@ module Stripe
         end
 
         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))
+            attr_accessor :usage_gte
+
+            def initialize(usage_gte: nil)
+              @usage_gte = usage_gte
+            end
+          end
+
           class Discount < Stripe::RequestParams
             # ID of the coupon to create a new discount for.
             attr_accessor :coupon
@@ -409,6 +446,8 @@ module Stripe
               @unit_amount_decimal = unit_amount_decimal
             end
           end
+          # 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
           # 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`.
@@ -425,6 +464,7 @@ module Stripe
           attr_accessor :tax_rates
 
           def initialize(
+            billing_thresholds: nil,
             discounts: nil,
             metadata: nil,
             plan: nil,
@@ -433,6 +473,7 @@ module Stripe
             quantity: nil,
             tax_rates: nil
           )
+            @billing_thresholds = billing_thresholds
             @discounts = discounts
             @metadata = metadata
             @plan = plan
@@ -462,6 +503,8 @@ module Stripe
         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).
         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
         # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
         attr_accessor :collection_method
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -486,7 +529,7 @@ module Stripe
         attr_accessor :metadata
         # The account on behalf of which to charge, for each of the associated subscription's invoices.
         attr_accessor :on_behalf_of
-        # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. 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 of the current phase.
+        # 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.
         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
@@ -500,6 +543,7 @@ module Stripe
           application_fee_percent: nil,
           automatic_tax: nil,
           billing_cycle_anchor: nil,
+          billing_thresholds: nil,
           collection_method: nil,
           currency: nil,
           default_payment_method: nil,
@@ -521,6 +565,7 @@ module Stripe
           @application_fee_percent = application_fee_percent
           @automatic_tax = automatic_tax
           @billing_cycle_anchor = billing_cycle_anchor
+          @billing_thresholds = billing_thresholds
           @collection_method = collection_method
           @currency = currency
           @default_payment_method = default_payment_method
@@ -611,6 +656,18 @@ module Stripe
           end
         end
 
+        class BillingThresholds < Stripe::RequestParams
+          # Monetary threshold that triggers the subscription to advance to a new billing period
+          attr_accessor :amount_gte
+          # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
+          attr_accessor :reset_billing_cycle_anchor
+
+          def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
+            @amount_gte = amount_gte
+            @reset_billing_cycle_anchor = reset_billing_cycle_anchor
+          end
+        end
+
         class InvoiceSettings < Stripe::RequestParams
           class Issuer < Stripe::RequestParams
             # The connected account being referenced when `type` is `account`.
@@ -654,6 +711,8 @@ module Stripe
         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).
         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
         # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
         attr_accessor :collection_method
         # 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.
@@ -671,6 +730,7 @@ module Stripe
           application_fee_percent: nil,
           automatic_tax: nil,
           billing_cycle_anchor: nil,
+          billing_thresholds: nil,
           collection_method: nil,
           default_payment_method: nil,
           description: nil,
@@ -681,6 +741,7 @@ module Stripe
           @application_fee_percent = application_fee_percent
           @automatic_tax = automatic_tax
           @billing_cycle_anchor = billing_cycle_anchor
+          @billing_thresholds = billing_thresholds
           @collection_method = collection_method
           @default_payment_method = default_payment_method
           @description = description
@@ -776,6 +837,18 @@ module Stripe
           end
         end
 
+        class BillingThresholds < Stripe::RequestParams
+          # Monetary threshold that triggers the subscription to advance to a new billing period
+          attr_accessor :amount_gte
+          # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
+          attr_accessor :reset_billing_cycle_anchor
+
+          def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
+            @amount_gte = amount_gte
+            @reset_billing_cycle_anchor = reset_billing_cycle_anchor
+          end
+        end
+
         class Discount < Stripe::RequestParams
           # ID of the coupon to create a new discount for.
           attr_accessor :coupon
@@ -818,6 +891,15 @@ module Stripe
         end
 
         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))
+            attr_accessor :usage_gte
+
+            def initialize(usage_gte: nil)
+              @usage_gte = usage_gte
+            end
+          end
+
           class Discount < Stripe::RequestParams
             # ID of the coupon to create a new discount for.
             attr_accessor :coupon
@@ -874,6 +956,8 @@ module Stripe
               @unit_amount_decimal = unit_amount_decimal
             end
           end
+          # 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
           # 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`.
@@ -890,6 +974,7 @@ module Stripe
           attr_accessor :tax_rates
 
           def initialize(
+            billing_thresholds: nil,
             discounts: nil,
             metadata: nil,
             plan: nil,
@@ -898,6 +983,7 @@ module Stripe
             quantity: nil,
             tax_rates: nil
           )
+            @billing_thresholds = billing_thresholds
             @discounts = discounts
             @metadata = metadata
             @plan = plan
@@ -927,6 +1013,8 @@ module Stripe
         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).
         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
         # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
         attr_accessor :collection_method
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -951,7 +1039,7 @@ module Stripe
         attr_accessor :metadata
         # The account on behalf of which to charge, for each of the associated subscription's invoices.
         attr_accessor :on_behalf_of
-        # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. 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 of the current phase.
+        # 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.
         attr_accessor :proration_behavior
         # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
         attr_accessor :start_date
@@ -967,6 +1055,7 @@ module Stripe
           application_fee_percent: nil,
           automatic_tax: nil,
           billing_cycle_anchor: nil,
+          billing_thresholds: nil,
           collection_method: nil,
           currency: nil,
           default_payment_method: nil,
@@ -989,6 +1078,7 @@ module Stripe
           @application_fee_percent = application_fee_percent
           @automatic_tax = automatic_tax
           @billing_cycle_anchor = billing_cycle_anchor
+          @billing_thresholds = billing_thresholds
           @collection_method = collection_method
           @currency = currency
           @default_payment_method = default_payment_method
@@ -1018,7 +1108,7 @@ module Stripe
       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. Note that past phases can be omitted.
       attr_accessor :phases
-      # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
+      # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
       attr_accessor :proration_behavior
 
       def initialize(