stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.3

data/lib/stripe/resources/billing/meter_event_summary.rb

@@ -13,22 +13,16 @@ module Stripe
 
       # Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
       attr_reader :aggregated_value
-
       # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
       attr_reader :end_time
-
       # 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
-
       # The meter associated with this event summary.
       attr_reader :meter
-
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-
       # Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
       attr_reader :start_time
     end

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -17,10 +17,8 @@ module Stripe
       class BusinessProfile < Stripe::StripeObject
         # The messaging shown to customers in the portal.
         attr_reader :headline
-
         # A link to the business’s publicly available privacy policy.
         attr_reader :privacy_policy_url
-
         # A link to the business’s publicly available terms of service.
         attr_reader :terms_of_service_url
       end
@@ -29,7 +27,6 @@ module Stripe
         class CustomerUpdate < Stripe::StripeObject
           # The types of customer updates that are supported. When empty, customers are not updateable.
           attr_reader :allowed_updates
-
           # Whether the feature is enabled.
           attr_reader :enabled
         end
@@ -48,19 +45,15 @@ module Stripe
           class CancellationReason < Stripe::StripeObject
             # Whether the feature is enabled.
             attr_reader :enabled
-
             # Which cancellation reasons will be given as options to the customer.
             attr_reader :options
           end
           # Attribute for field cancellation_reason
           attr_reader :cancellation_reason
-
           # Whether the feature is enabled.
           attr_reader :enabled
-
           # Whether to cancel subscriptions immediately or at the end of the billing period.
           attr_reader :mode
-
           # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
           attr_reader :proration_behavior
         end
@@ -69,7 +62,6 @@ module Stripe
           class Product < Stripe::StripeObject
             # The list of price IDs which, when subscribed to, a subscription can be updated.
             attr_reader :prices
-
             # The product ID.
             attr_reader :product
           end
@@ -84,31 +76,23 @@ module Stripe
           end
           # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
           attr_reader :default_allowed_updates
-
           # Whether the feature is enabled.
           attr_reader :enabled
-
           # The list of up to 10 products that support subscription updates.
           attr_reader :products
-
           # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
           attr_reader :proration_behavior
-
           # Attribute for field schedule_at_period_end
           attr_reader :schedule_at_period_end
         end
         # Attribute for field customer_update
         attr_reader :customer_update
-
         # Attribute for field invoice_history
         attr_reader :invoice_history
-
         # Attribute for field payment_method_update
         attr_reader :payment_method_update
-
         # Attribute for field subscription_cancel
         attr_reader :subscription_cancel
-
         # Attribute for field subscription_update
         attr_reader :subscription_update
       end
@@ -118,7 +102,6 @@ module Stripe
         #
         # If `false`, the previously generated `url`, if any, will be deactivated.
         attr_reader :enabled
-
         # A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
         attr_reader :url
       end
@@ -126,19 +109,14 @@ module Stripe
       class ListParams < Stripe::RequestParams
         # Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
         attr_accessor :active
-
         # 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.
         attr_accessor :expand
-
         # Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
         attr_accessor :is_default
-
         # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
         attr_accessor :limit
-
         # 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
 
@@ -163,10 +141,8 @@ module Stripe
         class BusinessProfile < Stripe::RequestParams
           # The messaging shown to customers in the portal.
           attr_accessor :headline
-
           # A link to the business’s publicly available privacy policy.
           attr_accessor :privacy_policy_url
-
           # A link to the business’s publicly available terms of service.
           attr_accessor :terms_of_service_url
 
@@ -181,7 +157,6 @@ module Stripe
           class CustomerUpdate < Stripe::RequestParams
             # The types of customer updates that are supported. When empty, customers are not updateable.
             attr_accessor :allowed_updates
-
             # Whether the feature is enabled.
             attr_accessor :enabled
 
@@ -213,7 +188,6 @@ module Stripe
             class CancellationReason < Stripe::RequestParams
               # Whether the feature is enabled.
               attr_accessor :enabled
-
               # Which cancellation reasons will be given as options to the customer.
               attr_accessor :options
 
@@ -224,14 +198,11 @@ module Stripe
             end
             # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
             attr_accessor :cancellation_reason
-
             # Whether the feature is enabled.
             attr_accessor :enabled
-
             # Whether to cancel subscriptions immediately or at the end of the billing period.
             attr_accessor :mode
-
-            # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
+            # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
             attr_accessor :proration_behavior
 
             def initialize(
@@ -251,7 +222,6 @@ module Stripe
             class Product < Stripe::RequestParams
               # The list of price IDs for the product that a subscription can be updated to.
               attr_accessor :prices
-
               # The product id.
               attr_accessor :product
 
@@ -279,16 +249,12 @@ module Stripe
             end
             # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
             attr_accessor :default_allowed_updates
-
             # Whether the feature is enabled.
             attr_accessor :enabled
-
             # The list of up to 10 products that support subscription updates.
             attr_accessor :products
-
             # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
             attr_accessor :proration_behavior
-
             # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
             attr_accessor :schedule_at_period_end
 
@@ -308,16 +274,12 @@ module Stripe
           end
           # Information about updating the customer details in the portal.
           attr_accessor :customer_update
-
           # Information about showing the billing history in the portal.
           attr_accessor :invoice_history
-
           # Information about updating payment methods in the portal.
           attr_accessor :payment_method_update
-
           # Information about canceling subscriptions in the portal.
           attr_accessor :subscription_cancel
-
           # Information about updating subscriptions in the portal.
           attr_accessor :subscription_update
 
@@ -346,19 +308,14 @@ module Stripe
         end
         # The business information shown to customers in the portal.
         attr_accessor :business_profile
-
         # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
         attr_accessor :default_return_url
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Information about the features available in the portal.
         attr_accessor :features
-
         # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
         attr_accessor :login_page
-
         # 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`.
         attr_accessor :metadata
 
@@ -392,10 +349,8 @@ module Stripe
         class BusinessProfile < Stripe::RequestParams
           # The messaging shown to customers in the portal.
           attr_accessor :headline
-
           # A link to the business’s publicly available privacy policy.
           attr_accessor :privacy_policy_url
-
           # A link to the business’s publicly available terms of service.
           attr_accessor :terms_of_service_url
 
@@ -410,7 +365,6 @@ module Stripe
           class CustomerUpdate < Stripe::RequestParams
             # The types of customer updates that are supported. When empty, customers are not updateable.
             attr_accessor :allowed_updates
-
             # Whether the feature is enabled.
             attr_accessor :enabled
 
@@ -442,7 +396,6 @@ module Stripe
             class CancellationReason < Stripe::RequestParams
               # Whether the feature is enabled.
               attr_accessor :enabled
-
               # Which cancellation reasons will be given as options to the customer.
               attr_accessor :options
 
@@ -453,14 +406,11 @@ module Stripe
             end
             # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
             attr_accessor :cancellation_reason
-
             # Whether the feature is enabled.
             attr_accessor :enabled
-
             # Whether to cancel subscriptions immediately or at the end of the billing period.
             attr_accessor :mode
-
-            # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
+            # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
             attr_accessor :proration_behavior
 
             def initialize(
@@ -480,7 +430,6 @@ module Stripe
             class Product < Stripe::RequestParams
               # The list of price IDs for the product that a subscription can be updated to.
               attr_accessor :prices
-
               # The product id.
               attr_accessor :product
 
@@ -508,16 +457,12 @@ module Stripe
             end
             # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
             attr_accessor :default_allowed_updates
-
             # Whether the feature is enabled.
             attr_accessor :enabled
-
             # The list of up to 10 products that support subscription updates.
             attr_accessor :products
-
             # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
             attr_accessor :proration_behavior
-
             # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
             attr_accessor :schedule_at_period_end
 
@@ -537,16 +482,12 @@ module Stripe
           end
           # Information about updating the customer details in the portal.
           attr_accessor :customer_update
-
           # Information about showing the billing history in the portal.
           attr_accessor :invoice_history
-
           # Information about updating payment methods in the portal.
           attr_accessor :payment_method_update
-
           # Information about canceling subscriptions in the portal.
           attr_accessor :subscription_cancel
-
           # Information about updating subscriptions in the portal.
           attr_accessor :subscription_update
 
@@ -577,22 +518,16 @@ module Stripe
         end
         # Whether the configuration is active and can be used to create portal sessions.
         attr_accessor :active
-
         # The business information shown to customers in the portal.
         attr_accessor :business_profile
-
         # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
         attr_accessor :default_return_url
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Information about the features available in the portal.
         attr_accessor :features
-
         # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
         attr_accessor :login_page
-
         # 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`.
         attr_accessor :metadata
 
@@ -616,40 +551,28 @@ module Stripe
       end
       # Whether the configuration is active and can be used to create portal sessions.
       attr_reader :active
-
       # ID of the Connect Application that created the configuration.
       attr_reader :application
-
       # Attribute for field business_profile
       attr_reader :business_profile
-
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
-
       # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
       attr_reader :default_return_url
-
       # Attribute for field features
       attr_reader :features
-
       # Unique identifier for the object.
       attr_reader :id
-
       # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
       attr_reader :is_default
-
       # 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 login_page
       attr_reader :login_page
-
       # 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.
       attr_reader :metadata
-
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-
       # Time at which the object was last updated. Measured in seconds since the Unix epoch.
       attr_reader :updated
 

data/lib/stripe/resources/billing_portal/session.rb

@@ -38,10 +38,8 @@ module Stripe
           end
           # Configuration when `after_completion.type=hosted_confirmation`.
           attr_reader :hosted_confirmation
-
           # Configuration when `after_completion.type=redirect`.
           attr_reader :redirect
-
           # The specified type of behavior after the flow is completed.
           attr_reader :type
         end
@@ -54,13 +52,11 @@ module Stripe
             end
             # Configuration when `retention.type=coupon_offer`.
             attr_reader :coupon_offer
-
             # Type of retention strategy that will be used.
             attr_reader :type
           end
           # Specify a retention strategy to be used in the cancellation flow.
           attr_reader :retention
-
           # The ID of the subscription to be canceled.
           attr_reader :subscription
         end
@@ -74,7 +70,6 @@ module Stripe
           class Discount < Stripe::StripeObject
             # The ID of the coupon to apply to this subscription update.
             attr_reader :coupon
-
             # The ID of a promotion code to apply to this subscription update.
             attr_reader :promotion_code
           end
@@ -82,34 +77,26 @@ module Stripe
           class Item < Stripe::StripeObject
             # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
             attr_reader :id
-
             # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
             attr_reader :price
-
             # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
             attr_reader :quantity
           end
           # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
           attr_reader :discounts
-
           # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
           attr_reader :items
-
           # The ID of the subscription to be updated.
           attr_reader :subscription
         end
         # Attribute for field after_completion
         attr_reader :after_completion
-
         # Configuration when `flow.type=subscription_cancel`.
         attr_reader :subscription_cancel
-
         # Configuration when `flow.type=subscription_update`.
         attr_reader :subscription_update
-
         # Configuration when `flow.type=subscription_update_confirm`.
         attr_reader :subscription_update_confirm
-
         # Type of flow that the customer will go through.
         attr_reader :type
       end
@@ -136,10 +123,8 @@ module Stripe
             end
             # Configuration when `after_completion.type=hosted_confirmation`.
             attr_accessor :hosted_confirmation
-
             # Configuration when `after_completion.type=redirect`.
             attr_accessor :redirect
-
             # The specified behavior after the flow is completed.
             attr_accessor :type
 
@@ -162,7 +147,6 @@ module Stripe
               end
               # Configuration when `retention.type=coupon_offer`.
               attr_accessor :coupon_offer
-
               # Type of retention strategy to use with the customer.
               attr_accessor :type
 
@@ -173,7 +157,6 @@ module Stripe
             end
             # Specify a retention strategy to be used in the cancellation flow.
             attr_accessor :retention
-
             # The ID of the subscription to be canceled.
             attr_accessor :subscription
 
@@ -196,7 +179,6 @@ module Stripe
             class Discount < Stripe::RequestParams
               # The ID of the coupon to apply to this subscription update.
               attr_accessor :coupon
-
               # The ID of a promotion code to apply to this subscription update.
               attr_accessor :promotion_code
 
@@ -209,10 +191,8 @@ module Stripe
             class Item < Stripe::RequestParams
               # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
               attr_accessor :id
-
               # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
               attr_accessor :price
-
               # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
               attr_accessor :quantity
 
@@ -224,10 +204,8 @@ module Stripe
             end
             # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
             attr_accessor :discounts
-
             # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
             attr_accessor :items
-
             # The ID of the subscription to be updated.
             attr_accessor :subscription
 
@@ -239,16 +217,12 @@ module Stripe
           end
           # Behavior after the flow is completed.
           attr_accessor :after_completion
-
           # Configuration when `flow_data.type=subscription_cancel`.
           attr_accessor :subscription_cancel
-
           # Configuration when `flow_data.type=subscription_update`.
           attr_accessor :subscription_update
-
           # Configuration when `flow_data.type=subscription_update_confirm`.
           attr_accessor :subscription_update_confirm
-
           # Type of flow that the customer will go through.
           attr_accessor :type
 
@@ -268,22 +242,16 @@ module Stripe
         end
         # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
         attr_accessor :configuration
-
         # The ID of an existing customer.
         attr_accessor :customer
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
         attr_accessor :flow_data
-
         # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
         attr_accessor :locale
-
         # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
         attr_accessor :on_behalf_of
-
         # The default URL to redirect customers to when they click on the portal's link to return to your website.
         attr_accessor :return_url
 
@@ -307,34 +275,24 @@ module Stripe
       end
       # The configuration used by this session, describing the features available.
       attr_reader :configuration
-
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
-
       # The ID of the customer for this session.
       attr_reader :customer
-
       # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_reader :flow
-
       # 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
-
       # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
       attr_reader :locale
-
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-
       # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
       attr_reader :on_behalf_of
-
       # The URL to redirect customers to when they click on the portal's link to return to your website.
       attr_reader :return_url
-
       # The short-lived URL of the session that gives customers access to the customer portal.
       attr_reader :url