stripe 19.2.0 → 19.3.0.pre.alpha.1

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

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class OneTimeItemCreateParams < ::Stripe::RequestParams
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular one-time item.
+        # Must be unique among one-time items.
+        # 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
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this one-time item. For example, set this field
+        # to "credit" for the display to show "(price) per credit".
+        # Maximum length of 100 characters.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class OneTimeItemListParams < ::Stripe::RequestParams
+        # 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(limit: nil, lookup_keys: nil)
+          @limit = limit
+          @lookup_keys = lookup_keys
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class OneTimeItemUpdateParams < ::Stripe::RequestParams
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular one-time item.
+        # 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](/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
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this one-time item. For example, set this field
+        # to "credit" for the display to show "(price) per credit".
+        # Maximum length of 100 characters.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanCreateParams < ::Stripe::RequestParams
+        # The currency of the PricingPlan.
+        attr_accessor :currency
+        # Description of the pricing plan. Maximum length of 500 characters.
+        attr_accessor :description
+        # Display name of the PricingPlan. Maximum 250 characters.
+        attr_accessor :display_name
+        # 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](/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 tax behavior for Stripe Tax — whether the pricing plan price includes or excludes tax.
+        attr_accessor :tax_behavior
+
+        def initialize(
+          currency: nil,
+          description: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_behavior: nil
+        )
+          @currency = currency
+          @description = description
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_behavior = tax_behavior
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanListParams < ::Stripe::RequestParams
+        # Filter for active/inactive PricingPlans. Mutually exclusive with `lookup_keys`.
+        attr_accessor :active
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Filter by lookup keys. Mutually exclusive with `active`.
+        # 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/pricing_plan_retrieve_params.rb

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

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

@@ -0,0 +1,54 @@
+# 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
+        # Expand to include additional data such as discount_details, billing_cadence_details, or pricing_plan_component_details.
+        attr_accessor :include
+        # 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 exclusive with `billing_cadence`, `payer`, and `pricing_plan_version`.
+        attr_accessor :pricing_plan
+        # Filter by Pricing Plan Version ID. Mutually exclusive 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,
+          include: nil,
+          limit: nil,
+          payer: nil,
+          pricing_plan: nil,
+          pricing_plan_version: nil,
+          servicing_status: nil
+        )
+          @billing_cadence = billing_cadence
+          @include = include
+          @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_remove_discounts_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionRemoveDiscountsParams < ::Stripe::RequestParams
+        # Expand to include additional data such as discount_details.
+        attr_accessor :include
+
+        def initialize(include: nil)
+          @include = include
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionRetrieveParams < ::Stripe::RequestParams
+        # Expand to include additional data such as discount_details.
+        attr_accessor :include
+
+        def initialize(include: nil)
+          @include = include
+        end
+      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 is 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_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 the pricing plan. Maximum length of 500 characters.
+        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 ID of the License Fee Version. If not specified, defaults to 'latest'.
+            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 ID of the Rate Card Version. If not specified, defaults to 'latest'.
+            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
+          # Details if this component is a License Fee.
+          attr_accessor :license_fee
+          # 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
+          # Details if this component is a Rate Card.
+          attr_accessor :rate_card
+          # Details if this component is a Service Action.
+          attr_accessor :service_action
+          # The type of the PricingPlanComponent.
+          attr_accessor :type
+
+          def initialize(
+            license_fee: nil,
+            lookup_key: nil,
+            metadata: nil,
+            rate_card: nil,
+            service_action: nil,
+            type: nil
+          )
+            @license_fee = license_fee
+            @lookup_key = lookup_key
+            @metadata = metadata
+            @rate_card = rate_card
+            @service_action = service_action
+            @type = type
+          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 are 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