stripe 5.55.0 → 18.2.0.pre.beta.1

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

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
+    class MeterEvent < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event"
+      def self.object_name
+        "billing.meter_event"
+      end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # A unique identifier for the event.
+      attr_reader :identifier
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
+      attr_reader :payload
+      # The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
+      attr_reader :timestamp
+
+      # Creates a billing meter event.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_events",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
+    class MeterEventAdjustment < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event_adjustment"
+      def self.object_name
+        "billing.meter_event_adjustment"
+      end
+
+      class Cancel < ::Stripe::StripeObject
+        # Unique identifier for the event.
+        attr_reader :identifier
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which event to cancel.
+      attr_reader :cancel
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The meter event adjustment's status.
+      attr_reader :status
+      # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+      attr_reader :type
+
+      # Creates a billing meter event adjustment.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_event_adjustments",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { cancel: Cancel }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
+    # usage was accrued by a customer for that period.
+    #
+    # Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
+    class MeterEventSummary < APIResource
+      OBJECT_NAME = "billing.meter_event_summary"
+      def self.object_name
+        "billing.meter_event_summary"
+      end
+
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -3,12 +3,304 @@
 
 module Stripe
   module BillingPortal
+    # A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: [Configure the customer portal](https://docs.stripe.com/customer-management/configure-portal).
     class Configuration < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "billing_portal.configuration"
+      def self.object_name
+        "billing_portal.configuration"
+      end
+
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Features < ::Stripe::StripeObject
+        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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class InvoiceHistory < ::Stripe::StripeObject
+          # Whether the feature is enabled.
+          attr_reader :enabled
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PaymentMethodUpdate < ::Stripe::StripeObject
+          # Whether the feature is enabled.
+          attr_reader :enabled
+          # The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
+          attr_reader :payment_method_configuration
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionCancel < ::Stripe::StripeObject
+          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
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          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
+
+          def self.inner_class_types
+            @inner_class_types = { cancellation_reason: CancellationReason }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdate < ::Stripe::StripeObject
+          class Product < ::Stripe::StripeObject
+            class AdjustableQuantity < ::Stripe::StripeObject
+              # If true, the quantity can be adjusted to any non-negative integer.
+              attr_reader :enabled
+              # The maximum quantity that can be set for the product.
+              attr_reader :maximum
+              # The minimum quantity that can be set for the product.
+              attr_reader :minimum
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Attribute for field adjustable_quantity
+            attr_reader :adjustable_quantity
+            # The list of price IDs which, when subscribed to, a subscription can be updated.
+            attr_reader :prices
+            # The product ID.
+            attr_reader :product
+
+            def self.inner_class_types
+              @inner_class_types = { adjustable_quantity: AdjustableQuantity }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ScheduleAtPeriodEnd < ::Stripe::StripeObject
+            class Condition < ::Stripe::StripeObject
+              # The type of condition.
+              attr_reader :type
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
+            attr_reader :conditions
+
+            def self.inner_class_types
+              @inner_class_types = { conditions: Condition }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
+          attr_reader :billing_cycle_anchor
+          # 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
+          # Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
+          attr_reader :trial_update_behavior
+
+          def self.inner_class_types
+            @inner_class_types = { products: Product, schedule_at_period_end: ScheduleAtPeriodEnd }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            customer_update: CustomerUpdate,
+            invoice_history: InvoiceHistory,
+            payment_method_update: PaymentMethodUpdate,
+            subscription_cancel: SubscriptionCancel,
+            subscription_update: SubscriptionUpdate,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class LoginPage < ::Stripe::StripeObject
+        # If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
+        #
+        # 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://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
+        attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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://docs.stripe.com/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://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.
+      attr_reader :metadata
+      # The name of the configuration.
+      attr_reader :name
+      # 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
+
+      # Creates a configuration that describes the functionality and behavior of a PortalSession
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of configurations that describe the functionality of the customer portal.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a configuration that describes the functionality of the customer portal.
+      def self.update(configuration, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing_portal/configurations/%<configuration>s", { configuration: CGI.escape(configuration) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          business_profile: BusinessProfile,
+          features: Features,
+          login_page: LoginPage,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -3,10 +3,238 @@
 
 module Stripe
   module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Related guide: [Customer management](https://docs.stripe.com/customer-management)
     class Session < APIResource
       extend Stripe::APIOperations::Create
 
       OBJECT_NAME = "billing_portal.session"
+      def self.object_name
+        "billing_portal.session"
+      end
+
+      class Flow < ::Stripe::StripeObject
+        class AfterCompletion < ::Stripe::StripeObject
+          class HostedConfirmation < ::Stripe::StripeObject
+            # A custom message to display to the customer after the flow is completed.
+            attr_reader :custom_message
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Redirect < ::Stripe::StripeObject
+            # The URL the customer will be redirected to after the flow is completed.
+            attr_reader :return_url
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          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
+
+          def self.inner_class_types
+            @inner_class_types = { hosted_confirmation: HostedConfirmation, redirect: Redirect }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionCancel < ::Stripe::StripeObject
+          class Retention < ::Stripe::StripeObject
+            class CouponOffer < ::Stripe::StripeObject
+              # The ID of the coupon to be offered.
+              attr_reader :coupon
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Configuration when `retention.type=coupon_offer`.
+            attr_reader :coupon_offer
+            # Type of retention strategy that will be used.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = { coupon_offer: CouponOffer }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          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
+
+          def self.inner_class_types
+            @inner_class_types = { retention: Retention }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdate < ::Stripe::StripeObject
+          # The ID of the subscription to be updated.
+          attr_reader :subscription
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdateConfirm < ::Stripe::StripeObject
+          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
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Item < ::Stripe::StripeObject
+            # The ID of the [subscription item](https://docs.stripe.com/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://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            attr_reader :price
+            # [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            attr_reader :quantity
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The coupon or promotion code to apply to this subscription update.
+          attr_reader :discounts
+          # The [subscription item](https://docs.stripe.com/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
+
+          def self.inner_class_types
+            @inner_class_types = { discounts: Discount, items: Item }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            after_completion: AfterCompletion,
+            subscription_cancel: SubscriptionCancel,
+            subscription_update: SubscriptionUpdate,
+            subscription_update_confirm: SubscriptionUpdateConfirm,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+      # The ID of the account for this session.
+      attr_reader :customer_account
+      # Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/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://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/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
+
+      # Creates a session of the customer portal.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing_portal/sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { flow: Flow }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end