stripe 18.1.0 → 18.2.0.pre.alpha.1

data/lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionListParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Customer object. If provided, only Pricing Plan Subscriptions that are subscribed on the cadences with the specified payer will be returned.
+          attr_accessor :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_accessor :type
+
+          def initialize(customer: nil, type: nil)
+            @customer = customer
+            @type = type
+          end
+        end
+        # Filter by Billing Cadence ID. Mutually exclusive with `payer`, `pricing_plan`, and `pricing_plan_version`.
+        attr_accessor :billing_cadence
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Filter by payer. Mutually exclusive with `billing_cadence`, `pricing_plan`, and `pricing_plan_version`.
+        attr_accessor :payer
+        # Filter by PricingPlan ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan_version`.
+        attr_accessor :pricing_plan
+        # Filter by Pricing Plan Version ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan`.
+        attr_accessor :pricing_plan_version
+        # Filter by servicing status.
+        attr_accessor :servicing_status
+
+        def initialize(
+          billing_cadence: nil,
+          limit: nil,
+          payer: nil,
+          pricing_plan: nil,
+          pricing_plan_version: nil,
+          servicing_status: nil
+        )
+          @billing_cadence = billing_cadence
+          @limit = limit
+          @payer = payer
+          @pricing_plan = pricing_plan
+          @pricing_plan_version = pricing_plan_version
+          @servicing_status = servicing_status
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plan_subscription_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plan_subscription_update_params.rb

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionUpdateParams < ::Stripe::RequestParams
+        # When set to true, the `servicing_status_transition.will_cancel_at` field will be cleared.
+        attr_accessor :clear_cancel_at
+        # Set of [key-value pairs](/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_accessor :metadata
+
+        def initialize(clear_cancel_at: nil, metadata: nil)
+          @clear_cancel_at = clear_cancel_at
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plan_subscriptions/component_retrieve_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlanSubscriptions
+        class ComponentRetrieveParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plan_update_params.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanUpdateParams < ::Stripe::RequestParams
+        # Whether the PricingPlan is active.
+        attr_accessor :active
+        # Description of pricing plan subscription.
+        attr_accessor :description
+        # Display name of the PricingPlan. Maximum 250 characters.
+        attr_accessor :display_name
+        # The ID of the live version of the PricingPlan.
+        attr_accessor :live_version
+        # An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of key-value pairs that you can attach to an object.
+        attr_accessor :metadata
+
+        def initialize(
+          active: nil,
+          description: nil,
+          display_name: nil,
+          live_version: nil,
+          lookup_key: nil,
+          metadata: nil
+        )
+          @active = active
+          @description = description
+          @display_name = display_name
+          @live_version = live_version
+          @lookup_key = lookup_key
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/component_create_params.rb

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentCreateParams < ::Stripe::RequestParams
+          class LicenseFee < ::Stripe::RequestParams
+            # The ID of the License Fee.
+            attr_accessor :id
+            # The version of the LicenseFee. Defaults to 'latest', if not specified.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+
+          class RateCard < ::Stripe::RequestParams
+            # The ID of the Rate Card.
+            attr_accessor :id
+            # The version of the RateCard. Defaults to 'latest', if not specified.
+            attr_accessor :version
+
+            def initialize(id: nil, version: nil)
+              @id = id
+              @version = version
+            end
+          end
+
+          class ServiceAction < ::Stripe::RequestParams
+            # The ID of the service action.
+            attr_accessor :id
+
+            def initialize(id: nil)
+              @id = id
+            end
+          end
+          # An identifier that can be used to find this component.
+          attr_accessor :lookup_key
+          # Set of [key-value pairs](/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_accessor :metadata
+          # The type of the PricingPlanComponent.
+          attr_accessor :type
+          # Details if this component is a License Fee.
+          attr_accessor :license_fee
+          # Details if this component is a Rate Card.
+          attr_accessor :rate_card
+          # Details if this component is a Service Action.
+          attr_accessor :service_action
+
+          def initialize(
+            lookup_key: nil,
+            metadata: nil,
+            type: nil,
+            license_fee: nil,
+            rate_card: nil,
+            service_action: nil
+          )
+            @lookup_key = lookup_key
+            @metadata = metadata
+            @type = type
+            @license_fee = license_fee
+            @rate_card = rate_card
+            @service_action = service_action
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/component_delete_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentDeleteParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/component_list_params.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+          # Filter by lookup keys. Mutually exclusive with `pricing_plan_version`.
+          # You can specify up to 10 lookup keys.
+          attr_accessor :lookup_keys
+          # The ID of the Pricing Plan Version to list components for. Will use the latest version if not provided.
+          # Mutually exclusive with `lookup_keys`.
+          attr_accessor :pricing_plan_version
+
+          def initialize(limit: nil, lookup_keys: nil, pricing_plan_version: nil)
+            @limit = limit
+            @lookup_keys = lookup_keys
+            @pricing_plan_version = pricing_plan_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/component_retrieve_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentRetrieveParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/component_update_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentUpdateParams < ::Stripe::RequestParams
+          # An identifier that can be used to find this component. Maximum length of 200 characters.
+          attr_accessor :lookup_key
+          # Set of key-value pairs that you can attach to an object.
+          attr_accessor :metadata
+
+          def initialize(lookup_key: nil, metadata: nil)
+            @lookup_key = lookup_key
+            @metadata = metadata
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/version_list_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class VersionListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+
+          def initialize(limit: nil)
+            @limit = limit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plans/version_retrieve_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class VersionRetrieveParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/profile_create_params.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ProfileCreateParams < ::Stripe::RequestParams
+        # The ID of the customer object.
+        attr_accessor :customer
+        # The ID of the payment method object.
+        attr_accessor :default_payment_method
+        # A customer-facing name for the billing profile.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+        # Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+
+        def initialize(
+          customer: nil,
+          default_payment_method: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil
+        )
+          @customer = customer
+          @default_payment_method = default_payment_method
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/profile_list_params.rb

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ProfileListParams < ::Stripe::RequestParams
+        # Filter billing profiles by a customer. Mutually exclusive
+        # with `lookup_keys` and `default_payment_method`.
+        attr_accessor :customer
+        # Filter billing profiles by a default payment method. Mutually exclusive
+        # with `customer` and `lookup_keys`.
+        attr_accessor :default_payment_method
+        # Optionally set the maximum number of results per page. Defaults to 10.
+        attr_accessor :limit
+        # Filter billing profiles by lookup keys. Mutually exclusive
+        # with `customer` and `default_payment_method`.
+        # You can specify up to 10 lookup_keys.
+        attr_accessor :lookup_keys
+        # Filter billing profiles by status. Can be combined
+        # with all other filters. If not provided, all billing profiles will be returned.
+        attr_accessor :status
+
+        def initialize(
+          customer: nil,
+          default_payment_method: nil,
+          limit: nil,
+          lookup_keys: nil,
+          status: nil
+        )
+          @customer = customer
+          @default_payment_method = default_payment_method
+          @limit = limit
+          @lookup_keys = lookup_keys
+          @status = status
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/profile_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ProfileRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/profile_update_params.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ProfileUpdateParams < ::Stripe::RequestParams
+        # The ID of the payment method object.
+        attr_accessor :default_payment_method
+        # A customer-facing name for the billing profile.
+        # Maximum length of 250 characters.
+        # To remove the display_name from the object, set it to null in the request.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+        # Maximum length of 200 characters.
+        # To remove the lookup_key from the object, set it to null in the request.
+        attr_accessor :lookup_key
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+
+        def initialize(
+          default_payment_method: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil
+        )
+          @default_payment_method = default_payment_method
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_create_params.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardCreateParams < ::Stripe::RequestParams
+        # The currency of this RateCard.
+        attr_accessor :currency
+        # A customer-facing name for the RateCard.
+        # This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular RateCard. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of [key-value pairs](/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_accessor :metadata
+        # The interval for assessing service. For example, a monthly RateCard with a rate of $1 for the first 10 "workloads"
+        # and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but
+        # distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees,
+        # while the billing interval in Cadence deals with the rate the customer is billed.
+        attr_accessor :service_interval
+        # The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
+        # order to specify quarterly service.
+        attr_accessor :service_interval_count
+        # The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.
+        attr_accessor :tax_behavior
+
+        def initialize(
+          currency: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          service_interval: nil,
+          service_interval_count: nil,
+          tax_behavior: nil
+        )
+          @currency = currency
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @service_interval = service_interval
+          @service_interval_count = service_interval_count
+          @tax_behavior = tax_behavior
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardListParams < ::Stripe::RequestParams
+        # Optionally filter to active/inactive RateCards.
+        attr_accessor :active
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Filter by lookup keys.
+        # You can specify up to 10 lookup keys.
+        attr_accessor :lookup_keys
+
+        def initialize(active: nil, limit: nil, lookup_keys: nil)
+          @active = active
+          @limit = limit
+          @lookup_keys = lookup_keys
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_subscription_cancel_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionCancelParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_subscription_create_params.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionCreateParams < ::Stripe::RequestParams
+        # The ID of the Billing Cadence.
+        attr_accessor :billing_cadence
+        # Set of [key-value pairs](/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_accessor :metadata
+        # The ID of the Rate Card.
+        attr_accessor :rate_card
+        # The ID of the Rate Card Version. If not specified, defaults to the "live_version" of the Rate Card at the time of creation.
+        attr_accessor :rate_card_version
+
+        def initialize(billing_cadence: nil, metadata: nil, rate_card: nil, rate_card_version: nil)
+          @billing_cadence = billing_cadence
+          @metadata = metadata
+          @rate_card = rate_card
+          @rate_card_version = rate_card_version
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_subscription_list_params.rb

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionListParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Customer object. If provided, only the Rate Card Subscriptions that are subscribed on the Billing Cadences with the specified payer will be returned.
+          attr_accessor :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_accessor :type
+
+          def initialize(customer: nil, type: nil)
+            @customer = customer
+            @type = type
+          end
+        end
+        # Optionally filter by a BillingCadence. Mutually exclusive with `payers`, `rate_card`, and `rate_card_version`.
+        attr_accessor :billing_cadence
+        # The page size limit, if not provided the default is 20.
+        attr_accessor :limit
+        # Optionally filter by the payer associated with Billing Cadences which the Rate Card Subscriptions are subscribed to.
+        # Mutually exclusive with `billing_cadence`, `rate_card`, and `rate_card_version`.
+        attr_accessor :payer
+        # Optionally filter by a RateCard. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card_version`.
+        attr_accessor :rate_card
+        # Optionally filter by a RateCard version. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card`.
+        attr_accessor :rate_card_version
+        # Optionally filter by servicing status.
+        attr_accessor :servicing_status
+
+        def initialize(
+          billing_cadence: nil,
+          limit: nil,
+          payer: nil,
+          rate_card: nil,
+          rate_card_version: nil,
+          servicing_status: nil
+        )
+          @billing_cadence = billing_cadence
+          @limit = limit
+          @payer = payer
+          @rate_card = rate_card
+          @rate_card_version = rate_card_version
+          @servicing_status = servicing_status
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_subscription_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_card_subscription_update_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionUpdateParams < ::Stripe::RequestParams
+        # Set of [key-value pairs](/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_accessor :metadata
+
+        def initialize(metadata: nil)
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end