recurly 4.13.0 → 4.17.0

data/lib/recurly/requests/account_create.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/requests/account_purchase.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/requests/account_update.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

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_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

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] *STRONGLY RECOMMENDED*
       define_attribute :cvv, String
 
+      # @!attribute external_hpp_type
+      #   @return [String] Use for Adyen HPP billing info.
+      define_attribute :external_hpp_type, String
+
       # @!attribute first_name
       #   @return [String] First name
       define_attribute :first_name, String
@@ -74,6 +78,10 @@ module Recurly
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
 
+      # @!attribute online_banking_payment_type
+      #   @return [String] Use for Online Banking billing info.
+      define_attribute :online_banking_payment_type, String
+
       # @!attribute paypal_billing_agreement_id
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String

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_create.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute hosted_pages

data/lib/recurly/requests/plan_update.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute hosted_pages

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] 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. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
+      #   @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_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. Do not use it anymore to update a subscription's tax inclusivity. Use the POST subscription change route instead.
       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] Decimal usage percentage.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/account.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :deleted_at, DateTime
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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
@@ -90,9 +90,9 @@ module Recurly
       #   @return [String]
       define_attribute :id, String
 
-      # @!attribute invoice_template
-      #   @return [AccountInvoiceTemplate] Invoice template associated to the account. Available when invoice customization flag is enabled.
-      define_attribute :invoice_template, :AccountInvoiceTemplate
+      # @!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.
+      define_attribute :invoice_template_id, String
 
       # @!attribute last_name
       #   @return [String]

data/lib/recurly/resources/account_mini.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/resources/add_on.rb

@@ -74,6 +74,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
+      define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
+
       # @!attribute plan_id
       #   @return [String] Plan ID
       define_attribute :plan_id, String
@@ -106,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/invoice.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :due_at, DateTime
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute has_more_line_items
@@ -146,6 +146,10 @@ module Recurly
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime
 
+      # @!attribute uuid
+      #   @return [String] Invoice UUID
+      define_attribute :uuid, String
+
       # @!attribute vat_number
       #   @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
       define_attribute :vat_number, String

data/lib/recurly/resources/invoice_template.rb

@@ -0,0 +1,34 @@
+# 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 Resources
+    class InvoiceTemplate < Resource
+
+      # @!attribute code
+      #   @return [String] Invoice template code.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the invoice template was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Invoice template description.
+      define_attribute :description, String
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Invoice template name.
+      define_attribute :name, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the invoice template was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/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 Resources
+    class PercentageTier < Resource
+
+      # @!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/resources/{account_invoice_template.rb → percentage_tiers_by_currency.rb}

@@ -4,15 +4,15 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Resources
-    class AccountInvoiceTemplate < Resource
+    class PercentageTiersByCurrency < Resource
 
-      # @!attribute id
-      #   @return [String] Unique ID to identify the invoice template.
-      define_attribute :id, String
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
 
-      # @!attribute name
-      #   @return [String] Template name
-      define_attribute :name, String
+      # @!attribute tiers
+      #   @return [Array[PercentageTier]] Tiers
+      define_attribute :tiers, Array, { :item_type => :PercentageTier }
     end
   end
 end

data/lib/recurly/resources/plan.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute hosted_pages

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

@@ -30,6 +30,10 @@ module Recurly
       #   @return [String] Object type
       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. 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] Add-on quantity
       define_attribute :quantity, Integer
@@ -47,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
@@ -65,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

@@ -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 Resources
+    class SubscriptionAddOnPercentageTier < Resource
+
+      # @!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/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] 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. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

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] Decimal usage percentage.
+      #   @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.13.0"
+  VERSION = "4.17.0"
 end