stripe 13.3.0 → 13.4.0.pre.beta.2

data/rbi/stripe/resources/plan.rbi

@@ -0,0 +1,385 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+  #
+  # Plans define the base price, currency, and billing cycle for recurring purchases of products.
+  # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
+  #
+  # For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
+  class Plan < APIResource
+    class Tier < Stripe::StripeObject
+      # Price for the entire tier.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :flat_amount
+      # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
+      sig { returns(T.nilable(String)) }
+      attr_reader :flat_amount_decimal
+      # Per unit price for units relevant to the tier.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :unit_amount
+      # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
+      sig { returns(T.nilable(String)) }
+      attr_reader :unit_amount_decimal
+      # Up to and including to this quantity will be contained in the tier.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :up_to
+    end
+    class TransformUsage < Stripe::StripeObject
+      # Divide usage by this number.
+      sig { returns(Integer) }
+      attr_reader :divide_by
+      # After division, either round the result `up` or `down`.
+      sig { returns(String) }
+      attr_reader :round
+    end
+    # Whether the plan can be used for new purchases.
+    sig { returns(T::Boolean) }
+    attr_reader :active
+    # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :aggregate_usage
+    # The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :amount
+    # The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :amount_decimal
+    # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
+    sig { returns(String) }
+    attr_reader :billing_scheme
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    sig { returns(String) }
+    attr_reader :currency
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
+    sig { returns(String) }
+    attr_reader :interval
+    # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
+    sig { returns(Integer) }
+    attr_reader :interval_count
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+    # 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.
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+    # The meter tracking the usage of a metered price
+    sig { returns(T.nilable(String)) }
+    attr_reader :meter
+    # A brief description of the plan, hidden from customers.
+    sig { returns(T.nilable(String)) }
+    attr_reader :nickname
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The product whose pricing this plan determines.
+    sig { returns(T.nilable(T.any(String, Stripe::Product))) }
+    attr_reader :product
+    # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+    sig { returns(T::Array[Tier]) }
+    attr_reader :tiers
+    # Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
+    sig { returns(T.nilable(String)) }
+    attr_reader :tiers_mode
+    # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
+    sig { returns(T.nilable(TransformUsage)) }
+    attr_reader :transform_usage
+    # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :trial_period_days
+    # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
+    sig { returns(String) }
+    attr_reader :usage_type
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+    class DeleteParams < Stripe::RequestParams
+
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    class UpdateParams < Stripe::RequestParams
+      # Whether the plan is currently available for new subscriptions.
+      sig { returns(T::Boolean) }
+      attr_accessor :active
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :metadata
+      # A brief description of the plan, hidden from customers.
+      sig { returns(String) }
+      attr_accessor :nickname
+      # The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
+      sig { returns(String) }
+      attr_accessor :product
+      # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
+      sig { returns(Integer) }
+      attr_accessor :trial_period_days
+      sig {
+        params(active: T::Boolean, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), nickname: String, product: String, trial_period_days: Integer).void
+       }
+      def initialize(
+        active: nil,
+        expand: nil,
+        metadata: nil,
+        nickname: nil,
+        product: nil,
+        trial_period_days: nil
+      ); end
+    end
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :lte
+        sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
+      sig { returns(T::Boolean) }
+      attr_accessor :active
+      # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+      sig { returns(T.any(::Stripe::Plan::ListParams::Created, Integer)) }
+      attr_accessor :created
+      # 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.
+      sig { returns(String) }
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      sig { returns(Integer) }
+      attr_accessor :limit
+      # Only return plans for the given product.
+      sig { returns(String) }
+      attr_accessor :product
+      # 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.
+      sig { returns(String) }
+      attr_accessor :starting_after
+      sig {
+        params(active: T::Boolean, created: T.any(::Stripe::Plan::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, product: String, starting_after: String).void
+       }
+      def initialize(
+        active: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        product: nil,
+        starting_after: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      class Product < Stripe::RequestParams
+        # Whether the product is currently available for purchase. Defaults to `true`.
+        sig { returns(T::Boolean) }
+        attr_accessor :active
+        # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
+        sig { returns(String) }
+        attr_accessor :id
+        # 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`.
+        sig { returns(T::Hash[String, String]) }
+        attr_accessor :metadata
+        # The product's name, meant to be displayable to the customer.
+        sig { returns(String) }
+        attr_accessor :name
+        # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
+        #
+        # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
+        sig { returns(String) }
+        attr_accessor :statement_descriptor
+        # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+        sig { returns(String) }
+        attr_accessor :tax_code
+        # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
+        sig { returns(String) }
+        attr_accessor :unit_label
+        sig {
+          params(active: T::Boolean, id: String, metadata: T::Hash[String, String], name: String, statement_descriptor: String, tax_code: String, unit_label: String).void
+         }
+        def initialize(
+          active: nil,
+          id: nil,
+          metadata: nil,
+          name: nil,
+          statement_descriptor: nil,
+          tax_code: nil,
+          unit_label: nil
+        ); end
+      end
+      class Tier < Stripe::RequestParams
+        # The flat billing amount for an entire tier, regardless of the number of units in the tier.
+        sig { returns(Integer) }
+        attr_accessor :flat_amount
+        # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
+        sig { returns(String) }
+        attr_accessor :flat_amount_decimal
+        # The per unit billing amount for each individual unit for which this tier applies.
+        sig { returns(Integer) }
+        attr_accessor :unit_amount
+        # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+        sig { returns(String) }
+        attr_accessor :unit_amount_decimal
+        # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
+        sig { returns(T.any(String, Integer)) }
+        attr_accessor :up_to
+        sig {
+          params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
+         }
+        def initialize(
+          flat_amount: nil,
+          flat_amount_decimal: nil,
+          unit_amount: nil,
+          unit_amount_decimal: nil,
+          up_to: nil
+        ); end
+      end
+      class TransformUsage < Stripe::RequestParams
+        # Divide usage by this number.
+        sig { returns(Integer) }
+        attr_accessor :divide_by
+        # After division, either round the result `up` or `down`.
+        sig { returns(String) }
+        attr_accessor :round
+        sig { params(divide_by: Integer, round: String).void }
+        def initialize(divide_by: nil, round: nil); end
+      end
+      # Whether the plan is currently available for new subscriptions. Defaults to `true`.
+      sig { returns(T::Boolean) }
+      attr_accessor :active
+      # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
+      sig { returns(String) }
+      attr_accessor :aggregate_usage
+      # A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
+      sig { returns(Integer) }
+      attr_accessor :amount
+      # Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
+      sig { returns(String) }
+      attr_accessor :amount_decimal
+      # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
+      sig { returns(String) }
+      attr_accessor :billing_scheme
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      sig { returns(String) }
+      attr_accessor :currency
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
+      sig { returns(String) }
+      attr_accessor :id
+      # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
+      sig { returns(String) }
+      attr_accessor :interval
+      # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
+      sig { returns(Integer) }
+      attr_accessor :interval_count
+      # 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`.
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :metadata
+      # The meter tracking the usage of a metered price
+      sig { returns(String) }
+      attr_accessor :meter
+      # A brief description of the plan, hidden from customers.
+      sig { returns(String) }
+      attr_accessor :nickname
+      # Attribute for param field product
+      sig { returns(T.any(::Stripe::Plan::CreateParams::Product, String)) }
+      attr_accessor :product
+      # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+      sig { returns(T::Array[::Stripe::Plan::CreateParams::Tier]) }
+      attr_accessor :tiers
+      # Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
+      sig { returns(String) }
+      attr_accessor :tiers_mode
+      # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
+      sig { returns(::Stripe::Plan::CreateParams::TransformUsage) }
+      attr_accessor :transform_usage
+      # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
+      sig { returns(Integer) }
+      attr_accessor :trial_period_days
+      # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
+      sig { returns(String) }
+      attr_accessor :usage_type
+      sig {
+        params(active: T::Boolean, aggregate_usage: String, amount: Integer, amount_decimal: String, billing_scheme: String, currency: String, expand: T::Array[String], id: String, interval: String, interval_count: Integer, metadata: T.nilable(T::Hash[String, String]), meter: String, nickname: String, product: T.any(::Stripe::Plan::CreateParams::Product, String), tiers: T::Array[::Stripe::Plan::CreateParams::Tier], tiers_mode: String, transform_usage: ::Stripe::Plan::CreateParams::TransformUsage, trial_period_days: Integer, usage_type: String).void
+       }
+      def initialize(
+        active: nil,
+        aggregate_usage: nil,
+        amount: nil,
+        amount_decimal: nil,
+        billing_scheme: nil,
+        currency: nil,
+        expand: nil,
+        id: nil,
+        interval: nil,
+        interval_count: nil,
+        metadata: nil,
+        meter: nil,
+        nickname: nil,
+        product: nil,
+        tiers: nil,
+        tiers_mode: nil,
+        transform_usage: nil,
+        trial_period_days: nil,
+        usage_type: nil
+      ); end
+    end
+    # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+    sig {
+      params(params: T.any(::Stripe::Plan::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
+    sig {
+      params(id: String, params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
+     }
+    def self.delete(id, params = {}, opts = {}); end
+
+    # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
+    sig {
+      params(params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
+     }
+    def delete(params = {}, opts = {}); end
+
+    # Returns a list of your plans.
+    sig {
+      params(params: T.any(::Stripe::Plan::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+
+    # Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
+    sig {
+      params(id: String, params: T.any(::Stripe::Plan::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
+     }
+    def self.update(id, params = {}, opts = {}); end
+  end
+end