stripe 15.5.0 → 15.6.0.pre.beta.1

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

@@ -47,6 +47,8 @@ module Stripe
       class ListParams < Stripe::RequestParams
         # Only return credit grants for this customer.
         attr_accessor :customer
+        # Only return credit grants for this account.
+        attr_accessor :customer_account
         # 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.
         attr_accessor :ending_before
         # Specifies which fields in the response should be expanded.
@@ -58,12 +60,14 @@ module Stripe
 
         def initialize(
           customer: nil,
+          customer_account: nil,
           ending_before: nil,
           expand: nil,
           limit: nil,
           starting_after: nil
         )
           @customer = customer
+          @customer_account = customer_account
           @ending_before = ending_before
           @expand = expand
           @limit = limit
@@ -130,6 +134,8 @@ module Stripe
         attr_accessor :category
         # ID of the customer to receive the billing credits.
         attr_accessor :customer
+        # ID of the account to receive the billing credits.
+        attr_accessor :customer_account
         # The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
         attr_accessor :effective_at
         # Specifies which fields in the response should be expanded.
@@ -148,6 +154,7 @@ module Stripe
           applicability_config: nil,
           category: nil,
           customer: nil,
+          customer_account: nil,
           effective_at: nil,
           expand: nil,
           expires_at: nil,
@@ -159,6 +166,7 @@ module Stripe
           @applicability_config = applicability_config
           @category = category
           @customer = customer
+          @customer_account = customer_account
           @effective_at = effective_at
           @expand = expand
           @expires_at = expires_at
@@ -210,6 +218,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/meter_usage.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
+    class MeterUsage < SingletonAPIResource
+      OBJECT_NAME = "billing.meter_usage"
+      def self.object_name
+        "billing.meter_usage"
+      end
+
+      # The aggregated meter usage data for the specified customer and time range.
+      attr_reader :data
+      # Timestamp indicating how fresh the data is. Measured in seconds since the Unix epoch.
+      attr_reader :data_refreshed_at
+      # 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
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterUsageRow < APIResource
+      OBJECT_NAME = "billing.meter_usage_row"
+      def self.object_name
+        "billing.meter_usage_row"
+      end
+
+      # Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
+      attr_reader :bucket_end_time
+      # Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
+      attr_reader :bucket_start_time
+      # The aggregated meter usage value for the specified bucket.
+      attr_reader :bucket_value
+      # A set of key-value pairs representing the dimensions of the meter usage.
+      attr_reader :dimensions
+      # 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_id
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+    end
+  end
+end

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

@@ -244,6 +244,8 @@ module Stripe
         attr_accessor :configuration
         # The ID of an existing customer.
         attr_accessor :customer
+        # The ID of an existing account.
+        attr_accessor :customer_account
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # 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.
@@ -258,6 +260,7 @@ module Stripe
         def initialize(
           configuration: nil,
           customer: nil,
+          customer_account: nil,
           expand: nil,
           flow_data: nil,
           locale: nil,
@@ -266,6 +269,7 @@ module Stripe
         )
           @configuration = configuration
           @customer = customer
+          @customer_account = customer_account
           @expand = expand
           @flow_data = flow_data
           @locale = locale
@@ -279,6 +283,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,179 @@
+# 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
+      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
+      end
+
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # limit list to offers belonging to given connected account
+        attr_accessor :connected_account
+        # Only return offers that were created during the given date interval.
+        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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        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.
+        attr_accessor :limit
+        # 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.
+        attr_accessor :starting_after
+        # limit list to offers with given status
+        attr_accessor :status
+
+        def initialize(
+          connected_account: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @connected_account = connected_account
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class MarkDeliveredParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        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
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+        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
+      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
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing the details of a transaction on a Capital financing object.
+    class FinancingTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_transaction"
+      def self.object_name
+        "capital.financing_transaction"
+      end
+
+      class Details < Stripe::StripeObject
+        class Transaction < Stripe::StripeObject
+          # The linked payment ID.
+          attr_reader :charge
+          # The linked Treasury Financing Transaction ID.
+          attr_reader :treasury_transaction
+        end
+        # The advance amount being repaid, paid out, or reversed in minor units.
+        attr_reader :advance_amount
+        # The currency of the financing transaction.
+        attr_reader :currency
+        # The fee amount being repaid, paid out, or reversed in minor units.
+        attr_reader :fee_amount
+        # The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
+        attr_reader :linked_payment
+        # The reason for the financing transaction (if applicable).
+        attr_reader :reason
+        # The reversed transaction. This field only applies to financing
+        # transactions of type `reversal`.
+        attr_reader :reversed_transaction
+        # The advance and fee amount being repaid, paid out, or reversed in minor units.
+        attr_reader :total_amount
+        # This is an object representing a linked transaction on a Capital Financing Transaction.
+        attr_reader :transaction
+      end
+
+      class ListParams < Stripe::RequestParams
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+        attr_accessor :charge
+        # 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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Returns transactions that were created that apply to this financing offer ID.
+        attr_accessor :financing_offer
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # Only returns transactions that are responsible for reversing this financing transaction ID.
+        attr_accessor :reversed_transaction
+        # 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.
+        attr_accessor :starting_after
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+        attr_accessor :treasury_transaction
+
+        def initialize(
+          charge: nil,
+          ending_before: nil,
+          expand: nil,
+          financing_offer: nil,
+          limit: nil,
+          reversed_transaction: nil,
+          starting_after: nil,
+          treasury_transaction: nil
+        )
+          @charge = charge
+          @ending_before = ending_before
+          @expand = expand
+          @financing_offer = financing_offer
+          @limit = limit
+          @reversed_transaction = reversed_transaction
+          @starting_after = starting_after
+          @treasury_transaction = treasury_transaction
+        end
+      end
+      # The ID of the merchant associated with this financing transaction.
+      attr_reader :account
+      # Time at which the financing transaction was created. Given in seconds since unix epoch.
+      attr_reader :created_at
+      # This is an object representing a transaction on a Capital financing offer.
+      attr_reader :details
+      # The Capital financing offer for this financing transaction.
+      attr_reader :financing_offer
+      # A unique identifier for the financing transaction object.
+      attr_reader :id
+      # The Capital transaction object that predates the Financing Transactions API and
+      # corresponds with the balance transaction that was created as a result of this
+      # financing transaction.
+      attr_reader :legacy_balance_transaction_source
+      # 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
+      # The object type: financing_transaction
+      attr_reader :object
+      # The type of the financing transaction.
+      attr_reader :type
+      # A human-friendly description of the financing transaction.
+      attr_reader :user_facing_description
+
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/card.rb

@@ -45,6 +45,8 @@ module Stripe
     attr_reader :available_payout_methods
     # Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
     attr_reader :brand
+    # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+    attr_reader :brand_product
     # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
     attr_reader :country
     # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.

data/lib/stripe/resources/cash_balance.rb

@@ -19,6 +19,8 @@ module Stripe
     attr_reader :available
     # The ID of the customer whose cash balance this object represents.
     attr_reader :customer
+    # The ID of the account whose cash balance this object represents.
+    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.