stripe 19.2.0 → 19.3.0.pre.beta.1

data/lib/stripe/resources/shared_payment/issued_token.rb

@@ -0,0 +1,291 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module SharedPayment
+    # A SharedPaymentIssuedToken is a limited-use reference to a PaymentMethod that can be created with a secret key. When shared with another Stripe account (Seller), it enables that account to either process a payment on Stripe against a PaymentMethod that your Stripe account owns, or to forward a usable credential created against the originalPaymentMethod to then process the payment off-Stripe.
+    class IssuedToken < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "shared_payment.issued_token"
+      def self.object_name
+        "shared_payment.issued_token"
+      end
+
+      class NextAction < ::Stripe::StripeObject
+        class UseStripeSdk < ::Stripe::StripeObject
+          # A base64-encoded string used by Stripe.js and the iOS and Android client SDKs to handle the next action. Its content is subject to change.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Specifies the type of next action required. Determines which child attribute contains action details.
+        attr_reader :type
+        # Contains details for handling the next action using Stripe.js, iOS, or Android SDKs. Present when `next_action.type` is `use_stripe_sdk`.
+        attr_reader :use_stripe_sdk
+
+        def self.inner_class_types
+          @inner_class_types = { use_stripe_sdk: UseStripeSdk }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RiskDetails < ::Stripe::StripeObject
+        class Insights < ::Stripe::StripeObject
+          class Bot < ::Stripe::StripeObject
+            # Recommended action for this insight.
+            attr_reader :recommended_action
+            # Risk score for this insight.
+            attr_reader :score
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class CardIssuerDecline < ::Stripe::StripeObject
+            # Recommended action for this insight.
+            attr_reader :recommended_action
+            # Risk score for this insight.
+            attr_reader :score
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class CardTesting < ::Stripe::StripeObject
+            # Recommended action for this insight.
+            attr_reader :recommended_action
+            # Risk score for this insight.
+            attr_reader :score
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class FraudulentDispute < ::Stripe::StripeObject
+            # Recommended action for this insight.
+            attr_reader :recommended_action
+            # Risk score for this insight.
+            attr_reader :score
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class StolenCard < ::Stripe::StripeObject
+            # Recommended action for this insight.
+            attr_reader :recommended_action
+            # Risk score for this insight.
+            attr_reader :score
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Bot risk insight.
+          attr_reader :bot
+          # Card issuer decline risk insight.
+          attr_reader :card_issuer_decline
+          # Card testing risk insight.
+          attr_reader :card_testing
+          # Fraudulent dispute risk insight.
+          attr_reader :fraudulent_dispute
+          # Stolen card risk insight.
+          attr_reader :stolen_card
+
+          def self.inner_class_types
+            @inner_class_types = {
+              bot: Bot,
+              card_issuer_decline: CardIssuerDecline,
+              card_testing: CardTesting,
+              fraudulent_dispute: FraudulentDispute,
+              stolen_card: StolenCard,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Risk insights for this token, including scores and recommended actions for each risk type.
+        attr_reader :insights
+
+        def self.inner_class_types
+          @inner_class_types = { insights: Insights }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SellerDetails < ::Stripe::StripeObject
+        # A unique id within a network that identifies a logical seller. This should usually be the merchant id on the seller platform.
+        attr_reader :external_id
+        # The unique and logical string that identifies the seller platform that this SharedToken is being created for.
+        attr_reader :network_business_profile
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class UsageDetails < ::Stripe::StripeObject
+        class AmountCaptured < ::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
+          # Integer value of the amount in the smallest currency unit.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The total amount captured using this SharedPaymentToken.
+        attr_reader :amount_captured
+
+        def self.inner_class_types
+          @inner_class_types = { amount_captured: AmountCaptured }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class UsageLimits < ::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
+        # Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.
+        attr_reader :expires_at
+        # Max amount that can be captured using this SharedPaymentToken.
+        attr_reader :max_amount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Time at which this SharedPaymentIssuedToken was deactivated.
+      attr_reader :deactivated_at
+      # The reason why the SharedPaymentIssuedToken has been deactivated.
+      attr_reader :deactivated_reason
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # If present, describes the action required to make this `SharedPaymentIssuedToken` usable for payments. Present when the token is in `requires_action` state.
+      attr_reader :next_action
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # ID of an existing PaymentMethod.
+      attr_reader :payment_method
+      # If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
+      attr_reader :return_url
+      # Risk details of the SharedPaymentIssuedToken.
+      attr_reader :risk_details
+      # Seller details of the SharedPaymentIssuedToken, including network_id and external_id.
+      attr_reader :seller_details
+      # Indicates that you intend to save the PaymentMethod of this SharedPaymentToken to a customer later.
+      attr_reader :setup_future_usage
+      # Metadata about the SharedPaymentIssuedToken.
+      attr_reader :shared_metadata
+      # Status of this SharedPaymentIssuedToken, one of `active`, `requires_action`, or `deactivated`.
+      attr_reader :status
+      # Usage details of the SharedPaymentIssuedToken
+      attr_reader :usage_details
+      # Usage limits of the SharedPaymentIssuedToken.
+      attr_reader :usage_limits
+
+      # Creates a new SharedPaymentIssuedToken object
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/shared_payment/issued_tokens",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Revokes a SharedPaymentIssuedToken
+      def revoke(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/shared_payment/issued_tokens/%<shared_payment_issued_token>s/revoke", { shared_payment_issued_token: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Revokes a SharedPaymentIssuedToken
+      def self.revoke(shared_payment_issued_token, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/shared_payment/issued_tokens/%<shared_payment_issued_token>s/revoke", { shared_payment_issued_token: CGI.escape(shared_payment_issued_token) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          next_action: NextAction,
+          risk_details: RiskDetails,
+          seller_details: SellerDetails,
+          usage_details: UsageDetails,
+          usage_limits: UsageLimits,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/source.rb

@@ -169,6 +169,8 @@ module Stripe
       attr_reader :address_zip_check
       # Attribute for field brand
       attr_reader :brand
+      # Attribute for field brand_product
+      attr_reader :brand_product
       # Attribute for field country
       attr_reader :country
       # Attribute for field cvc_check
@@ -218,6 +220,8 @@ module Stripe
       attr_reader :authorization_response_code
       # Attribute for field brand
       attr_reader :brand
+      # Attribute for field brand_product
+      attr_reader :brand_product
       # Attribute for field country
       attr_reader :country
       # Attribute for field cvm_type
@@ -517,6 +521,35 @@ module Stripe
       end
     end
 
+    class Paypal < ::Stripe::StripeObject
+      # Attribute for field billing_agreement
+      attr_reader :billing_agreement
+      # Attribute for field fingerprint
+      attr_reader :fingerprint
+      # Attribute for field payer_id
+      attr_reader :payer_id
+      # Attribute for field reference_id
+      attr_reader :reference_id
+      # Attribute for field reference_transaction_amount
+      attr_reader :reference_transaction_amount
+      # Attribute for field reference_transaction_charged
+      attr_reader :reference_transaction_charged
+      # Attribute for field statement_descriptor
+      attr_reader :statement_descriptor
+      # Attribute for field transaction_id
+      attr_reader :transaction_id
+      # Attribute for field verified_email
+      attr_reader :verified_email
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Receiver < ::Stripe::StripeObject
       # The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
       attr_reader :address
@@ -737,6 +770,8 @@ module Stripe
       attr_reader :authenticated
       # Attribute for field brand
       attr_reader :brand
+      # Attribute for field brand_product
+      attr_reader :brand_product
       # Attribute for field card
       attr_reader :card
       # Attribute for field country
@@ -849,6 +884,8 @@ module Stripe
     attr_reader :owner
     # Attribute for field p24
     attr_reader :p24
+    # Attribute for field paypal
+    attr_reader :paypal
     # Attribute for field receiver
     attr_reader :receiver
     # Attribute for field redirect
@@ -954,6 +991,7 @@ module Stripe
         multibanco: Multibanco,
         owner: Owner,
         p24: P24,
+        paypal: Paypal,
         receiver: Receiver,
         redirect: Redirect,
         sepa_credit_transfer: SepaCreditTransfer,

data/lib/stripe/resources/subscription.rb

@@ -222,6 +222,37 @@ module Stripe
       end
     end
 
+    class LastPriceMigrationError < ::Stripe::StripeObject
+      class FailedTransition < ::Stripe::StripeObject
+        # The original price to be migrated.
+        attr_reader :source_price
+        # The intended resulting price of the migration.
+        attr_reader :target_price
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The time at which the price migration encountered an error.
+      attr_reader :errored_at
+      # The involved price pairs in each failed transition.
+      attr_reader :failed_transitions
+      # The type of error encountered by the price migration.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { failed_transitions: FailedTransition }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class ManagedPayments < ::Stripe::StripeObject
       # Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session.
       attr_reader :enabled
@@ -292,6 +323,31 @@ module Stripe
           end
         end
 
+        class Blik < ::Stripe::StripeObject
+          class MandateOptions < ::Stripe::StripeObject
+            # Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
+            attr_reader :expires_after
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field mandate_options
+          attr_reader :mandate_options
+
+          def self.inner_class_types
+            @inner_class_types = { mandate_options: MandateOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Card < ::Stripe::StripeObject
           class MandateOptions < ::Stripe::StripeObject
             # Amount to be charged for future payments, specified in the presentment currency.
@@ -366,6 +422,16 @@ module Stripe
           end
         end
 
+        class IdBankTransfer < ::Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Konbini < ::Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
@@ -484,6 +550,8 @@ module Stripe
             class Filters < ::Stripe::StripeObject
               # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
               attr_reader :account_subcategories
+              # The institution to use to filter for possible accounts to link.
+              attr_reader :institution
 
               def self.inner_class_types
                 @inner_class_types = {}
@@ -525,10 +593,14 @@ module Stripe
         attr_reader :acss_debit
         # This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
         attr_reader :bancontact
+        # This sub-hash contains details about the Blik payment method options to pass to invoices created by the subscription.
+        attr_reader :blik
         # This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
         attr_reader :card
         # This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
         attr_reader :customer_balance
+        # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
+        attr_reader :id_bank_transfer
         # This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
         attr_reader :konbini
         # This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
@@ -546,8 +618,10 @@ module Stripe
           @inner_class_types = {
             acss_debit: AcssDebit,
             bancontact: Bancontact,
+            blik: Blik,
             card: Card,
             customer_balance: CustomerBalance,
+            id_bank_transfer: IdBankTransfer,
             konbini: Konbini,
             payto: Payto,
             pix: Pix,
@@ -603,6 +677,8 @@ module Stripe
       attr_reader :expires_at
       # Set of [key-value pairs](https://docs.stripe.com/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 number of iterations of prebilling to apply.
+      attr_reader :prebilling_iterations
       # List of subscription items, each with an attached plan, that will be set if the update is applied.
       attr_reader :subscription_items
       # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
@@ -619,6 +695,25 @@ module Stripe
       end
     end
 
+    class Prebilling < ::Stripe::StripeObject
+      # ID of the prebilling invoice.
+      attr_reader :invoice
+      # The end of the last period for which the invoice pre-bills.
+      attr_reader :period_end
+      # The start of the first period for which the invoice pre-bills.
+      attr_reader :period_start
+      # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
+      attr_reader :update_behavior
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class PresentmentDetails < ::Stripe::StripeObject
       # Currency used for customer payments.
       attr_reader :presentment_currency
@@ -632,6 +727,47 @@ module Stripe
       end
     end
 
+    class StatusDetails < ::Stripe::StripeObject
+      class Paused < ::Stripe::StripeObject
+        class Subscription < ::Stripe::StripeObject
+          # The reason that the subscription was paused.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Information on the `type=subscription` pause.
+        attr_reader :subscription
+        # Unix timestamp in seconds of when the subscription status transitioned to `paused`.
+        attr_reader :transitioned_at
+        # The type of pause.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { subscription: Subscription }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Indicates when and why the subscription transitioned to the paused status.
+      attr_reader :paused
+
+      def self.inner_class_types
+        @inner_class_types = { paused: Paused }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class TransferData < ::Stripe::StripeObject
       # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
       attr_reader :amount_percent
@@ -649,6 +785,8 @@ module Stripe
 
     class TrialSettings < ::Stripe::StripeObject
       class EndBehavior < ::Stripe::StripeObject
+        # Indicates how the subscription's billing cycle anchor is reset when a trial ends. If not set, the default is `now`.
+        attr_reader :billing_cycle_anchor
         # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
         attr_reader :missing_payment_method
 
@@ -725,6 +863,8 @@ module Stripe
     attr_reader :invoice_settings
     # List of subscription items, each with an attached price.
     attr_reader :items
+    # Details of the most recent price migration that failed for the subscription.
+    attr_reader :last_price_migration_error
     # The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
     attr_reader :latest_invoice
     # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
@@ -749,6 +889,8 @@ module Stripe
     attr_reader :pending_setup_intent
     # If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
     attr_reader :pending_update
+    # Time period and invoice for a Subscription billed in advance.
+    attr_reader :prebilling
     # Attribute for field presentment_details
     attr_reader :presentment_details
     # The schedule attached to the subscription
@@ -767,6 +909,8 @@ module Stripe
     #
     # If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
     attr_reader :status
+    # Describes changes to the subscription's status.
+    attr_reader :status_details
     # ID of the test clock this subscription belongs to.
     attr_reader :test_clock
     # The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
@@ -862,6 +1006,26 @@ module Stripe
       )
     end
 
+    # Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
+    def pause(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/pause", { subscription: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
+    def self.pause(subscription, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/pause", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn't generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about [resuming subscriptions](https://docs.stripe.com/docs/billing/subscriptions/pause#resume-subscriptions).
     def resume(params = {}, opts = {})
       request_stripe_object(
@@ -936,12 +1100,15 @@ module Stripe
         billing_thresholds: BillingThresholds,
         cancellation_details: CancellationDetails,
         invoice_settings: InvoiceSettings,
+        last_price_migration_error: LastPriceMigrationError,
         managed_payments: ManagedPayments,
         pause_collection: PauseCollection,
         payment_settings: PaymentSettings,
         pending_invoice_item_interval: PendingInvoiceItemInterval,
         pending_update: PendingUpdate,
+        prebilling: Prebilling,
         presentment_details: PresentmentDetails,
+        status_details: StatusDetails,
         transfer_data: TransferData,
         trial_settings: TrialSettings,
       }