stripe 13.2.0 → 13.3.0.pre.beta.2

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

@@ -3,8 +3,7 @@
 
 module Stripe
   module Billing
-    # A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.
-    # Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.
+    # Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
     class MeterEvent < APIResource
       extend Stripe::APIOperations::Create
 
@@ -13,7 +12,22 @@ module Stripe
         "billing.meter_event"
       end
 
-      # Creates a billing meter event
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # A unique identifier for the event.
+      attr_reader :identifier
+      # 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
+      # The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+      attr_reader :payload
+      # The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
+      attr_reader :timestamp
+
+      # Creates a billing meter event.
       def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,

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

@@ -12,7 +12,23 @@ module Stripe
         "billing.meter_event_adjustment"
       end
 
-      # Creates a billing meter event adjustment
+      class Cancel < Stripe::StripeObject
+        attr_reader :identifier
+      end
+      # Specifies which event to cancel.
+      attr_reader :cancel
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # 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
+      # The meter event adjustment's status.
+      attr_reader :status
+      # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+      attr_reader :type
+
+      # Creates a billing meter event adjustment.
       def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,

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

@@ -10,6 +10,21 @@ module Stripe
       def self.object_name
         "billing.meter_event_summary"
       end
+
+      # Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
+      attr_reader :aggregated_value
+      # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
+      attr_reader :end_time
+      # 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
+      # The meter associated with this event summary.
+      attr_reader :meter
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
+      attr_reader :start_time
     end
   end
 end

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

@@ -14,6 +14,76 @@ module Stripe
         "billing_portal.configuration"
       end
 
+      class BusinessProfile < Stripe::StripeObject
+        attr_reader :headline, :privacy_policy_url, :terms_of_service_url
+      end
+
+      class Features < Stripe::StripeObject
+        class CustomerUpdate < Stripe::StripeObject
+          attr_reader :allowed_updates, :enabled
+        end
+
+        class InvoiceHistory < Stripe::StripeObject
+          attr_reader :enabled
+        end
+
+        class PaymentMethodUpdate < Stripe::StripeObject
+          attr_reader :enabled
+        end
+
+        class SubscriptionCancel < Stripe::StripeObject
+          class CancellationReason < Stripe::StripeObject
+            attr_reader :enabled, :options
+          end
+          attr_reader :cancellation_reason, :enabled, :mode, :proration_behavior
+        end
+
+        class SubscriptionUpdate < Stripe::StripeObject
+          class Product < Stripe::StripeObject
+            attr_reader :prices, :product
+          end
+
+          class ScheduleAtPeriodEnd < Stripe::StripeObject
+            class Condition < Stripe::StripeObject
+              attr_reader :type
+            end
+            attr_reader :conditions
+          end
+          attr_reader :default_allowed_updates, :enabled, :products, :proration_behavior, :schedule_at_period_end
+        end
+        attr_reader :customer_update, :invoice_history, :payment_method_update, :subscription_cancel, :subscription_update
+      end
+
+      class LoginPage < Stripe::StripeObject
+        attr_reader :enabled, :url
+      end
+      # Whether the configuration is active and can be used to create portal sessions.
+      attr_reader :active
+      # ID of the Connect Application that created the configuration.
+      attr_reader :application
+      # Attribute for field business_profile
+      attr_reader :business_profile
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
+      attr_reader :default_return_url
+      # Attribute for field features
+      attr_reader :features
+      # Unique identifier for the object.
+      attr_reader :id
+      # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
+      attr_reader :is_default
+      # 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
+      # Attribute for field login_page
+      attr_reader :login_page
+      # 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
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+
       # Creates a configuration that describes the functionality and behavior of a PortalSession
       def self.create(params = {}, opts = {})
         request_stripe_object(

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

@@ -25,6 +25,67 @@ module Stripe
         "billing_portal.session"
       end
 
+      class Flow < Stripe::StripeObject
+        class AfterCompletion < Stripe::StripeObject
+          class HostedConfirmation < Stripe::StripeObject
+            attr_reader :custom_message
+          end
+
+          class Redirect < Stripe::StripeObject
+            attr_reader :return_url
+          end
+          attr_reader :hosted_confirmation, :redirect, :type
+        end
+
+        class SubscriptionCancel < Stripe::StripeObject
+          class Retention < Stripe::StripeObject
+            class CouponOffer < Stripe::StripeObject
+              attr_reader :coupon
+            end
+            attr_reader :coupon_offer, :type
+          end
+          attr_reader :retention, :subscription
+        end
+
+        class SubscriptionUpdate < Stripe::StripeObject
+          attr_reader :subscription
+        end
+
+        class SubscriptionUpdateConfirm < Stripe::StripeObject
+          class Discount < Stripe::StripeObject
+            attr_reader :coupon, :promotion_code
+          end
+
+          class Item < Stripe::StripeObject
+            attr_reader :id, :price, :quantity
+          end
+          attr_reader :discounts, :items, :subscription
+        end
+        attr_reader :after_completion, :subscription_cancel, :subscription_update, :subscription_update_confirm, :type
+      end
+      # The configuration used by this session, describing the features available.
+      attr_reader :configuration
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The ID of the customer for this session.
+      attr_reader :customer
+      # 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.
+      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
+      # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
+      attr_reader :locale
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      attr_reader :on_behalf_of
+      # The URL to redirect customers to when they click on the portal's link to return to your website.
+      attr_reader :return_url
+      # The short-lived URL of the session that gives customers access to the customer portal.
+      attr_reader :url
+
       # Creates a session of the customer portal.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/capability.rb

@@ -13,6 +13,44 @@ module Stripe
       "capability"
     end
 
+    class FutureRequirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        attr_reader :alternative_fields_due, :original_fields_due
+      end
+
+      class Error < Stripe::StripeObject
+        attr_reader :code, :reason, :requirement
+      end
+      attr_reader :alternatives, :current_deadline, :currently_due, :disabled_reason, :errors, :eventually_due, :past_due, :pending_verification
+    end
+
+    class Requirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        attr_reader :alternative_fields_due, :original_fields_due
+      end
+
+      class Error < Stripe::StripeObject
+        attr_reader :code, :reason, :requirement
+      end
+      attr_reader :alternatives, :current_deadline, :currently_due, :disabled_reason, :errors, :eventually_due, :past_due, :pending_verification
+    end
+    # The account for which the capability enables functionality.
+    attr_reader :account
+    # Attribute for field future_requirements
+    attr_reader :future_requirements
+    # The identifier for the capability.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Whether the capability has been requested.
+    attr_reader :requested
+    # Time at which the capability was requested. Measured in seconds since the Unix epoch.
+    attr_reader :requested_at
+    # Attribute for field requirements
+    attr_reader :requirements
+    # The status of the capability.
+    attr_reader :status
+
     def resource_url
       if !respond_to?(:account) || account.nil?
         raise NotImplementedError,

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

@@ -0,0 +1,94 @@
+# 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
+        attr_reader :advance_amount, :currency, :fee_amount, :previous_financing_fee_discount_amount, :withhold_rate
+      end
+
+      class OfferedTerms < Stripe::StripeObject
+        attr_reader :advance_amount, :campaign_type, :currency, :fee_amount, :previous_financing_fee_discount_rate, :withhold_rate
+      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(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: filters,
+          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,32 @@
+# 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
+          attr_reader :due_at, :paid_amount, :remaining_amount
+        end
+        attr_reader :advance_amount, :advance_paid_out_at, :currency, :current_repayment_interval, :fee_amount, :paid_amount, :remaining_amount, :repayments_begin_at, :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,56 @@
+# 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
+          attr_reader :charge, :treasury_transaction
+        end
+        attr_reader :advance_amount, :currency, :fee_amount, :linked_payment, :reason, :reversed_transaction, :total_amount, :transaction
+      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(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/card.rb

@@ -17,6 +17,78 @@ module Stripe
       "card"
     end
 
+    class Networks < Stripe::StripeObject
+      attr_reader :preferred
+    end
+    # The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    attr_reader :account
+    # City/District/Suburb/Town/Village.
+    attr_reader :address_city
+    # Billing address country, if provided when creating card.
+    attr_reader :address_country
+    # Address line 1 (Street address/PO Box/Company name).
+    attr_reader :address_line1
+    # If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    attr_reader :address_line1_check
+    # Address line 2 (Apartment/Suite/Unit/Building).
+    attr_reader :address_line2
+    # State/County/Province/Region.
+    attr_reader :address_state
+    # ZIP or postal code.
+    attr_reader :address_zip
+    # If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    attr_reader :address_zip_check
+    # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
+    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
+    # 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 for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    attr_reader :currency
+    # The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+    attr_reader :customer
+    # If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
+    attr_reader :cvc_check
+    # Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    attr_reader :default_for_currency
+    # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
+    attr_reader :description
+    # (For tokenized numbers only.) The last four digits of the device account number.
+    attr_reader :dynamic_last4
+    # Two-digit number representing the card's expiration month.
+    attr_reader :exp_month
+    # Four-digit number representing the card's expiration year.
+    attr_reader :exp_year
+    # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
+    #
+    # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
+    attr_reader :fingerprint
+    # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+    attr_reader :funding
+    # Unique identifier for the object.
+    attr_reader :id
+    # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
+    attr_reader :iin
+    # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
+    attr_reader :issuer
+    # The last four digits of the card.
+    attr_reader :last4
+    # 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
+    # Cardholder name.
+    attr_reader :name
+    # Attribute for field networks
+    attr_reader :networks
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
+    attr_reader :status
+    # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
+    attr_reader :tokenization_method
+    # Always true for a deleted object
+    attr_reader :deleted
+
     def resource_url
       if respond_to?(:customer) && !customer.nil? && !customer.empty?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"

data/lib/stripe/resources/cash_balance.rb

@@ -9,6 +9,20 @@ module Stripe
       "cash_balance"
     end
 
+    class Settings < Stripe::StripeObject
+      attr_reader :reconciliation_mode, :using_merchant_default
+    end
+    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+    attr_reader :available
+    # The ID of the customer whose cash balance this object represents.
+    attr_reader :customer
+    # 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
+    # Attribute for field settings
+    attr_reader :settings
+
     def resource_url
       if !respond_to?(:customer) || customer.nil?
         raise NotImplementedError,