recurly 3.29.1 → 4.0.0

data/lib/recurly/requests/billing_info_create.rb

@@ -6,14 +6,6 @@ module Recurly
   module Requests
     class BillingInfoCreate < Request
 
-      # @!attribute account_number
-      #   @return [String] The bank account number. (ACH, Bacs only)
-      define_attribute :account_number, String
-
-      # @!attribute account_type
-      #   @return [String] The bank account type. (ACH only)
-      define_attribute :account_type, String
-
       # @!attribute address
       #   @return [Address]
       define_attribute :address, :Address
@@ -22,22 +14,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 card_network_preference
-      #   @return [String] Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
-      define_attribute :card_network_preference, String
-
       # @!attribute company
       #   @return [String] Company name
       define_attribute :company, String
 
-      # @!attribute currency
-      #   @return [String] 3-letter ISO 4217 currency code.
-      define_attribute :currency, String
-
       # @!attribute cvv
       #   @return [String] *STRONGLY RECOMMENDED*
       define_attribute :cvv, String
@@ -50,12 +30,8 @@ module Recurly
       #   @return [String] Fraud Session ID
       define_attribute :fraud_session_id, String
 
-      # @!attribute gateway_attributes
-      #   @return [GatewayAttributes] Additional attributes to send to the gateway.
-      define_attribute :gateway_attributes, :GatewayAttributes
-
       # @!attribute gateway_code
-      #   @return [String] An identifier for a specific payment gateway.
+      #   @return [String] An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
       define_attribute :gateway_code, String
 
       # @!attribute gateway_token
@@ -63,7 +39,7 @@ module Recurly
       define_attribute :gateway_token, String
 
       # @!attribute iban
-      #   @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. (SEPA only)
+      #   @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information
       define_attribute :iban, String
 
       # @!attribute ip_address
@@ -78,10 +54,6 @@ module Recurly
       #   @return [String] Expiration month
       define_attribute :month, String
 
-      # @!attribute name_on_account
-      #   @return [String] The name associated with the bank account (ACH, SEPA, Bacs only)
-      define_attribute :name_on_account, String
-
       # @!attribute number
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
@@ -91,25 +63,9 @@ module Recurly
       define_attribute :paypal_billing_agreement_id, String
 
       # @!attribute primary_payment_method
-      #   @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.
+      #   @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 roku_billing_agreement_id
-      #   @return [String] Roku's CIB if billing through Roku
-      define_attribute :roku_billing_agreement_id, String
-
-      # @!attribute routing_number
-      #   @return [String] The bank's rounting number. (ACH only)
-      define_attribute :routing_number, String
-
-      # @!attribute sort_code
-      #   @return [String] Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
-      define_attribute :sort_code, String
-
-      # @!attribute store_billing_info
-      #   @return [Boolean] Whether to store this billing info onto its associated account. Defaults to `true`.
-      define_attribute :store_billing_info, :Boolean
-
       # @!attribute tax_identifier
       #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.
       define_attribute :tax_identifier, String
@@ -123,17 +79,13 @@ module Recurly
       define_attribute :three_d_secure_action_result_token_id, String
 
       # @!attribute token_id
-      #   @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
+      #   @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
       define_attribute :token_id, String
 
       # @!attribute transaction_type
       #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
       define_attribute :transaction_type, String
 
-      # @!attribute type
-      #   @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
       #   @return [String] VAT number
       define_attribute :vat_number, String

data/lib/recurly/requests/coupon_create.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :applies_to_all_items, :Boolean
 
       # @!attribute applies_to_all_plans
-      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
       define_attribute :applies_to_all_plans, :Boolean
 
       # @!attribute applies_to_non_plan_charges

data/lib/recurly/requests/custom_field.rb

@@ -10,14 +10,6 @@ module Recurly
       #   @return [String] Fields must be created in the UI before values can be assigned to them.
       define_attribute :name, String
 
-      # @!attribute source_record_id
-      #   @return [String] The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
-      define_attribute :source_record_id, String
-
-      # @!attribute source_record_type
-      #   @return [String] The type of record this custom field was automatically copied from. Only present when the field was copied from another record.
-      define_attribute :source_record_type, String
-
       # @!attribute value
       #   @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
       define_attribute :value, String

data/lib/recurly/requests/external_transaction.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute payment_method
-      #   @return [String] Payment method used for the external transaction.
+      #   @return [String] Payment method used for external transaction.
       define_attribute :payment_method, String
     end
   end

data/lib/recurly/requests/invoice_address.rb

@@ -15,17 +15,13 @@ 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 first_name
       #   @return [String] First name
       define_attribute :first_name, String
 
-      # @!attribute geo_code
-      #   @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
-      define_attribute :geo_code, String
-
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

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. `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 three_d_secure_action_result_token_id

data/lib/recurly/requests/invoice_create.rb

@@ -14,10 +14,6 @@ module Recurly
       #   @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
       define_attribute :collection_method, String
 
-      # @!attribute credit_application_policy
-      #   @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
-      define_attribute :credit_application_policy, :CreditApplicationPolicy
-
       # @!attribute credit_customer_notes
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
       define_attribute :credit_customer_notes, String
@@ -27,7 +23,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute net_terms
-      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
       define_attribute :net_terms, Integer
 
       # @!attribute po_number
@@ -41,10 +37,6 @@ module Recurly
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
       define_attribute :vat_reverse_charge_notes, String
-
-      # @!attribute vertex_transaction_type
-      #   @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
-      define_attribute :vertex_transaction_type, String
     end
   end
 end

data/lib/recurly/requests/{invoice_updatable.rb → invoice_update.rb}

@@ -4,7 +4,7 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Requests
-    class InvoiceUpdatable < Request
+    class InvoiceUpdate < Request
 
       # @!attribute address
       #   @return [InvoiceAddress]

data/lib/recurly/requests/item_create.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/requests/item_update.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

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
@@ -67,17 +63,13 @@ module Recurly
       define_attribute :start_date, DateTime
 
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
       #   @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
@@ -85,10 +77,6 @@ module Recurly
       # @!attribute unit_amount
       #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
       define_attribute :unit_amount, Float
-
-      # @!attribute vertex_transaction_type
-      #   @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
-      define_attribute :vertex_transaction_type, String
     end
   end
 end

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
@@ -87,7 +71,7 @@ module Recurly
       define_attribute :setup_fee_revenue_schedule_type, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

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
@@ -75,7 +63,7 @@ module Recurly
       define_attribute :setup_fee_revenue_schedule_type, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

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
@@ -22,10 +22,6 @@ module Recurly
       #   @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_application_policy_override
-      #   @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
-      define_attribute :credit_application_policy_override, :CreditApplicationPolicy
-
       # @!attribute credit_customer_notes
       #   @return [String] Notes to be put on the credit invoice resulting from credits in the purchase, if any.
       define_attribute :credit_customer_notes, String
@@ -77,10 +73,6 @@ module Recurly
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT reverse charge notes for cross border European tax settlement.
       define_attribute :vat_reverse_charge_notes, String
-
-      # @!attribute vertex_transaction_type
-      #   @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
-      define_attribute :vertex_transaction_type, String
     end
   end
 end

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
@@ -26,10 +26,6 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute geo_code
-      #   @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
-      define_attribute :geo_code, String
-
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

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
@@ -26,10 +26,6 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute geo_code
-      #   @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
-      define_attribute :geo_code, String
-
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

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