stripe 17.0.1 → 19.0.0

data/lib/stripe/params/subscription_item_delete_params.rb

@@ -2,16 +2,30 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionItemDeleteParams < Stripe::RequestParams
+  class SubscriptionItemDeleteParams < ::Stripe::RequestParams
     # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
     attr_accessor :clear_usage
-    # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
+    # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
+    #
+    # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
+    #
+    # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
+    #
+    # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
+    attr_accessor :payment_behavior
+    # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
     attr_accessor :proration_behavior
-    # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
+    # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](/api/invoices/create_preview) endpoint.
     attr_accessor :proration_date
 
-    def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil)
+    def initialize(
+      clear_usage: nil,
+      payment_behavior: nil,
+      proration_behavior: nil,
+      proration_date: nil
+    )
       @clear_usage = clear_usage
+      @payment_behavior = payment_behavior
       @proration_behavior = proration_behavior
       @proration_date = proration_date
     end

data/lib/stripe/params/subscription_item_list_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionItemListParams < Stripe::RequestParams
+  class SubscriptionItemListParams < ::Stripe::RequestParams
     # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
     attr_accessor :ending_before
     # Specifies which fields in the response should be expanded.

data/lib/stripe/params/subscription_item_retrieve_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionItemRetrieveParams < Stripe::RequestParams
+  class SubscriptionItemRetrieveParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 

data/lib/stripe/params/subscription_item_update_params.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionItemUpdateParams < 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))
+  class SubscriptionItemUpdateParams < ::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://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
       attr_accessor :usage_gte
 
       def initialize(usage_gte: nil)
@@ -12,7 +12,7 @@ module Stripe
       end
     end
 
-    class Discount < Stripe::RequestParams
+    class Discount < ::Stripe::RequestParams
       # ID of the coupon to create a new discount for.
       attr_accessor :coupon
       # ID of an existing discount on the object (or one of its ancestors) to reuse.
@@ -27,8 +27,8 @@ module Stripe
       end
     end
 
-    class PriceData < Stripe::RequestParams
-      class Recurring < Stripe::RequestParams
+    class PriceData < ::Stripe::RequestParams
+      class Recurring < ::Stripe::RequestParams
         # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
         attr_accessor :interval
         # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
@@ -45,7 +45,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
@@ -67,6 +67,10 @@ module Stripe
         @unit_amount = unit_amount
         @unit_amount_decimal = unit_amount_decimal
       end
+
+      def self.field_encodings
+        @field_encodings = { unit_amount_decimal: :decimal_string }
+      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
@@ -74,15 +78,15 @@ module Stripe
     attr_accessor :discounts
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
-    # 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
     # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
     attr_accessor :off_session
-    # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
+    # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
     #
-    # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
+    # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
     #
-    # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
+    # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
     #
     # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
     attr_accessor :payment_behavior
@@ -90,15 +94,15 @@ module Stripe
     attr_accessor :plan
     # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
     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
-    # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
+    # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
     attr_accessor :proration_behavior
-    # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
+    # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](/api/invoices/create_preview) endpoint.
     attr_accessor :proration_date
     # The quantity you'd like to apply to the subscription item you're creating.
     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
 
     def initialize(
@@ -130,5 +134,11 @@ module Stripe
       @quantity = quantity
       @tax_rates = tax_rates
     end
+
+    def self.field_encodings
+      @field_encodings = {
+        price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
+      }
+    end
   end
 end

data/lib/stripe/params/subscription_list_params.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionListParams < Stripe::RequestParams
-    class AutomaticTax < Stripe::RequestParams
+  class SubscriptionListParams < ::Stripe::RequestParams
+    class AutomaticTax < ::Stripe::RequestParams
       # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
       attr_accessor :enabled
 
@@ -12,7 +12,7 @@ module Stripe
       end
     end
 
-    class Created < Stripe::RequestParams
+    class Created < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)
@@ -30,7 +30,7 @@ module Stripe
       end
     end
 
-    class CurrentPeriodEnd < Stripe::RequestParams
+    class CurrentPeriodEnd < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)
@@ -48,7 +48,7 @@ module Stripe
       end
     end
 
-    class CurrentPeriodStart < Stripe::RequestParams
+    class CurrentPeriodStart < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)
@@ -75,8 +75,10 @@ module Stripe
     attr_accessor :current_period_end
     # Only return subscriptions whose maximum item current_period_start falls within the given date interval.
     attr_accessor :current_period_start
-    # The ID of the customer whose subscriptions will be retrieved.
+    # The ID of the customer whose subscriptions you're retrieving.
     attr_accessor :customer
+    # The ID of the account representing the customer whose subscriptions you're retrieving.
+    attr_accessor :customer_account
     # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
     attr_accessor :ending_before
     # Specifies which fields in the response should be expanded.
@@ -89,7 +91,7 @@ module Stripe
     attr_accessor :price
     # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
     attr_accessor :starting_after
-    # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
+    # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
     attr_accessor :status
     # Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
     attr_accessor :test_clock
@@ -101,6 +103,7 @@ module Stripe
       current_period_end: nil,
       current_period_start: nil,
       customer: nil,
+      customer_account: nil,
       ending_before: nil,
       expand: nil,
       limit: nil,
@@ -116,6 +119,7 @@ module Stripe
       @current_period_end = current_period_end
       @current_period_start = current_period_start
       @customer = customer
+      @customer_account = customer_account
       @ending_before = ending_before
       @expand = expand
       @limit = limit

data/lib/stripe/params/subscription_migrate_params.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionMigrateParams < Stripe::RequestParams
-    class BillingMode < Stripe::RequestParams
-      class Flexible < Stripe::RequestParams
+  class SubscriptionMigrateParams < ::Stripe::RequestParams
+    class BillingMode < ::Stripe::RequestParams
+      class Flexible < ::Stripe::RequestParams
         # Controls how invoices and invoice items display proration amounts and discount amounts.
         attr_accessor :proration_discounts
 

data/lib/stripe/params/subscription_resume_params.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionResumeParams < Stripe::RequestParams
-    # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+  class SubscriptionResumeParams < ::Stripe::RequestParams
+    # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
     attr_accessor :billing_cycle_anchor
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
-    # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
+    # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
     attr_accessor :proration_behavior
     # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
     attr_accessor :proration_date

data/lib/stripe/params/subscription_retrieve_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionRetrieveParams < Stripe::RequestParams
+  class SubscriptionRetrieveParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 

data/lib/stripe/params/subscription_schedule_cancel_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionScheduleCancelParams < Stripe::RequestParams
+  class SubscriptionScheduleCancelParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
     # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.