stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/price.rb

@@ -19,12 +19,188 @@ module Stripe
       "price"
     end
 
-    # Creates a new price for an existing product. The price can be recurring or one-time.
+    class CurrencyOptions < Stripe::StripeObject
+      class CustomUnitAmount < Stripe::StripeObject
+        # The maximum unit amount the customer can specify for this item.
+        attr_reader :maximum
+        # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+        attr_reader :minimum
+        # The starting unit amount which can be updated by the customer.
+        attr_reader :preset
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Tier < Stripe::StripeObject
+        # Price for the entire tier.
+        attr_reader :flat_amount
+        # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
+        attr_reader :flat_amount_decimal
+        # Per unit price for units relevant to the tier.
+        attr_reader :unit_amount
+        # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
+        attr_reader :unit_amount_decimal
+        # Up to and including to this quantity will be contained in the tier.
+        attr_reader :up_to
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+      attr_reader :custom_unit_amount
+      # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+      attr_reader :tax_behavior
+      # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+      attr_reader :tiers
+      # 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`.
+      attr_reader :unit_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`.
+      attr_reader :unit_amount_decimal
+
+      def self.inner_class_types
+        @inner_class_types = { custom_unit_amount: CustomUnitAmount, tiers: Tier }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class CustomUnitAmount < Stripe::StripeObject
+      # The maximum unit amount the customer can specify for this item.
+      attr_reader :maximum
+      # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+      attr_reader :minimum
+      # The starting unit amount which can be updated by the customer.
+      attr_reader :preset
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Recurring < Stripe::StripeObject
+      # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
+      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.
+      attr_reader :interval_count
+      # The meter tracking the usage of a metered price
+      attr_reader :meter
+      # Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
+      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`.
+      attr_reader :usage_type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Tier < Stripe::StripeObject
+      # Price for the entire tier.
+      attr_reader :flat_amount
+      # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
+      attr_reader :flat_amount_decimal
+      # Per unit price for units relevant to the tier.
+      attr_reader :unit_amount
+      # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
+      attr_reader :unit_amount_decimal
+      # Up to and including to this quantity will be contained in the tier.
+      attr_reader :up_to
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class TransformQuantity < Stripe::StripeObject
+      # Divide usage by this number.
+      attr_reader :divide_by
+      # After division, either round the result `up` or `down`.
+      attr_reader :round
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Whether the price can be used for new purchases.
+    attr_reader :active
+    # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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.
+    attr_reader :billing_scheme
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    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).
+    attr_reader :currency
+    # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+    attr_reader :currency_options
+    # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+    attr_reader :custom_unit_amount
+    # 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
+    # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
+    attr_reader :lookup_key
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # A brief description of the price, hidden from customers.
+    attr_reader :nickname
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The ID of the product this price is associated with.
+    attr_reader :product
+    # The recurring components of a price such as `interval` and `usage_type`.
+    attr_reader :recurring
+    # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+    attr_reader :tax_behavior
+    # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+    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.
+    attr_reader :tiers_mode
+    # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
+    attr_reader :transform_quantity
+    # One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
+    attr_reader :type
+    # 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`.
+    attr_reader :unit_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`.
+    attr_reader :unit_amount_decimal
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    # Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts)
     end
 
-    # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
+    # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
     def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/prices", params: params, opts: opts)
     end
@@ -46,5 +222,19 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        currency_options: CurrencyOptions,
+        custom_unit_amount: CustomUnitAmount,
+        recurring: Recurring,
+        tiers: Tier,
+        transform_quantity: TransformQuantity,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/product.rb

@@ -25,6 +25,78 @@ module Stripe
 
     nested_resource_class_methods :feature, operations: %i[create retrieve delete list]
 
+    class MarketingFeature < Stripe::StripeObject
+      # The marketing feature name. Up to 80 characters long.
+      attr_reader :name
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class PackageDimensions < Stripe::StripeObject
+      # Height, in inches.
+      attr_reader :height
+      # Length, in inches.
+      attr_reader :length
+      # Weight, in ounces.
+      attr_reader :weight
+      # Width, in inches.
+      attr_reader :width
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Whether the product is currently available for purchase.
+    attr_reader :active
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
+    attr_reader :default_price
+    # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+    attr_reader :description
+    # Unique identifier for the object.
+    attr_reader :id
+    # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
+    attr_reader :images
+    # 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
+    # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
+    attr_reader :marketing_features
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # The product's name, meant to be displayable to the customer.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The dimensions of this product for shipping purposes.
+    attr_reader :package_dimensions
+    # Whether this product is shipped (i.e., physical goods).
+    attr_reader :shippable
+    # Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
+    attr_reader :statement_descriptor
+    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+    attr_reader :tax_code
+    # The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
+    attr_reader :type
+    # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
+    attr_reader :unit_label
+    # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+    attr_reader :updated
+    # A URL of a publicly-accessible webpage for this product.
+    attr_reader :url
+    # Always true for a deleted object
+    attr_reader :deleted
+
     # Creates a new product object.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/products", params: params, opts: opts)
@@ -72,5 +144,16 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        marketing_features: MarketingFeature,
+        package_dimensions: PackageDimensions,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/product_feature.rb

@@ -9,5 +9,25 @@ module Stripe
     def self.object_name
       "product_feature"
     end
+
+    # A feature represents a monetizable ability or functionality in your system.
+    # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
+    attr_reader :entitlement_feature
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/promotion_code.rb

@@ -2,8 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
-  # A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
-  # create multiple codes for a single coupon.
+  # A Promotion Code represents a customer-redeemable code for an underlying promotion.
+  # You can create multiple codes for a single promotion.
+  #
+  # If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
+  # Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
   class PromotionCode < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -14,7 +17,79 @@ module Stripe
       "promotion_code"
     end
 
-    # A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
+    class Promotion < Stripe::StripeObject
+      # If promotion `type` is `coupon`, the coupon for this promotion.
+      attr_reader :coupon
+      # The type of promotion.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Restrictions < Stripe::StripeObject
+      class CurrencyOptions < Stripe::StripeObject
+        # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
+        attr_reader :minimum_amount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency_options
+      # A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
+      attr_reader :first_time_transaction
+      # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
+      attr_reader :minimum_amount
+      # Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
+      attr_reader :minimum_amount_currency
+
+      def self.inner_class_types
+        @inner_class_types = { currency_options: CurrencyOptions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
+    attr_reader :active
+    # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
+    attr_reader :code
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The customer that this promotion code can be used by.
+    attr_reader :customer
+    # Date at which the promotion code can no longer be redeemed.
+    attr_reader :expires_at
+    # 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
+    # Maximum number of times this promotion code can be redeemed.
+    attr_reader :max_redemptions
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Attribute for field promotion
+    attr_reader :promotion
+    # Attribute for field restrictions
+    attr_reader :restrictions
+    # Number of times this promotion code has been used.
+    attr_reader :times_redeemed
+
+    # A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/promotion_codes", params: params, opts: opts)
     end
@@ -33,5 +108,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = { promotion: Promotion, restrictions: Restrictions }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end