stripe 16.0.0 → 16.1.0.pre.alpha.1

data/lib/stripe/resources/billing/analytics/meter_usage_row.rb

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    module Analytics
+      class MeterUsageRow < APIResource
+        OBJECT_NAME = "billing.analytics.meter_usage_row"
+        def self.object_name
+          "billing.analytics.meter_usage_row"
+        end
+
+        # A set of key-value pairs representing the dimensions of the meter usage.
+        attr_reader :dimensions
+        # Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
+        attr_reader :ends_at
+        # Unique identifier for the object.
+        attr_reader :id
+        # The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
+        attr_reader :meter
+        # String representing the object's type. Objects of the same type share the same value.
+        attr_reader :object
+        # Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
+        attr_reader :starts_at
+        # The aggregated meter usage value for the specified bucket.
+        attr_reader :value
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,45 @@ module Stripe
 
       class Balance < Stripe::StripeObject
         class AvailableBalance < Stripe::StripeObject
+          class CustomPricingUnit < Stripe::StripeObject
+            class CustomPricingUnitDetails < Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Monetary < Stripe::StripeObject
             # 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
@@ -26,13 +65,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # The monetary amount.
           attr_reader :monetary
           # The type of this amount. We currently only support `monetary` billing credits.
           attr_reader :type
 
           def self.inner_class_types
-            @inner_class_types = { monetary: Monetary }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -41,6 +82,45 @@ module Stripe
         end
 
         class LedgerBalance < Stripe::StripeObject
+          class CustomPricingUnit < Stripe::StripeObject
+            class CustomPricingUnitDetails < Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Monetary < Stripe::StripeObject
             # 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
@@ -55,13 +135,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # The monetary amount.
           attr_reader :monetary
           # The type of this amount. We currently only support `monetary` billing credits.
           attr_reader :type
 
           def self.inner_class_types
-            @inner_class_types = { monetary: Monetary }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -85,6 +167,8 @@ module Stripe
       attr_reader :balances
       # The customer the balance is for.
       attr_reader :customer
+      # The account the balance is for.
+      attr_reader :customer_account
       # 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.

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

@@ -14,6 +14,45 @@ module Stripe
 
       class Credit < Stripe::StripeObject
         class Amount < Stripe::StripeObject
+          class CustomPricingUnit < Stripe::StripeObject
+            class CustomPricingUnitDetails < Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Monetary < Stripe::StripeObject
             # 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
@@ -28,13 +67,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # The monetary amount.
           attr_reader :monetary
           # The type of this amount. We currently only support `monetary` billing credits.
           attr_reader :type
 
           def self.inner_class_types
-            @inner_class_types = { monetary: Monetary }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -77,6 +118,45 @@ module Stripe
 
       class Debit < Stripe::StripeObject
         class Amount < Stripe::StripeObject
+          class CustomPricingUnit < Stripe::StripeObject
+            class CustomPricingUnitDetails < Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Monetary < Stripe::StripeObject
             # 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
@@ -91,13 +171,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # The monetary amount.
           attr_reader :monetary
           # The type of this amount. We currently only support `monetary` billing credits.
           attr_reader :type
 
           def self.inner_class_types
-            @inner_class_types = { monetary: Monetary }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings

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

@@ -17,6 +17,45 @@ module Stripe
       end
 
       class Amount < Stripe::StripeObject
+        class CustomPricingUnit < Stripe::StripeObject
+          class CustomPricingUnitDetails < Stripe::StripeObject
+            # Time at which the object was created. Measured in seconds since the Unix epoch.
+            attr_reader :created
+            # The name of the custom pricing unit.
+            attr_reader :display_name
+            # Unique identifier for the object.
+            attr_reader :id
+            # A lookup key for the custom pricing unit.
+            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
+            # The status of the custom pricing unit.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The custom pricing unit object.
+          attr_reader :custom_pricing_unit_details
+          # Unique identifier for the object.
+          attr_reader :id
+          # A positive integer representing the amount.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Monetary < Stripe::StripeObject
           # 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
@@ -31,13 +70,15 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # The custom pricing unit amount.
+        attr_reader :custom_pricing_unit
         # The monetary amount.
         attr_reader :monetary
         # The type of this amount. We currently only support `monetary` billing credits.
         attr_reader :type
 
         def self.inner_class_types
-          @inner_class_types = { monetary: Monetary }
+          @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
         end
 
         def self.field_remappings
@@ -47,6 +88,19 @@ module Stripe
 
       class ApplicabilityConfig < Stripe::StripeObject
         class Scope < Stripe::StripeObject
+          class BillableItem < Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Price < Stripe::StripeObject
             # Unique identifier for the object.
             attr_reader :id
@@ -59,13 +113,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The billable items that credit grants can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+          attr_reader :billable_items
           # The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.
           attr_reader :price_type
           # The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.
           attr_reader :prices
 
           def self.inner_class_types
-            @inner_class_types = { prices: Price }
+            @inner_class_types = { billable_items: BillableItem, prices: Price }
           end
 
           def self.field_remappings
@@ -93,6 +149,8 @@ module Stripe
       attr_reader :created
       # ID of the customer receiving the billing credits.
       attr_reader :customer
+      # ID of the account receiving the billing credits
+      attr_reader :customer_account
       # The time when the billing credits become effective-when they're eligible for use.
       attr_reader :effective_at
       # The time when the billing credits expire. If not present, the billing credits don't expire.

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

@@ -199,6 +199,8 @@ module Stripe
       attr_reader :created
       # The ID of the customer for this session.
       attr_reader :customer
+      # The ID of the account for this session.
+      attr_reader :customer_account
       # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_reader :flow
       # Unique identifier for the object.

data/lib/stripe/resources/capital/financing_offer.rb

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_offer"
+      def self.object_name
+        "capital.financing_offer"
+      end
+
+      class AcceptedTerms < Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount amount on remaining premium for the existing loan at payout time.
+        attr_reader :previous_financing_fee_discount_amount
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class OfferedTerms < Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # Describes the type of user the offer is being extended to.
+        attr_reader :campaign_type
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+        # is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+        # and the remaining fee.
+        attr_reader :previous_financing_fee_discount_rate
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # the terms accepted by the Connected account, which may differ from those
+      # offered.
+      attr_reader :accepted_terms
+      # The ID of the merchant associated with this financing object.
+      attr_reader :account
+      # The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+      attr_reader :charged_off_at
+      # Time at which the offer was created. Given in seconds since unix epoch.
+      attr_reader :created
+      # Time at which the offer expires. Given in seconds since unix epoch.
+      attr_reader :expires_after
+      # The type of financing being offered.
+      attr_reader :financing_type
+      # A unique identifier for the financing 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
+      # 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 object type: financing_offer.
+      attr_reader :object
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # both the terms offered to the Connected account.
+      attr_reader :offered_terms
+      # Financing product identifier.
+      attr_reader :product_type
+      # The ID of the financing offer that replaced this offer.
+      attr_reader :replacement
+      # The ID of the financing offer that this offer is a replacement for.
+      attr_reader :replacement_for
+      # The current status of the offer.
+      attr_reader :status
+      # See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+      attr_reader :type
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def self.mark_delivered(financing_offer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -0,0 +1,79 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # A financing object describes an account's current financing state. Used by Connect
+    # platforms to read the state of Capital offered to their connected accounts.
+    class FinancingSummary < SingletonAPIResource
+      OBJECT_NAME = "capital.financing_summary"
+      def self.object_name
+        "capital.financing_summary"
+      end
+
+      class Details < Stripe::StripeObject
+        class CurrentRepaymentInterval < Stripe::StripeObject
+          # The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
+          # Given in seconds since unix epoch.
+          attr_reader :due_at
+          # The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+          attr_reader :paid_amount
+          # The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+          attr_reader :remaining_amount
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
+        attr_reader :advance_paid_out_at
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # The chronologically current repayment interval for the financing offer.
+        attr_reader :current_repayment_interval
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        attr_reader :fee_amount
+        # The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :paid_amount
+        # The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :remaining_amount
+        # The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
+        attr_reader :repayments_begin_at
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = { current_repayment_interval: CurrentRepaymentInterval }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Additional information about the financing summary. Describes currency, advance amount,
+      # fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
+      # repayment start date, and advance payout date.
+      attr_reader :details
+      # The Financing Offer ID this Financing Summary corresponds to
+      attr_reader :financing_offer
+      # The object type: financing_summary
+      attr_reader :object
+      # Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
+      attr_reader :status
+
+      def self.inner_class_types
+        @inner_class_types = { details: Details }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end