stripe 13.4.1 → 17.0.1

data/lib/stripe/params/credit_note_preview_lines_list_params.rb

@@ -0,0 +1,156 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNotePreviewLinesListParams < Stripe::RequestParams
+    class Line < Stripe::RequestParams
+      class TaxAmount < Stripe::RequestParams
+        # The amount, in cents (or local equivalent), of the tax.
+        attr_accessor :amount
+        # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
+        attr_accessor :tax_rate
+        # The amount on which tax is calculated, in cents (or local equivalent).
+        attr_accessor :taxable_amount
+
+        def initialize(amount: nil, tax_rate: nil, taxable_amount: nil)
+          @amount = amount
+          @tax_rate = tax_rate
+          @taxable_amount = taxable_amount
+        end
+      end
+      # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
+      attr_accessor :amount
+      # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
+      attr_accessor :description
+      # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
+      attr_accessor :invoice_line_item
+      # The line item quantity to credit.
+      attr_accessor :quantity
+      # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
+      attr_accessor :tax_amounts
+      # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
+      attr_accessor :tax_rates
+      # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
+      attr_accessor :type
+      # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
+      attr_accessor :unit_amount
+      # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+      attr_accessor :unit_amount_decimal
+
+      def initialize(
+        amount: nil,
+        description: nil,
+        invoice_line_item: nil,
+        quantity: nil,
+        tax_amounts: nil,
+        tax_rates: nil,
+        type: nil,
+        unit_amount: nil,
+        unit_amount_decimal: nil
+      )
+        @amount = amount
+        @description = description
+        @invoice_line_item = invoice_line_item
+        @quantity = quantity
+        @tax_amounts = tax_amounts
+        @tax_rates = tax_rates
+        @type = type
+        @unit_amount = unit_amount
+        @unit_amount_decimal = unit_amount_decimal
+      end
+    end
+
+    class Refund < Stripe::RequestParams
+      # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+      attr_accessor :amount_refunded
+      # ID of an existing refund to link this credit note to. Required when `type` is `refund`.
+      attr_accessor :refund
+
+      def initialize(amount_refunded: nil, refund: nil)
+        @amount_refunded = amount_refunded
+        @refund = refund
+      end
+    end
+
+    class ShippingCost < Stripe::RequestParams
+      # The ID of the shipping rate to use for this order.
+      attr_accessor :shipping_rate
+
+      def initialize(shipping_rate: nil)
+        @shipping_rate = shipping_rate
+      end
+    end
+    # The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :amount
+    # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
+    attr_accessor :credit_amount
+    # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
+    attr_accessor :effective_at
+    # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
+    attr_accessor :email_type
+    # 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
+    # ID of the invoice.
+    attr_accessor :invoice
+    # 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
+    # Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :lines
+    # The credit note's memo appears on the credit note PDF.
+    attr_accessor :memo
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
+    attr_accessor :out_of_band_amount
+    # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
+    attr_accessor :reason
+    # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
+    attr_accessor :refund_amount
+    # Refunds to link to this credit note.
+    attr_accessor :refunds
+    # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :shipping_cost
+    # 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
+
+    def initialize(
+      amount: nil,
+      credit_amount: nil,
+      effective_at: nil,
+      email_type: nil,
+      ending_before: nil,
+      expand: nil,
+      invoice: nil,
+      limit: nil,
+      lines: nil,
+      memo: nil,
+      metadata: nil,
+      out_of_band_amount: nil,
+      reason: nil,
+      refund_amount: nil,
+      refunds: nil,
+      shipping_cost: nil,
+      starting_after: nil
+    )
+      @amount = amount
+      @credit_amount = credit_amount
+      @effective_at = effective_at
+      @email_type = email_type
+      @ending_before = ending_before
+      @expand = expand
+      @invoice = invoice
+      @limit = limit
+      @lines = lines
+      @memo = memo
+      @metadata = metadata
+      @out_of_band_amount = out_of_band_amount
+      @reason = reason
+      @refund_amount = refund_amount
+      @refunds = refunds
+      @shipping_cost = shipping_cost
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/credit_note_preview_params.rb

@@ -0,0 +1,144 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNotePreviewParams < Stripe::RequestParams
+    class Line < Stripe::RequestParams
+      class TaxAmount < Stripe::RequestParams
+        # The amount, in cents (or local equivalent), of the tax.
+        attr_accessor :amount
+        # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
+        attr_accessor :tax_rate
+        # The amount on which tax is calculated, in cents (or local equivalent).
+        attr_accessor :taxable_amount
+
+        def initialize(amount: nil, tax_rate: nil, taxable_amount: nil)
+          @amount = amount
+          @tax_rate = tax_rate
+          @taxable_amount = taxable_amount
+        end
+      end
+      # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
+      attr_accessor :amount
+      # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
+      attr_accessor :description
+      # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
+      attr_accessor :invoice_line_item
+      # The line item quantity to credit.
+      attr_accessor :quantity
+      # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
+      attr_accessor :tax_amounts
+      # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
+      attr_accessor :tax_rates
+      # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
+      attr_accessor :type
+      # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
+      attr_accessor :unit_amount
+      # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+      attr_accessor :unit_amount_decimal
+
+      def initialize(
+        amount: nil,
+        description: nil,
+        invoice_line_item: nil,
+        quantity: nil,
+        tax_amounts: nil,
+        tax_rates: nil,
+        type: nil,
+        unit_amount: nil,
+        unit_amount_decimal: nil
+      )
+        @amount = amount
+        @description = description
+        @invoice_line_item = invoice_line_item
+        @quantity = quantity
+        @tax_amounts = tax_amounts
+        @tax_rates = tax_rates
+        @type = type
+        @unit_amount = unit_amount
+        @unit_amount_decimal = unit_amount_decimal
+      end
+    end
+
+    class Refund < Stripe::RequestParams
+      # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+      attr_accessor :amount_refunded
+      # ID of an existing refund to link this credit note to. Required when `type` is `refund`.
+      attr_accessor :refund
+
+      def initialize(amount_refunded: nil, refund: nil)
+        @amount_refunded = amount_refunded
+        @refund = refund
+      end
+    end
+
+    class ShippingCost < Stripe::RequestParams
+      # The ID of the shipping rate to use for this order.
+      attr_accessor :shipping_rate
+
+      def initialize(shipping_rate: nil)
+        @shipping_rate = shipping_rate
+      end
+    end
+    # The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :amount
+    # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
+    attr_accessor :credit_amount
+    # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
+    attr_accessor :effective_at
+    # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
+    attr_accessor :email_type
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # ID of the invoice.
+    attr_accessor :invoice
+    # Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :lines
+    # The credit note's memo appears on the credit note PDF.
+    attr_accessor :memo
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
+    attr_accessor :out_of_band_amount
+    # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
+    attr_accessor :reason
+    # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
+    attr_accessor :refund_amount
+    # Refunds to link to this credit note.
+    attr_accessor :refunds
+    # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
+    attr_accessor :shipping_cost
+
+    def initialize(
+      amount: nil,
+      credit_amount: nil,
+      effective_at: nil,
+      email_type: nil,
+      expand: nil,
+      invoice: nil,
+      lines: nil,
+      memo: nil,
+      metadata: nil,
+      out_of_band_amount: nil,
+      reason: nil,
+      refund_amount: nil,
+      refunds: nil,
+      shipping_cost: nil
+    )
+      @amount = amount
+      @credit_amount = credit_amount
+      @effective_at = effective_at
+      @email_type = email_type
+      @expand = expand
+      @invoice = invoice
+      @lines = lines
+      @memo = memo
+      @metadata = metadata
+      @out_of_band_amount = out_of_band_amount
+      @reason = reason
+      @refund_amount = refund_amount
+      @refunds = refunds
+      @shipping_cost = shipping_cost
+    end
+  end
+end

data/lib/stripe/params/credit_note_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/credit_note_update_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteUpdateParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Credit note memo.
+    attr_accessor :memo
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+
+    def initialize(expand: nil, memo: nil, metadata: nil)
+      @expand = expand
+      @memo = memo
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/credit_note_void_credit_note_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteVoidCreditNoteParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/customer_balance_transaction_create_params.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransactionCreateParams < Stripe::RequestParams
+    # The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
+    attr_accessor :amount
+    # 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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.
+    attr_accessor :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+
+    def initialize(amount: nil, currency: nil, description: nil, expand: nil, metadata: nil)
+      @amount = amount
+      @currency = currency
+      @description = description
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/customer_balance_transaction_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransactionListParams < Stripe::RequestParams
+    # 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
+
+    def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/customer_balance_transaction_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransactionRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/customer_balance_transaction_update_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransactionUpdateParams < Stripe::RequestParams
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+
+    def initialize(description: nil, expand: nil, metadata: nil)
+      @description = description
+      @expand = expand
+      @metadata = metadata
+    end
+  end
+end

data/lib/stripe/params/customer_cash_balance_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/customer_cash_balance_transaction_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceTransactionListParams < Stripe::RequestParams
+    # 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
+
+    def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/customer_cash_balance_transaction_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceTransactionRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/customer_cash_balance_update_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceUpdateParams < Stripe::RequestParams
+    class Settings < Stripe::RequestParams
+      # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
+      attr_accessor :reconciliation_mode
+
+      def initialize(reconciliation_mode: nil)
+        @reconciliation_mode = reconciliation_mode
+      end
+    end
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # A hash of settings for this cash balance.
+    attr_accessor :settings
+
+    def initialize(expand: nil, settings: nil)
+      @expand = expand
+      @settings = settings
+    end
+  end
+end

data/lib/stripe/params/customer_create_funding_instructions_params.rb

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCreateFundingInstructionsParams < Stripe::RequestParams
+    class BankTransfer < Stripe::RequestParams
+      class EuBankTransfer < Stripe::RequestParams
+        # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
+        attr_accessor :country
+
+        def initialize(country: nil)
+          @country = country
+        end
+      end
+      # Configuration for eu_bank_transfer funding type.
+      attr_accessor :eu_bank_transfer
+      # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
+      #
+      # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
+      attr_accessor :requested_address_types
+      # The type of the `bank_transfer`
+      attr_accessor :type
+
+      def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
+        @eu_bank_transfer = eu_bank_transfer
+        @requested_address_types = requested_address_types
+        @type = type
+      end
+    end
+    # Additional parameters for `bank_transfer` funding types
+    attr_accessor :bank_transfer
+    # 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_accessor :currency
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The `funding_type` to get the instructions for.
+    attr_accessor :funding_type
+
+    def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil)
+      @bank_transfer = bank_transfer
+      @currency = currency
+      @expand = expand
+      @funding_type = funding_type
+    end
+  end
+end