stripe 13.4.1 → 17.0.1

data/lib/stripe/params/coupon_create_params.rb

@@ -0,0 +1,80 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponCreateParams < Stripe::RequestParams
+    class AppliesTo < Stripe::RequestParams
+      # An array of Product IDs that this Coupon will apply to.
+      attr_accessor :products
+
+      def initialize(products: nil)
+        @products = products
+      end
+    end
+
+    class CurrencyOptions < Stripe::RequestParams
+      # A positive integer representing the amount to subtract from an invoice total.
+      attr_accessor :amount_off
+
+      def initialize(amount_off: nil)
+        @amount_off = amount_off
+      end
+    end
+    # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+    attr_accessor :amount_off
+    # A hash containing directions for what this Coupon will apply discounts to.
+    attr_accessor :applies_to
+    # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+    attr_accessor :currency
+    # Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+    attr_accessor :currency_options
+    # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+    attr_accessor :duration
+    # Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
+    attr_accessor :duration_in_months
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
+    attr_accessor :id
+    # A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
+    attr_accessor :max_redemptions
+    # 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
+    # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+    attr_accessor :name
+    # A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+    attr_accessor :percent_off
+    # Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
+    attr_accessor :redeem_by
+
+    def initialize(
+      amount_off: nil,
+      applies_to: nil,
+      currency: nil,
+      currency_options: nil,
+      duration: nil,
+      duration_in_months: nil,
+      expand: nil,
+      id: nil,
+      max_redemptions: nil,
+      metadata: nil,
+      name: nil,
+      percent_off: nil,
+      redeem_by: nil
+    )
+      @amount_off = amount_off
+      @applies_to = applies_to
+      @currency = currency
+      @currency_options = currency_options
+      @duration = duration
+      @duration_in_months = duration_in_months
+      @expand = expand
+      @id = id
+      @max_redemptions = max_redemptions
+      @metadata = metadata
+      @name = name
+      @percent_off = percent_off
+      @redeem_by = redeem_by
+    end
+  end
+end

data/lib/stripe/params/coupon_delete_params.rb

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponDeleteParams < Stripe::RequestParams; end
+end

data/lib/stripe/params/coupon_list_params.rb

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponListParams < 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
+    # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+    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
+
+    def initialize(created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+      @created = created
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/coupon_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponRetrieveParams < 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/coupon_update_params.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponUpdateParams < Stripe::RequestParams
+    class CurrencyOptions < Stripe::RequestParams
+      # A positive integer representing the amount to subtract from an invoice total.
+      attr_accessor :amount_off
+
+      def initialize(amount_off: nil)
+        @amount_off = amount_off
+      end
+    end
+    # Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+    attr_accessor :currency_options
+    # 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
+    # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+    attr_accessor :name
+
+    def initialize(currency_options: nil, expand: nil, metadata: nil, name: nil)
+      @currency_options = currency_options
+      @expand = expand
+      @metadata = metadata
+      @name = name
+    end
+  end
+end

data/lib/stripe/params/credit_note_create_params.rb

@@ -0,0 +1,144 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteCreateParams < 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_line_item_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteLineItemListParams < 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/credit_note_list_params.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteListParams < 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
+    # Only return credit notes that were created during the given date interval.
+    attr_accessor :created
+    # Only return credit notes for the customer specified by this customer ID.
+    attr_accessor :customer
+    # 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
+    # Only return credit notes for the invoice specified by this invoice ID.
+    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
+    # 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(
+      created: nil,
+      customer: nil,
+      ending_before: nil,
+      expand: nil,
+      invoice: nil,
+      limit: nil,
+      starting_after: nil
+    )
+      @created = created
+      @customer = customer
+      @ending_before = ending_before
+      @expand = expand
+      @invoice = invoice
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/credit_note_list_preview_line_items_params.rb

@@ -0,0 +1,156 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteListPreviewLineItemsParams < 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