recurly 3.28.0 → 4.0.0

data/lib/recurly/requests/line_item_create.rb

@@ -26,10 +26,6 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
       define_attribute :currency, String
 
-      # @!attribute custom_fields
-      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
-      define_attribute :custom_fields, Array, { :item_type => :CustomField }
-
       # @!attribute description
       #   @return [String] Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
       define_attribute :description, String
@@ -39,11 +35,11 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Avaliable when the Credit Invoices feature is enabled.
+      #   @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :item_id, String
 
       # @!attribute origin
@@ -74,10 +70,6 @@ module Recurly
       #   @return [Boolean] `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
       define_attribute :tax_exempt, :Boolean
 
-      # @!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.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute type
       #   @return [String] Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.
       define_attribute :type, String

data/lib/recurly/requests/line_item_refund.rb

@@ -17,10 +17,6 @@ module Recurly
       # @!attribute quantity
       #   @return [Integer] Line item quantity to be refunded.
       define_attribute :quantity, Integer
-
-      # @!attribute quantity_decimal
-      #   @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
-      define_attribute :quantity_decimal, String
     end
   end
 end

data/lib/recurly/requests/plan_create.rb

@@ -38,18 +38,10 @@ module Recurly
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
-      # @!attribute custom_fields
-      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
-      define_attribute :custom_fields, Array, { :item_type => :CustomField }
-
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
-      # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this 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
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages
@@ -66,14 +58,6 @@ module Recurly
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
-      # @!attribute pricing_model
-      #   @return [String] A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
-      define_attribute :pricing_model, String
-
-      # @!attribute ramp_intervals
-      #   @return [Array[PlanRampInterval]] Ramp Intervals
-      define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
-
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String

data/lib/recurly/requests/plan_pricing.rb

@@ -14,12 +14,8 @@ module Recurly
       #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
       define_attribute :setup_fee, Float
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] This field is deprecated. Please do not use it.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute unit_amount
-      #   @return [Float] This field should not be sent when the pricing model is 'ramp'.
+      #   @return [Float] Unit price
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/plan_update.rb

@@ -34,18 +34,10 @@ module Recurly
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
-      # @!attribute custom_fields
-      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
-      define_attribute :custom_fields, Array, { :item_type => :CustomField }
-
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
-      # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this 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
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages
@@ -58,10 +50,6 @@ module Recurly
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
-      # @!attribute ramp_intervals
-      #   @return [Array[PlanRampInterval]] Ramp Intervals
-      define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
-
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String

data/lib/recurly/requests/pricing.rb

@@ -10,10 +10,6 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] This field is deprecated. Please do not use it.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute unit_amount
       #   @return [Float] Unit price
       define_attribute :unit_amount, Float

data/lib/recurly/requests/purchase_create.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :account, :AccountPurchase
 
       # @!attribute billing_info_id
-      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
       define_attribute :billing_info_id, String
 
       # @!attribute collection_method

data/lib/recurly/requests/shipping_address_create.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      #   @return [String] Country, 2-letter ISO code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/shipping_address_update.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      #   @return [String] Country, 2-letter ISO code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnCreate < Request
 
       # @!attribute add_on_source
-      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
       define_attribute :add_on_source, String
 
       # @!attribute code
@@ -23,15 +23,19 @@ 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://recurly.com/developers/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 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.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] * Optionally, override the add-on's default unit amount. * If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` must be absent.
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+
       # @!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. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      #   @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. Must be omitted otherwise. `usage_percentage` does not support tiers. 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_percentage, Float
     end
   end

data/lib/recurly/requests/subscription_add_on_tier.rb

@@ -11,8 +11,12 @@ module Recurly
       define_attribute :ending_quantity, Integer
 
       # @!attribute unit_amount
-      #   @return [Float] Unit amount
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnUpdate < Request
 
       # @!attribute add_on_source
-      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
       define_attribute :add_on_source, String
 
       # @!attribute code
@@ -31,9 +31,13 @@ module Recurly
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] Optionally, override the add-on's default unit amount.
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+
       # @!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

data/lib/recurly/requests/subscription_change_create.rb

@@ -7,13 +7,9 @@ module Recurly
     class SubscriptionChangeCreate < Request
 
       # @!attribute add_ons
-      #   @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`.  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
+      #   @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
-      # @!attribute billing_info
-      #   @return [SubscriptionChangeBillingInfoCreate]
-      define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate
-
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String
@@ -46,10 +42,6 @@ module Recurly
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer
 
-      # @!attribute ramp_intervals
-      #   @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
-      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
-
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String
@@ -58,10 +50,6 @@ module Recurly
       #   @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
       define_attribute :shipping, :SubscriptionChangeShippingCreate
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] This field is deprecated. Please do not use it.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute timeframe
       #   @return [String] The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
       define_attribute :timeframe, String

data/lib/recurly/requests/subscription_create.rb

@@ -19,16 +19,16 @@ module Recurly
       define_attribute :auto_renew, :Boolean
 
       # @!attribute billing_info_id
-      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
       define_attribute :billing_info_id, String
 
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String
 
-      # @!attribute coupon_code
-      #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
-      define_attribute :coupon_code, String
+      # @!attribute coupon_codes
+      #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+      define_attribute :coupon_codes, Array, { :item_type => String }
 
       # @!attribute credit_customer_notes
       #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
@@ -70,10 +70,6 @@ module Recurly
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer
 
-      # @!attribute ramp_intervals
-      #   @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
-      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
-
       # @!attribute renewal_billing_cycles
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
@@ -90,10 +86,6 @@ module Recurly
       #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
       define_attribute :starts_at, DateTime
 
-      # @!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.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute terms_and_conditions
       #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
       define_attribute :terms_and_conditions, String
@@ -107,7 +99,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] IIf set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_pause.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionPause < Request
 
       # @!attribute remaining_pause_cycles
-      #   @return [Integer] Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.
+      #   @return [Integer] Number of billing cycles to pause the subscriptions.
       define_attribute :remaining_pause_cycles, Integer
     end
   end

data/lib/recurly/requests/subscription_purchase.rb

@@ -34,10 +34,6 @@ module Recurly
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer
 
-      # @!attribute ramp_intervals
-      #   @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
-      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
-
       # @!attribute renewal_billing_cycles
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
@@ -54,20 +50,16 @@ module Recurly
       #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
       define_attribute :starts_at, DateTime
 
-      # @!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.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute total_billing_cycles
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount
-      #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value in cents. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/subscription_update.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :auto_renew, :Boolean
 
       # @!attribute billing_info_id
-      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
       define_attribute :billing_info_id, String
 
       # @!attribute collection_method
@@ -54,10 +54,6 @@ module Recurly
       #   @return [SubscriptionShippingUpdate] Subscription shipping details
       define_attribute :shipping, :SubscriptionShippingUpdate
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] This field is deprecated. Please do not use it.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute terms_and_conditions
       #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
       define_attribute :terms_and_conditions, String

data/lib/recurly/requests/tier.rb

@@ -7,8 +7,8 @@ module Recurly
     class Tier < Request
 
       # @!attribute currencies
-      #   @return [Array[Pricing]] Tier pricing
-      define_attribute :currencies, Array, { :item_type => :Pricing }
+      #   @return [Array[TierPricing]] Tier pricing
+      define_attribute :currencies, Array, { :item_type => :TierPricing }
 
       # @!attribute ending_quantity
       #   @return [Integer] Ending quantity

data/lib/recurly/requests/{plan_ramp_pricing.rb → tier_pricing.rb}

@@ -4,15 +4,19 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Requests
-    class PlanRampPricing < Request
+    class TierPricing < Request
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
       # @!attribute unit_amount
-      #   @return [Float] Represents the price for the Ramp Interval.
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/requests/usage_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class UsageCreate < Request
 
       # @!attribute amount
-      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
       define_attribute :amount, Float
 
       # @!attribute merchant_tag

data/lib/recurly/resources/account.rb

@@ -42,10 +42,6 @@ module Recurly
       #   @return [DateTime] If present, when the account was last marked inactive.
       define_attribute :deleted_at, DateTime
 
-      # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
-      define_attribute :dunning_campaign_id, String
-
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
@@ -106,10 +102,6 @@ module Recurly
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
       define_attribute :preferred_locale, String
 
-      # @!attribute preferred_time_zone
-      #   @return [String] The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.
-      define_attribute :preferred_time_zone, String
-
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddress]] The shipping addresses on the account.
       define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }

data/lib/recurly/resources/account_balance_amount.rb

@@ -10,17 +10,9 @@ module Recurly
       #   @return [Float] Total amount the account is past due.
       define_attribute :amount, Float
 
-      # @!attribute available_credit_amount
-      #   @return [Float] Total amount of the open balances on credit invoices for the account.
-      define_attribute :available_credit_amount, Float
-
       # @!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/account_mini.rb

@@ -18,10 +18,6 @@ module Recurly
       #   @return [String]
       define_attribute :company, String
 
-      # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
-      define_attribute :dunning_campaign_id, String
-
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer.
       define_attribute :email, String

data/lib/recurly/resources/add_on.rb

@@ -91,7 +91,7 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!attribute tier_type
-      #   @return [String] The type of tiering used by the Add-on.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers

data/lib/recurly/resources/add_on_pricing.rb

@@ -10,13 +10,13 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] This field is deprecated. Please do not use it.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute unit_amount
-      #   @return [Float] Unit price
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/resources/address.rb

@@ -11,17 +11,9 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      #   @return [String] Country, 2-letter ISO code.
       define_attribute :country, String
 
-      # @!attribute first_name
-      #   @return [String] First name
-      define_attribute :first_name, String
-
-      # @!attribute last_name
-      #   @return [String] Last name
-      define_attribute :last_name, String
-
       # @!attribute phone
       #   @return [String] Phone number
       define_attribute :phone, String

data/lib/recurly/resources/address_with_name.rb

@@ -0,0 +1,46 @@
+# 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 AddressWithName < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute phone
+      #   @return [String] Phone number
+      define_attribute :phone, String
+
+      # @!attribute postal_code
+      #   @return [String] Zip or postal code.
+      define_attribute :postal_code, String
+
+      # @!attribute region
+      #   @return [String] State or province.
+      define_attribute :region, String
+
+      # @!attribute street1
+      #   @return [String] Street 1
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String] Street 2
+      define_attribute :street2, String
+    end
+  end
+end

data/lib/recurly/resources/billing_info.rb

@@ -14,10 +14,6 @@ module Recurly
       #   @return [Address]
       define_attribute :address, :Address
 
-      # @!attribute backup_payment_method
-      #   @return [Boolean] The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
-      define_attribute :backup_payment_method, :Boolean
-
       # @!attribute company
       #   @return [String]
       define_attribute :company, String
@@ -51,7 +47,7 @@ module Recurly
       define_attribute :payment_method, :PaymentMethod
 
       # @!attribute primary_payment_method
-      #   @return [Boolean] The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
+      #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
       # @!attribute updated_at