recurly 3.18.1 → 3.21.0

data/lib/recurly/client.rb

@@ -103,12 +103,14 @@ module Recurly
       handle_response! request, http_response
     end
 
-    def post(path, request_data, request_class, **options)
-      request_class.new(request_data).validate!
+    def post(path, request_data = nil, request_class = nil, **options)
       request = Net::HTTP::Post.new build_url(path, options)
       request.set_content_type(JSON_CONTENT_TYPE)
       set_headers(request, options[:headers])
-      request.body = JSON.dump(request_data)
+      if request_data
+        request_class.new(request_data).validate!
+        request.body = JSON.dump(request_data)
+      end
       http_response = run_request(request, options)
       handle_response! request, http_response
     end

data/lib/recurly/errors/api_errors.rb

@@ -28,6 +28,8 @@ module Recurly
 
     class ServiceNotAvailableError < InternalServerError; end
 
+    class TaxServiceError < InternalServerError; end
+
     class BadGatewayError < ServerError; end
 
     class ServiceUnavailableError < ServerError; end

data/lib/recurly/pager.rb

@@ -24,7 +24,7 @@ module Recurly
 
     # Makes a HEAD request to the API to determine how many total records exist.
     def count
-      resource = @client.send(:head, self.next, @options)
+      resource = @client.send(:head, self.next, **@options)
       resource.get_response.total_records
     end
 

data/lib/recurly/requests/account_create.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/account_purchase.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/account_update.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/add_on_create.rb

@@ -27,7 +27,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent.
+      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -39,11 +39,11 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Avaliable when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] Unique code to identify an item. Avaliable when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_id, String
 
       # @!attribute measured_unit_id

data/lib/recurly/requests/add_on_pricing.rb

@@ -10,6 +10,10 @@ 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/add_on_update.rb

@@ -23,7 +23,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume` or `stairstep`, then `currencies` must be absent.
+      #   @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume` or `stairstep`, then `currencies` must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity

data/lib/recurly/requests/address.rb

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

data/lib/recurly/requests/billing_info_create.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] Amazon billing agreement ID
       define_attribute :amazon_billing_agreement_id, String
 
+      # @!attribute backup_payment_method
+      #   @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
+      define_attribute :backup_payment_method, :Boolean
+
       # @!attribute company
       #   @return [String] Company name
       define_attribute :company, String
@@ -75,7 +79,7 @@ module Recurly
       define_attribute :paypal_billing_agreement_id, String
 
       # @!attribute primary_payment_method
-      #   @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.
+      #   @return [Boolean] The `primary_payment_method` field 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` with a value of `true`. 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 routing_number
@@ -107,7 +111,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute type
-      #   @return [String] The payment method type for a non-credit card based billing info. The value of `bacs` is the only accepted value (Bacs only)
+      #   @return [String] The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
       define_attribute :type, String
 
       # @!attribute vat_number

data/lib/recurly/requests/billing_info_verify.rb

@@ -0,0 +1,14 @@
+# 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 BillingInfoVerify < Request
+
+      # @!attribute gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, String
+    end
+  end
+end

data/lib/recurly/requests/dunning_campaigns_bulk_update.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 DunningCampaignsBulkUpdate < Request
+
+      # @!attribute plan_codes
+      #   @return [Array[String]] List of `plan_codes` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_ids` is present.
+      define_attribute :plan_codes, Array, { :item_type => String }
+
+      # @!attribute plan_ids
+      #   @return [Array[String]] List of `plan_ids` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_codes` is present.
+      define_attribute :plan_ids, Array, { :item_type => String }
+    end
+  end
+end

data/lib/recurly/requests/invoice_address.rb

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

data/lib/recurly/requests/invoice_collect.rb

@@ -7,7 +7,7 @@ module Recurly
     class InvoiceCollect < Request
 
       # @!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.
+      #   @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.
       define_attribute :billing_info_id, String
 
       # @!attribute three_d_secure_action_result_token_id

data/lib/recurly/requests/line_item_create.rb

@@ -35,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 and Subscription Billing Terms features are enabled.
+      #   @return [String] Unique code to identify an item. Avaliable when the Credit Invoices feature is enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_id, String
 
       # @!attribute origin
@@ -70,6 +70,10 @@ 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/plan_create.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @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,6 +62,14 @@ 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,8 +14,12 @@ 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] Unit price
+      #   @return [Float] This field should not be sent when the pricing model is 'ramp'.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/plan_ramp_interval.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 PlanRampInterval < Request
+
+      # @!attribute currencies
+      #   @return [Array[PlanRampPricing]] Represents the price for the ramp interval.
+      define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
+
+      # @!attribute starting_billing_cycle
+      #   @return [Integer] Represents the first billing cycle of a ramp.
+      define_attribute :starting_billing_cycle, Integer
+    end
+  end
+end

data/lib/recurly/requests/plan_ramp_pricing.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 PlanRampPricing < 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.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @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
@@ -50,6 +54,10 @@ 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,6 +10,10 @@ 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.
+      #   @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.
       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 code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 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 code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/subscription_change_billing_info_create.rb

@@ -0,0 +1,14 @@
+# 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 SubscriptionChangeBillingInfoCreate < Request
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @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
       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
@@ -42,6 +46,10 @@ 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
@@ -50,6 +58,10 @@ 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,7 +19,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.
+      #   @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.
       define_attribute :billing_info_id, String
 
       # @!attribute collection_method
@@ -70,6 +70,10 @@ 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
@@ -86,6 +90,10 @@ 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
@@ -99,7 +107,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @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.
       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.
+      #   @return [Integer] Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.
       define_attribute :remaining_pause_cycles, Integer
     end
   end

data/lib/recurly/requests/subscription_purchase.rb

@@ -34,6 +34,10 @@ 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
@@ -50,16 +54,20 @@ 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. The date must be in the future.
+      #   @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.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount
-      #   @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.
+      #   @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.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/subscription_ramp_interval.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 SubscriptionRampInterval < Request
+
+      # @!attribute starting_billing_cycle
+      #   @return [Integer] Represents how many billing cycles are included in a ramp interval.
+      define_attribute :starting_billing_cycle, Integer
+
+      # @!attribute unit_amount
+      #   @return [Integer] Represents the price for the ramp interval.
+      define_attribute :unit_amount, Integer
+    end
+  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.
+      #   @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.
       define_attribute :billing_info_id, String
 
       # @!attribute collection_method
@@ -54,6 +54,10 @@ 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/resources/account.rb

@@ -42,6 +42,10 @@ 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

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/account_mini.rb

@@ -18,6 +18,10 @@ 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_pricing.rb

@@ -10,6 +10,10 @@ 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/resources/address.rb

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