recurly 4.14.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b02a2e9e2e9b93e37f8e31eaddef05c08ed2e5fcb751bbaddcc3ea36be332d4
-  data.tar.gz: 471fad48ff51f5d17a6358e8fb687731a25a373d9704e5c6bbbb64c25ad5cce2
+  metadata.gz: e6350d81107627313accb7813754e37e2e8c85156d1c0ae8d5d3c479c649347c
+  data.tar.gz: b7d579a7443eba62a85622ff0093ac611fee38cc9740e41755100a0d694e2cb2
 SHA512:
-  metadata.gz: 99011bc1dfd15bb41eeb83016cf18a4c4f663ca0e29dbd434e1504bda3adadd062af79ed34566aff9c06bf5c49a749ca87c6eef24a8df2f9aea077bf9d3ac5c4
-  data.tar.gz: da440a26c262ca22648653b353d7afc5210f43c64c3e92844d29509d5fca62087d6d66d8c2bf0c2c2f9d9cbaefa1261cae56736cd5088f334bb0116eaa4bbf22
+  metadata.gz: 8d73edf3e7bc58f744c6efc71a659c256453f1c46b3d0ae3c74c3784b5ecf7a720b74d438a81f66f15cc145aba13dfaf6f3c24bdd2f42f8980182e3aa607b6ba
+  data.tar.gz: eeadb1726e33c8f011f2ab72eb1784881550bc39426ae299c139b788ed9031e12050e0b947bfa7db44623728475025f185e58f7700dbcbc2dfcb2342f92aad5c

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.14.0
+current_version = 4.18.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on: [push]
+concurrency: 
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }} tests
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: ./scripts/build
+      - run: ./scripts/test
+  buildall:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Build (matrix)
+    needs: build
+    steps:
+      - name: Check build matrix status
+        if: ${{ needs.build.result != 'success' }}
+        run: exit 1

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [4.18.0](https://github.com/recurly/recurly-client-ruby/tree/4.18.0) (2022-06-16)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.17.0...4.18.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#776](https://github.com/recurly/recurly-client-ruby/pull/776) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.17.0](https://github.com/recurly/recurly-client-ruby/tree/4.17.0) (2022-04-15)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.16.0...4.17.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#766](https://github.com/recurly/recurly-client-ruby/pull/766) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.16.0](https://github.com/recurly/recurly-client-ruby/tree/4.16.0) (2022-03-24)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.15.0...4.16.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Percentage tiers feature) [#762](https://github.com/recurly/recurly-client-ruby/pull/762) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.15.0](https://github.com/recurly/recurly-client-ruby/tree/4.15.0) (2022-03-14)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.14.0...4.15.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Percentage tiers feature) [#757](https://github.com/recurly/recurly-client-ruby/pull/757) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.14.0](https://github.com/recurly/recurly-client-ruby/tree/4.14.0) (2022-03-03)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.13.0...4.14.0)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.14'
+gem 'recurly', '~> 4.18'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -3351,6 +3351,17 @@ module Recurly
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
+    # @example
+    #   begin
+    #     invoice_collection = @client.get_preview_renewal(
+    #       subscription_id: subscription_id
+    #     )
+    #     puts "Fetched Renewal Preview with total: #{invoice_collection.charge_invoice.total}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
     #
     def get_preview_renewal(subscription_id:, **options)
       path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)

data/lib/recurly/requests/account_create.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :first_name, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @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

data/lib/recurly/requests/account_purchase.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @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

data/lib/recurly/requests/account_update.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :first_name, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @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

data/lib/recurly/requests/add_on_create.rb

@@ -62,6 +62,10 @@ module Recurly
       #   @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
@@ -79,13 +83,17 @@ module Recurly
       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`, or alternatively, `usage_percentage` for usage percentage type usage add ons. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
+      #   @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

data/lib/recurly/requests/add_on_pricing.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/requests/add_on_update.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @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]] `percentage_tiers` is an array of objects, which must have the 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 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
@@ -63,7 +67,7 @@ module Recurly
       define_attribute :tax_code, 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`, or alternatively, `usage_percentage` for usage percentage type usage add ons. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
+      #   @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

data/lib/recurly/requests/billing_info_create.rb

@@ -99,11 +99,11 @@ module Recurly
       define_attribute :sort_code, String
 
       # @!attribute tax_identifier
-      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
+      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
       define_attribute :tax_identifier, String
 
       # @!attribute tax_identifier_type
-      #   @return [String] This field and a value of `cpf` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
+      #   @return [String] This field and a value of `cpf`, `cnpj` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
       define_attribute :tax_identifier_type, String
 
       # @!attribute three_d_secure_action_result_token_id

data/lib/recurly/requests/percentage_tier.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 PercentageTier < Request
+
+      # @!attribute ending_amount
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
+      define_attribute :ending_amount, Float
+
+      # @!attribute usage_percentage
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/requests/percentage_tiers_by_currency.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 PercentageTiersByCurrency < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute tiers
+      #   @return [Array[PercentageTier]] Tiers
+      define_attribute :tiers, Array, { :item_type => :PercentageTier }
+    end
+  end
+end

data/lib/recurly/requests/plan_pricing.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :setup_fee, Float
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/requests/pricing.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
       define_attribute :code, String
 
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
       # @!attribute quantity
       #   @return [Integer] Quantity
       define_attribute :quantity, Integer
@@ -23,7 +27,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. 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 :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_add_on_percentage_tier.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 SubscriptionAddOnPercentageTier < Request
+
+      # @!attribute ending_amount
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
+      define_attribute :ending_amount, Float
+
+      # @!attribute usage_percentage
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_tier.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnTier < Request
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
       define_attribute :ending_quantity, Integer
 
       # @!attribute unit_amount
@@ -19,7 +19,7 @@ module Recurly
       define_attribute :unit_amount_decimal, String
 
       # @!attribute usage_percentage
-      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
       define_attribute :id, String
 
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
       # @!attribute quantity
       #   @return [Integer] Quantity
       define_attribute :quantity, Integer
@@ -27,7 +31,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_change_create.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :shipping, :SubscriptionChangeShippingCreate
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute timeframe

data/lib/recurly/requests/subscription_update.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :shipping, :SubscriptionShippingUpdate
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute terms_and_conditions

data/lib/recurly/requests/tier.rb

@@ -11,11 +11,11 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :TierPricing }
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons, but for percentage type usage add ons, represents the site default currency in its minimum divisible unit.
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
       define_attribute :ending_quantity, Integer
 
       # @!attribute usage_percentage
-      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/account.rb

@@ -91,7 +91,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template. Available when the Invoice Customization feature is enabled. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
+      #   @return [String] Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
       define_attribute :invoice_template_id, String
 
       # @!attribute last_name

data/lib/recurly/resources/account_balance_amount.rb

@@ -13,6 +13,10 @@ module Recurly
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
+
+      # @!attribute processing_prepayment_amount
+      #   @return [Float] Total amount for the prepayment credit invoices in a `processing` state on the account.
+      define_attribute :processing_prepayment_amount, Float
     end
   end
 end

data/lib/recurly/resources/add_on.rb

@@ -110,6 +110,10 @@ module Recurly
       #   @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.
       define_attribute :usage_percentage, Float
 
+      # @!attribute usage_timeframe
+      #   @return [String] The time at which usage totals are reset for billing purposes.
+      define_attribute :usage_timeframe, String
+
       # @!attribute usage_type
       #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
       define_attribute :usage_type, String

data/lib/recurly/resources/add_on_pricing.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/resources/percentage_tier.rb

@@ -7,11 +7,11 @@ module Recurly
     class PercentageTier < Resource
 
       # @!attribute ending_amount
-      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. The last tier ending_amount is null.
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
       define_attribute :ending_amount, Float
 
       # @!attribute usage_percentage
-      #   @return [String] Decimal usage percentage.
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/plan_pricing.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :setup_fee, Float
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/resources/pricing.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/resources/subscription.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
 
+      # @!attribute active_invoice_id
+      #   @return [String] The invoice ID of the latest invoice created for an active subscription.
+      define_attribute :active_invoice_id, String
+
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOn]] Add-ons
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }

data/lib/recurly/resources/subscription_add_on.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute percentage_tiers
-      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
       define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
 
       # @!attribute quantity
@@ -51,7 +51,7 @@ module Recurly
       define_attribute :tier_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request.
+      #   @return [Array[SubscriptionAddOnTier]] If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request. If add_on.tier_type is tiered or volume and add_on.usage_type is percentage use percentage_tiers instead.  There must be one tier without an `ending_quantity` value which represents the final tier.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
@@ -69,6 +69,10 @@ module Recurly
       # @!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 and usage_type is percentage.
       define_attribute :usage_percentage, Float
+
+      # @!attribute usage_timeframe
+      #   @return [String] The time at which usage totals are reset for billing purposes.
+      define_attribute :usage_timeframe, String
     end
   end
 end

data/lib/recurly/resources/subscription_add_on_percentage_tier.rb

@@ -7,11 +7,11 @@ module Recurly
     class SubscriptionAddOnPercentageTier < Resource
 
       # @!attribute ending_amount
-      #   @return [Float] Ending amount
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
       define_attribute :ending_amount, Float
 
       # @!attribute usage_percentage
-      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0.
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/subscription_add_on_tier.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnTier < Resource
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
       define_attribute :ending_quantity, Integer
 
       # @!attribute unit_amount
@@ -19,7 +19,7 @@ module Recurly
       define_attribute :unit_amount_decimal, String
 
       # @!attribute usage_percentage
-      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/subscription_change.rb

@@ -67,7 +67,7 @@ module Recurly
       define_attribute :subscription_id, String
 
       # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      #   @return [Boolean] This field is deprecated. Please do not use it.
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount

data/lib/recurly/resources/tier.rb

@@ -11,11 +11,11 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :TierPricing }
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons, but for percentage type usage add ons, represents the site default currency in its minimum divisible unit.
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
       define_attribute :ending_quantity, Integer
 
       # @!attribute usage_percentage
-      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/usage.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
       # @!attribute recording_timestamp
       #   @return [DateTime] When the usage was recorded in your system.
       define_attribute :recording_timestamp, DateTime
@@ -43,7 +47,7 @@ module Recurly
       define_attribute :tier_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = null
+      #   @return [Array[SubscriptionAddOnTier]] The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = []
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.14.0"
+  VERSION = "4.18.0"
 end

data/openapi/api.yaml

@@ -12519,7 +12519,97 @@ paths:
             application/json:
               schema:
                 "$ref": "#/components/schemas/Error"
-      x-code-samples: []
+      x-code-samples:
+      - lang: Node.js
+        source: |
+          try {
+            const invoiceCollection = await client.getPreviewRenewal(subscriptionId)
+            console.log('Fetched Renewal Preview with total: ', invoiceCollection.chargeInvoice.total)
+          } catch (err) {
+            if (err instanceof recurly.errors.NotFoundError) {
+              // If the request was not found, you may want to alert the user or
+              // just return null
+              console.log('Resource Not Found')
+            } else {
+              // If we don't know what to do with the err, we should
+              // probably re-raise and let our web framework and logger handle it
+              console.log('Unknown Error: ', err)
+            }
+          }
+      - lang: Python
+        source: |
+          try:
+              invoice_collection = client.get_preview_renewal(subscription_id)
+              print("Fetched Renewal Preview with total: %s" % invoice_collection.charge_invoice.total)
+          except recurly.errors.NotFoundError:
+              # If the resource was not found, you may want to alert the user or
+              # just return nil
+              print("Resource Not Found")
+      - lang: ".NET"
+        source: |
+          try
+          {
+              InvoiceCollection invoiceCollection = client.GetPreviewRenewal(subscriptionId);
+              Console.WriteLine($"Fetched Renewal Preview with total {invoiceCollection.ChargeInvoice.Total}");
+          }
+          catch (Recurly.Errors.NotFound ex)
+          {
+              // If the resource was not found
+              // we may want to alert the user or just return null
+              Console.WriteLine($"Resource Not Found: {ex.Error.Message}");
+          }
+          catch (Recurly.Errors.ApiError ex)
+          {
+              // Use ApiError to catch a generic error from the API
+              Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
+          }
+      - lang: Ruby
+        source: |
+          begin
+            invoice_collection = @client.get_preview_renewal(
+              subscription_id: subscription_id
+            )
+            puts "Fetched Renewal Preview with total: #{invoice_collection.charge_invoice.total}"
+          rescue Recurly::Errors::NotFoundError
+            # If the resource was not found, you may want to alert the user or
+            # just return nil
+            puts "Resource Not Found"
+          end
+      - lang: Java
+        source: |
+          try {
+              final InvoiceCollection invoiceCollection = client.getPreviewRenewal(subscriptionId);
+              System.out.println("Fetched Renewal Preview with total: " + invoiceCollection.getChargeInvoice().getTotal());
+          } catch (ValidationException e) {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in e.getError().getParams()
+              System.out.println("Failed validation: " + e.getError().getMessage());
+          } catch (ApiException e) {
+              // Use ApiException to catch a generic error from the API
+              System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
+          }
+      - lang: PHP
+        source: |
+          try {
+              $invoiceCollection = $client->getPreviewRenewal($subscription_id);
+
+              echo 'Fetched Renewal Preview with total: ' . $invoiceCollection->getChargeInvoice()->getTotal() . PHP_EOL;
+              var_dump($invoiceCollection);
+          } catch (\Recurly\Errors\NotFound $e) {
+              // Could not find the resource, you may want to inform the user
+              // or just return a NULL
+              echo 'Could not find resource.' . PHP_EOL;
+              var_dump($e);
+          } catch (\Recurly\RecurlyError $e) {
+              // Something bad happened... tell the user so that they can fix it?
+              echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
+          }
+      - lang: Go
+        source: "invoiceCollection, err := client.GetPreviewRenewal(subID)\nif e,
+          ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound
+          {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
+          Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Renewal
+          Preview with total: %f\", invoiceCollection.ChargeInvoice.Total)"
   "/subscriptions/{subscription_id}/change":
     get:
       tags:
@@ -15852,7 +15942,7 @@ components:
           type: string
           title: Invoice Template ID
           description: Unique ID to identify an invoice template.  Available when
-            the Invoice Customization feature is enabled.  Used to specify which invoice
+            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.
         address:
           "$ref": "#/components/schemas/Address"
@@ -15935,7 +16025,7 @@ components:
           type: string
           title: Invoice Template ID
           description: Unique ID to identify an invoice template. Available when the
-            Invoice Customization feature is enabled. Used to specify if a non-default
+            site is on a Pro or Enterprise plan. Used to specify if a non-default
             invoice template will be used to generate invoices for the account. For
             sites without multiple invoice templates enabled, the default template
             will always be used.
@@ -16040,6 +16130,12 @@ components:
           format: float
           title: Amount
           description: Total amount the account is past due.
+        processing_prepayment_amount:
+          type: number
+          format: float
+          title: Amount
+          description: Total amount for the prepayment credit invoices in a `processing`
+            state on the account.
     InvoiceAddress:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -16265,6 +16361,8 @@ components:
           readOnly: true
         tier_type:
           "$ref": "#/components/schemas/TierTypeEnum"
+        usage_timeframe:
+          "$ref": "#/components/schemas/UsageTimeframeEnum"
         tiers:
           type: array
           title: Tiers
@@ -16443,6 +16541,8 @@ components:
             * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
         tier_type:
           "$ref": "#/components/schemas/TierTypeEnum"
+        usage_timeframe:
+          "$ref": "#/components/schemas/UsageTimeframeCreateEnum"
         tiers:
           type: array
           title: Tiers
@@ -16451,8 +16551,18 @@ components:
           description: |
             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`, or alternatively, `usage_percentage` for usage percentage type usage add ons. There must be one tier with an `ending_quantity`
-            of 999999999 which is the default if not provided.
+            the desired `currencies`. There must be one tier without an `ending_quantity` value
+            which represents the final tier.
+        percentage_tiers:
+          type: array
+          title: Percentage Tiers By Currency
+          items:
+            "$ref": "#/components/schemas/PercentageTiersByCurrency"
+          description: |
+            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.
       required:
       - code
       - name
@@ -16580,8 +16690,18 @@ components:
           description: |
             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`, or alternatively, `usage_percentage` for usage percentage type usage add ons. There must be one tier with an `ending_quantity`
-            of 999999999 which is the default if not provided.
+            the desired `currencies`. There must be one tier without an `ending_quantity` value
+            which represents the final tier.
+        percentage_tiers:
+          type: array
+          title: Percentage Tiers By Currency
+          items:
+            "$ref": "#/components/schemas/PercentageTiersByCurrency"
+          description: |
+            `percentage_tiers` is an array of objects, which must have the 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.
     BillingInfo:
       type: object
       properties:
@@ -16781,11 +16901,12 @@ components:
           type: string
           description: Tax identifier is required if adding a billing info that is
             a consumer card in Brazil or in Argentina. This would be the customer's
-            CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for
-            all residents who pay taxes in Brazil and Argentina respectively.
+            CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers
+            for all residents who pay taxes in Brazil and Argentina respectively.
         tax_identifier_type:
-          description: This field and a value of `cpf` or `cuit` are required if adding
-            a billing info that is an elo or hipercard type in Brazil or in Argentina.
+          description: This field and a value of `cpf`, `cnpj` or `cuit` are required
+            if adding a billing info that is an elo or hipercard type in Brazil or
+            in Argentina.
           "$ref": "#/components/schemas/TaxIdentifierTypeEnum"
         primary_payment_method:
           type: boolean
@@ -19119,9 +19240,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
     PlanUpdate:
       type: object
       properties:
@@ -19283,9 +19403,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
       required:
       - currency
     TierPricing:
@@ -19332,9 +19451,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
       required:
       - currency
       - unit_amount
@@ -19344,17 +19462,15 @@ components:
         ending_quantity:
           type: integer
           title: Ending quantity
-          description: Ending quantity for the tier.  This represents a unit amount
-            for unit-priced add ons, but for percentage type usage add ons, represents
-            the site default currency in its minimum divisible unit.
           minimum: 1
           maximum: 999999999
-          default: 999999999
+          default: 
+          description: Ending quantity for the tier.  This represents a unit amount
+            for unit-priced add ons. Must be left empty if it is the final tier.
         usage_percentage:
           type: string
           title: Usage Percentage
-          description: This field is deprecated. Do not used it anymore for percentage
-            tiers add ons. Use the percentage_tiers object instead.
+          description: "(deprecated) -- Use the percentage_tiers object instead."
           deprecated: true
         currencies:
           type: array
@@ -19383,14 +19499,19 @@ components:
           type: number
           format: float
           title: Ending amount
-          minimum: 0.1
-          maximum: 9999999999999
+          minimum: 0.01
+          maximum: 9999999999999.99
+          default: 
           description: Ending amount for the tier. Allows up to 2 decimal places.
-            The last tier ending_amount is null.
+            Must be left empty if it is the final tier.
         usage_percentage:
           type: string
           title: Usage Percentage
-          description: Decimal usage percentage.
+          minimum: 0
+          maximum: 100
+          description: |
+            The percentage taken of the monetary amount of usage tracked.
+            This can be up to 4 decimal places represented as a string.
     Settings:
       type: object
       properties:
@@ -20036,6 +20157,13 @@ components:
           type: string
           title: Billing Info ID
           description: Billing Info ID.
+        active_invoice_id:
+          type: string
+          title: Active invoice ID
+          description: The invoice ID of the latest invoice created for an active
+            subscription.
+          maxLength: 13
+          readOnly: true
     SubscriptionAddOn:
       type: object
       title: Subscription Add-on
@@ -20075,15 +20203,19 @@ components:
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
         tier_type:
           "$ref": "#/components/schemas/TierTypeEnum"
+        usage_timeframe:
+          "$ref": "#/components/schemas/UsageTimeframeEnum"
         tiers:
           type: array
           title: Tiers
           items:
             "$ref": "#/components/schemas/SubscriptionAddOnTier"
           minItems: 1
-          description: |
-            If tiers are provided in the request, all existing tiers on the Subscription Add-on will be
-            removed and replaced by the tiers in the request.
+          description: "If tiers are provided in the request, all existing tiers on
+            the Subscription Add-on will be\nremoved and replaced by the tiers in
+            the request. If add_on.tier_type is tiered or volume and\nadd_on.usage_type
+            is percentage use percentage_tiers instead. \nThere must be one tier without
+            an `ending_quantity` value which represents the final tier.\n"
         percentage_tiers:
           type: array
           title: Percentage Tiers
@@ -20092,7 +20224,9 @@ components:
           minItems: 1
           description: |
             If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
-            removed and replaced by the percentage tiers in the request.
+            removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
+            add_on.usage_type is percentage.
+            There must be one tier without an `ending_amount` value which represents the final tier.
         usage_percentage:
           type: number
           format: float
@@ -20158,13 +20292,25 @@ components:
           description: |
             If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
             must include one to many tiers with `ending_quantity` and `unit_amount`.
-            There must be one tier with an `ending_quantity` of 999999999 which is the
-            default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+            There must be one tier without an `ending_quantity` value which represents the final tier.
+            See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
+        percentage_tiers:
+          type: array
+          title: Percentage Tiers
+          items:
+            "$ref": "#/components/schemas/SubscriptionAddOnPercentageTier"
+          minItems: 1
+          description: |
+            If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
+            removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier.
+            Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
         usage_percentage:
           type: number
           format: float
           title: Usage Percentage
+          minimum: 0
+          maximum: 100
           description: 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 and `usage_type` is percentage. Must be omitted
@@ -20227,8 +20373,18 @@ components:
           description: |
             If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
             must include one to many tiers with `ending_quantity` and `unit_amount`.
-            There must be one tier with an `ending_quantity` of 999999999 which is the
-            default if not provided.
+            There must be one tier without an `ending_quantity` value which represents the final tier.
+        percentage_tiers:
+          type: array
+          title: Percentage Tiers
+          items:
+            "$ref": "#/components/schemas/SubscriptionAddOnPercentageTier"
+          minItems: 1
+          description: |
+            If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
+            removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
+            add_on.usage_type is percentage.
+            There must be one tier without an `ending_amount` value which represents the final tier.
         usage_percentage:
           type: number
           format: float
@@ -20247,7 +20403,9 @@ components:
           title: Ending quantity
           minimum: 1
           maximum: 999999999
-          default: 999999999
+          default: 
+          description: Ending quantity for the tier.  This represents a unit amount
+            for unit-priced add ons. Must be left empty if it is the final tier.
         unit_amount:
           type: number
           format: float
@@ -20267,8 +20425,7 @@ components:
         usage_percentage:
           type: string
           title: Usage Percentage
-          description: This field is deprecated. Do not used it anymore for percentage
-            tiers subscription add ons. Use the percentage_tiers object instead.
+          description: "(deprecated) -- Use the percentage_tiers object instead."
           deprecated: true
     SubscriptionAddOnPercentageTier:
       type: object
@@ -20280,13 +20437,16 @@ components:
           minimum: 1
           maximum: 9999999999999.99
           default: 
+          description: Ending amount for the tier. Allows up to 2 decimal places.
+            Must be left empty if it is the final tier.
         usage_percentage:
           type: string
           title: Usage Percentage
+          minimum: 0
+          maximum: 100
           description: |
             The percentage taken of the monetary amount of usage tracked.
-            This can be up to 4 decimal places represented as a string. A value between
-            0.0 and 100.0.
+            This can be up to 4 decimal places represented as a string.
     SubscriptionCancel:
       type: object
       properties:
@@ -20331,9 +20491,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
         quantity:
           type: integer
           title: Subscription quantity
@@ -20425,9 +20584,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
         quantity:
           type: integer
           title: Quantity
@@ -20866,9 +21024,8 @@ components:
           type: boolean
           title: Tax Inclusive?
           default: false
-          description: Determines whether or not tax is included in the unit amount.
-            The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
-            feature) must be enabled to use this flag.
+          description: This field is deprecated. Please do not use it.
+          deprecated: true
         shipping:
           "$ref": "#/components/schemas/SubscriptionShippingUpdate"
         billing_info_id:
@@ -21349,7 +21506,14 @@ components:
           items:
             "$ref": "#/components/schemas/SubscriptionAddOnTier"
           description: The tiers and prices of the subscription based on the usage_timestamp.
-            If tier_type = flat, tiers = null
+            If tier_type = flat, tiers = []
+        percentage_tiers:
+          type: array
+          title: Percentage Tiers
+          items:
+            "$ref": "#/components/schemas/SubscriptionAddOnPercentageTier"
+          description: The percentage tiers of the subscription based on the usage_timestamp.
+            If tier_type = flat, percentage_tiers = []
         measured_unit_id:
           type: string
           description: The ID of the measured unit associated with the add-on the
@@ -22000,11 +22164,13 @@ components:
       - ko-KR
       - nl-BE
       - nl-NL
+      - pl-PL
       - pt-BR
       - pt-PT
       - ro-RO
       - ru-RU
       - sk-SK
+      - sv-SE
       - tr-TR
       - zh-CN
     BillToEnum:
@@ -22115,6 +22281,25 @@ components:
       - tiered
       - stairstep
       - volume
+    UsageTimeframeEnum:
+      type: string
+      title: Usage Timeframe
+      description: The time at which usage totals are reset for billing purposes.
+      enum:
+      - billing_period
+      - subscription_term
+      default: billing_period
+    UsageTimeframeCreateEnum:
+      type: string
+      title: Usage Timeframe
+      description: |
+        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.
+      enum:
+      - billing_period
+      - subscription_term
+      default: billing_period
     CreditPaymentActionEnum:
       type: string
       enum:
@@ -22597,6 +22782,7 @@ components:
       - three_d_secure_connection_error
       - three_d_secure_credential_error
       - three_d_secure_not_supported
+      - too_busy
       - too_many_attempts
       - total_credit_exceeds_capture
       - transaction_already_refunded
@@ -22658,6 +22844,7 @@ components:
       type: string
       enum:
       - cpf
+      - cnpj
       - cuit
     DunningCycleTypeEnum:
       type: string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,10 +119,10 @@ files:
 - ".changelog_config.yaml"
 - ".github/ISSUE_TEMPLATE/bug-report.md"
 - ".github/ISSUE_TEMPLATE/question-or-other.md"
+- ".github/workflows/ci.yml"
 - ".github/workflows/docs.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -176,6 +176,8 @@ files:
 - lib/recurly/requests/line_item_refund.rb
 - lib/recurly/requests/measured_unit_create.rb
 - lib/recurly/requests/measured_unit_update.rb
+- lib/recurly/requests/percentage_tier.rb
+- lib/recurly/requests/percentage_tiers_by_currency.rb
 - lib/recurly/requests/plan_create.rb
 - lib/recurly/requests/plan_hosted_pages.rb
 - lib/recurly/requests/plan_pricing.rb
@@ -189,6 +191,7 @@ files:
 - lib/recurly/requests/shipping_method_update.rb
 - lib/recurly/requests/shipping_purchase.rb
 - lib/recurly/requests/subscription_add_on_create.rb
+- lib/recurly/requests/subscription_add_on_percentage_tier.rb
 - lib/recurly/requests/subscription_add_on_tier.rb
 - lib/recurly/requests/subscription_add_on_update.rb
 - lib/recurly/requests/subscription_cancel.rb
@@ -306,7 +309,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.14.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,16 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-bundler_args: --binstubs
-before_install:
-  - sudo apt-get update && sudo apt-get install apt-transport-https ca-certificates -y && sudo update-ca-certificates
-  - gem update --system
-  - gem install bundler
-dist: focal
-script:
-  - ./scripts/test