recurly 2.17.5 → 4.18.0

data/lib/recurly/pager.rb

@@ -0,0 +1,136 @@
+module Recurly
+  class Pager
+    attr_accessor :client
+    attr_reader :data, :next
+
+    def initialize(client:, path:, options: {})
+      @client = client
+      @path = path
+      @options = options
+      rewind!
+    end
+
+    # Performs a request with the pager `limit` set to 1 and only returns the first
+    # result in the response.
+    def first
+      # Modify the @next url to set the :limit to 1
+      original_next = @next
+      @next = @path
+      fetch_next!(@options.merge(params: @options.fetch(:params, {}).merge({ limit: 1 })))
+      # Restore the @next url to the original
+      @next = original_next
+      @data.first
+    end
+
+    # Makes a HEAD request to the API to determine how many total records exist.
+    def count
+      resource = @client.send(:head, self.next, **@options)
+      resource.get_response.total_records
+    end
+
+    # Enumerates each "page" from the server.
+    # This method yields a given block with the array of items
+    # in the page `data` and the page number the pagination is on
+    # `page_num` which is 0-indexed.
+    #
+    # @example
+    #   plans = client.list_plans()
+    #   plans.each_page do |data|
+    #     data.each do |plan|
+    #       puts "Plan: #{plan.id}"
+    #     end
+    #   end
+    # @example
+    #   plans = client.list_plans()
+    #   plans.each_page.each_with_index do |data, page_num|
+    #     puts "Page Number: #{page_num}"
+    #     data.each do |plan|
+    #       puts "Plan: #{plan.id}"
+    #     end
+    #   end
+    def each_page(&block)
+      if block_given?
+        page_enumerator.each(&block)
+      else
+        page_enumerator
+      end
+    end
+
+    # Enumerates each item on the server. Each item is yielded to the
+    # block presenting the effect of a continuous stream of items.
+    # In reality, the pager is fetching blocks of data (pages) under the hood.
+    # This method yields a given block with the next item to process.
+    #
+    # @example
+    #   plans = client.list_plans()
+    #   plans.each do |plan|
+    #     puts "Plan: #{plan.id}"
+    #   end
+    # @example
+    #   plans = client.list_plans()
+    #   plans.each.each_with_index do |plan, idx|
+    #     puts "Plan #{idx}: #{plan.id}"
+    #   end
+    def each(&block)
+      if block_given?
+        item_enumerator.each(&block)
+      else
+        item_enumerator
+      end
+    end
+
+    def has_more?
+      !!@has_more
+    end
+
+    def requires_client?
+      true
+    end
+
+    private
+
+    def item_enumerator
+      Enumerator.new do |yielder|
+        page_enumerator.each do |data|
+          data.each do |item|
+            yielder << item
+          end
+        end
+      end
+    end
+
+    def page_enumerator
+      Enumerator.new do |yielder|
+        loop do
+          # Pass in @options when requesting the first page (@data.empty?)
+          next_options = @data.empty? ? @options : @options.merge(params: {})
+          fetch_next!(next_options)
+          yielder << data
+          unless has_more?
+            rewind!
+            break
+          end
+        end
+      end
+    end
+
+    def fetch_next!(options)
+      path = extract_path(self.next)
+      page = @client.send(:get, path, **options)
+      @data = page.data.map { |d| JSONParser.from_json(d) }
+      @has_more = page.has_more
+      @next = page.next
+    end
+
+    def rewind!
+      @data = []
+      @next = @path
+    end
+
+    # Returns just the path and parameters so we can safely reuse the connection
+    def extract_path(uri_or_path)
+      uri = URI(uri_or_path)
+      uri.kind_of?(URI::HTTP) ? uri.request_uri : uri_or_path
+    end
+  end
+end

data/lib/recurly/request.rb

@@ -0,0 +1,31 @@
+module Recurly
+  # This class represents a request to Recurly.
+  # It's used to validate requests data as well as
+  # cast and serialize the request data to JSON.
+  class Request
+    extend Schema::SchemaFactory
+    extend Schema::RequestCaster
+    extend Schema::ResourceCaster
+    include Schema::SchemaValidator
+
+    attr_reader :attributes
+
+    def ==(other_resource)
+      self.attributes == other_resource.attributes
+    end
+
+    def to_s
+      self.inspect
+    end
+
+    protected
+
+    def initialize(attributes = {})
+      @attributes = self.class.cast_request(attributes)
+    end
+
+    def schema
+      self.class.schema
+    end
+  end
+end

data/lib/recurly/requests/account_acquisition_cost.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountAcquisitionCost < Request
+
+      # @!attribute amount
+      #   @return [Float] The amount of the corresponding currency used to acquire the account.
+      define_attribute :amount, Float
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+    end
+  end
+end

data/lib/recurly/requests/account_acquisition_update.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountAcquisitionUpdate < Request
+
+      # @!attribute campaign
+      #   @return [String] An arbitrary identifier for the marketing campaign that led to the acquisition of this account.
+      define_attribute :campaign, String
+
+      # @!attribute channel
+      #   @return [String] The channel through which the account was acquired.
+      define_attribute :channel, String
+
+      # @!attribute cost
+      #   @return [AccountAcquisitionCost] Account balance
+      define_attribute :cost, :AccountAcquisitionCost
+
+      # @!attribute subchannel
+      #   @return [String] An arbitrary subchannel string representing a distinction/subcategory within a broader channel.
+      define_attribute :subchannel, String
+    end
+  end
+end

data/lib/recurly/requests/account_create.rb

@@ -0,0 +1,98 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountCreate < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdate]
+      define_attribute :acquisition, :AccountAcquisitionUpdate
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      define_attribute :email, String
+
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      define_attribute :preferred_locale, String
+
+      # @!attribute shipping_addresses
+      #   @return [Array[ShippingAddressCreate]]
+      define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddressCreate }
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute transaction_type
+      #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+      define_attribute :transaction_type, String
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/account_purchase.rb

@@ -0,0 +1,98 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountPurchase < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdate]
+      define_attribute :acquisition, :AccountAcquisitionUpdate
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      define_attribute :email, String
+
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String] Optional, but if present allows an existing account to be used and updated as part of the purchase.
+      define_attribute :id, String
+
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      define_attribute :preferred_locale, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute transaction_type
+      #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+      define_attribute :transaction_type, String
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/account_update.rb

@@ -0,0 +1,86 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AccountUpdate < Request
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      define_attribute :email, String
+
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      define_attribute :preferred_locale, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute transaction_type
+      #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+      define_attribute :transaction_type, String
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/add_on_create.rb

@@ -0,0 +1,102 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AddOnCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_on_type
+      #   @return [String] Whether the add-on type is fixed, or usage-based.
+      define_attribute :add_on_type, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_service_type` must be absent.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_transaction_type` must be absent.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
+      define_attribute :currencies, Array, { :item_type => :AddOnPricing }
+
+      # @!attribute default_quantity
+      #   @return [Integer] Default quantity for the hosted pages.
+      define_attribute :default_quantity, Integer
+
+      # @!attribute display_quantity
+      #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
+      define_attribute :display_quantity, :Boolean
+
+      # @!attribute item_code
+      #   @return [String] Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      define_attribute :item_code, String
+
+      # @!attribute item_id
+      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      define_attribute :item_id, String
+
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute measured_unit_name
+      #   @return [String] Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_name, String
+
+      # @!attribute name
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
+      define_attribute :name, String
+
+      # @!attribute optional
+      #   @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+      define_attribute :optional, :Boolean
+
+      # @!attribute percentage_tiers
+      #   @return [Array[PercentageTiersByCurrency]] Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
+      define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
+      define_attribute :tax_code, String
+
+      # @!attribute tier_type
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      define_attribute :tier_type, String
+
+      # @!attribute tiers
+      #   @return [Array[Tier]] If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
+      define_attribute :tiers, Array, { :item_type => :Tier }
+
+      # @!attribute usage_percentage
+      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_timeframe
+      #   @return [String] The time at which usage totals are reset for billing purposes. Allows for `tiered` add-ons to accumulate usage over the course of multiple billing periods.
+      define_attribute :usage_timeframe, String
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      define_attribute :usage_type, String
+    end
+  end
+end

data/lib/recurly/requests/add_on_pricing.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class AddOnPricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] This field is deprecated. Please do not use it.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute unit_amount
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+    end
+  end
+end