recurly 3.28.0 → 4.0.0

data/lib/recurly/resources/billing_info_updated_by.rb

@@ -7,7 +7,7 @@ module Recurly
     class BillingInfoUpdatedBy < Resource
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.
+      #   @return [String] Country of IP address, if known by Recurly.
       define_attribute :country, String
 
       # @!attribute ip

data/lib/recurly/resources/coupon.rb

@@ -11,21 +11,13 @@ 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
       #   @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
       define_attribute :applies_to_non_plan_charges, :Boolean
 
-      # @!attribute bulk_coupon_code
-      #   @return [String] The Coupon code of the parent Bulk Coupon
-      define_attribute :bulk_coupon_code, String
-
-      # @!attribute bulk_coupon_id
-      #   @return [String] The Coupon ID of the parent Bulk Coupon
-      define_attribute :bulk_coupon_id, String
-
       # @!attribute code
       #   @return [String] The code the customer enters to redeem the coupon.
       define_attribute :code, String
@@ -94,18 +86,10 @@ module Recurly
       #   @return [Array[PlanMini]] A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
       define_attribute :plans, Array, { :item_type => :PlanMini }
 
-      # @!attribute plans_names
-      #   @return [Array[String]] A list of plan names for which this coupon applies.
-      define_attribute :plans_names, Array, { :item_type => String }
-
       # @!attribute redeem_by
       #   @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
       define_attribute :redeem_by, DateTime
 
-      # @!attribute redeemed_at
-      #   @return [DateTime] The date and time the unique coupon code was redeemed. This is only present for bulk coupons.
-      define_attribute :redeemed_at, DateTime
-
       # @!attribute redemption_resource
       #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
       define_attribute :redemption_resource, String
@@ -126,6 +110,10 @@ module Recurly
       #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated.
       define_attribute :unique_code_template, String
 
+      # @!attribute unique_coupon_code
+      #   @return [Hash] Will be populated when the Coupon being returned is a `UniqueCouponCode`.
+      define_attribute :unique_coupon_code, Hash
+
       # @!attribute unique_coupon_codes_count
       #   @return [Integer] When this number reaches `max_redemptions` the coupon will no longer be redeemable.
       define_attribute :unique_coupon_codes_count, Integer

data/lib/recurly/resources/custom_field_definition.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :updated_at, DateTime
 
       # @!attribute user_access
-      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
+      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
       define_attribute :user_access, String
     end
   end

data/lib/recurly/resources/invoice.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :balance, Float
 
       # @!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 closed_at
@@ -54,17 +54,17 @@ module Recurly
       #   @return [DateTime] Date invoice is due. This is the date the net terms are reached.
       define_attribute :due_at, DateTime
 
-      # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
-      define_attribute :dunning_campaign_id, String
+      # @!attribute has_more_line_items
+      #   @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
+      define_attribute :has_more_line_items, :Boolean
 
       # @!attribute id
       #   @return [String] Invoice ID
       define_attribute :id, String
 
       # @!attribute line_items
-      #   @return [LineItemList]
-      define_attribute :line_items, :LineItemList
+      #   @return [Array[LineItem]] Line Items
+      define_attribute :line_items, Array, { :item_type => :LineItem }
 
       # @!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.
@@ -91,7 +91,7 @@ module Recurly
       define_attribute :po_number, String
 
       # @!attribute previous_invoice_id
-      #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2019-10-10/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.
+      #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.
       define_attribute :previous_invoice_id, String
 
       # @!attribute refundable_amount
@@ -111,7 +111,7 @@ module Recurly
       define_attribute :subscription_ids, Array, { :item_type => String }
 
       # @!attribute subtotal
-      #   @return [Float] The summation of charges and credits, before discounts and taxes.
+      #   @return [Float] The summation of charges, discounts, and credits, before tax.
       define_attribute :subtotal, Float
 
       # @!attribute tax
@@ -142,10 +142,6 @@ module Recurly
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime
 
-      # @!attribute used_tax_service
-      #   @return [Boolean] Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
-      define_attribute :used_tax_service, :Boolean
-
       # @!attribute vat_number
       #   @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
       define_attribute :vat_number, String

data/lib/recurly/resources/invoice_address.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 first_name

data/lib/recurly/resources/line_item.rb

@@ -34,10 +34,6 @@ module Recurly
       #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
       define_attribute :avalara_transaction_type, Integer
 
-      # @!attribute bill_for_account_id
-      #   @return [String] The UUID of the account responsible for originating the line item.
-      define_attribute :bill_for_account_id, String
-
       # @!attribute created_at
       #   @return [DateTime] When the line item was created.
       define_attribute :created_at, DateTime
@@ -54,10 +50,6 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       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. For subscription related items this will be filled in automatically.
       define_attribute :description, String
@@ -71,7 +63,7 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute external_sku
-      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
+      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :external_sku, String
 
       # @!attribute id
@@ -87,11 +79,11 @@ module Recurly
       define_attribute :invoice_number, String
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available 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 legacy_category
@@ -134,10 +126,6 @@ module Recurly
       #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
       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
-
       # @!attribute refund
       #   @return [Boolean] Refund?
       define_attribute :refund, :Boolean
@@ -146,10 +134,6 @@ module Recurly
       #   @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
       define_attribute :refunded_quantity, Integer
 
-      # @!attribute refunded_quantity_decimal
-      #   @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
-      define_attribute :refunded_quantity_decimal, String
-
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String
@@ -186,10 +170,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 utilize this flag.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute tax_info
       #   @return [TaxInfo] Tax info
       define_attribute :tax_info, :TaxInfo
@@ -206,6 +186,10 @@ module Recurly
       #   @return [Float] Positive amount for a charge, negative amount for a credit.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Positive amount for a charge, negative amount for a credit.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute updated_at
       #   @return [DateTime] When the line item was last changed.
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/payment_method.rb

@@ -18,10 +18,6 @@ module Recurly
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
       define_attribute :card_type, String
 
-      # @!attribute cc_bin_country
-      #   @return [String] The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
-      define_attribute :cc_bin_country, String
-
       # @!attribute exp_month
       #   @return [Integer] Expiration month.
       define_attribute :exp_month, Integer
@@ -34,10 +30,6 @@ module Recurly
       #   @return [String] Credit card number's first six digits.
       define_attribute :first_six, String
 
-      # @!attribute gateway_attributes
-      #   @return [GatewayAttributes] Gateway specific attributes associated with this PaymentMethod
-      define_attribute :gateway_attributes, :GatewayAttributes
-
       # @!attribute gateway_code
       #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String

data/lib/recurly/resources/plan.rb

@@ -38,10 +38,6 @@ 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 deleted_at
       #   @return [DateTime] Deleted at
       define_attribute :deleted_at, DateTime
@@ -50,10 +46,6 @@ 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
@@ -78,14 +70,6 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, 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
@@ -119,7 +103,7 @@ module Recurly
       define_attribute :trial_length, Integer
 
       # @!attribute trial_requires_billing_info
-      #   @return [Boolean] Allow free trial subscriptions to be created without billing info.
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
       define_attribute :trial_requires_billing_info, :Boolean
 
       # @!attribute trial_unit

data/lib/recurly/resources/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/resources/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/resources/shipping_address.rb

@@ -19,7 +19,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 created_at

data/lib/recurly/resources/subscription.rb

@@ -14,10 +14,6 @@ module Recurly
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
 
-      # @!attribute active_invoice_id
-      #   @return [String] The invoice ID of the latest invoice created for an active subscription.
-      define_attribute :active_invoice_id, String
-
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOn]] Add-ons
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
@@ -122,10 +118,6 @@ module Recurly
       #   @return [Integer] Subscription quantity
       define_attribute :quantity, Integer
 
-      # @!attribute ramp_intervals
-      #   @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
-      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
-
       # @!attribute remaining_billing_cycles
       #   @return [Integer] The remaining billing cycles in the current term.
       define_attribute :remaining_billing_cycles, Integer
@@ -154,10 +146,6 @@ module Recurly
       #   @return [Float] Estimated total, before tax.
       define_attribute :subtotal, Float
 
-      # @!attribute tax_inclusive
-      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
-      define_attribute :tax_inclusive, :Boolean
-
       # @!attribute terms_and_conditions
       #   @return [String] Terms and conditions
       define_attribute :terms_and_conditions, String

data/lib/recurly/resources/subscription_add_on.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :subscription_id, 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
@@ -51,9 +51,13 @@ module Recurly
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] This is priced in the subscription's currency.
+      #   @return [Float] Supports up to 2 decimal places.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Supports up to 9 decimal places.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute updated_at
       #   @return [DateTime] Updated at
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/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/resources/subscription_change.rb

@@ -18,10 +18,6 @@ module Recurly
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
-      # @!attribute billing_info
-      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
-      define_attribute :billing_info, :SubscriptionChangeBillingInfo
-
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime
@@ -54,18 +50,10 @@ module Recurly
       #   @return [Integer] Subscription quantity
       define_attribute :quantity, Integer
 
-      # @!attribute ramp_intervals
-      #   @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
-      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
-
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String
 
-      # @!attribute setup_fee_revenue_schedule_type
-      #   @return [String] Setup fee revenue schedule type
-      define_attribute :setup_fee_revenue_schedule_type, String
-
       # @!attribute shipping
       #   @return [SubscriptionShipping] Subscription shipping details
       define_attribute :shipping, :SubscriptionShipping
@@ -74,10 +62,6 @@ module Recurly
       #   @return [String] The ID of the subscription that is going to be changed.
       define_attribute :subscription_id, 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 amount
       define_attribute :unit_amount, Float

data/lib/recurly/resources/tax_info.rb

@@ -7,19 +7,15 @@ module Recurly
     class TaxInfo < Resource
 
       # @!attribute rate
-      #   @return [Float] The combined tax rate. Not present when Avalara for Communications is enabled.
+      #   @return [Float] Rate
       define_attribute :rate, Float
 
       # @!attribute region
-      #   @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST. Not present when Avalara for Communications is enabled.
+      #   @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
       define_attribute :region, String
 
-      # @!attribute tax_details
-      #   @return [Array[TaxDetail]] Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
-      define_attribute :tax_details, Array, { :item_type => :TaxDetail }
-
       # @!attribute type
-      #   @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries. Not present when Avalara for Communications is enabled.
+      #   @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
       define_attribute :type, String
     end
   end

data/lib/recurly/resources/tier.rb

@@ -7,8 +7,8 @@ module Recurly
     class Tier < Resource
 
       # @!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/resources/{plan_ramp_pricing.rb → tier_pricing.rb}

@@ -4,15 +4,19 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Resources
-    class PlanRampPricing < Resource
+    class TierPricing < Resource
 
       # @!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/resources/transaction.rb

@@ -18,13 +18,9 @@ module Recurly
       #   @return [String] When processed, result from checking the overall AVS on the transaction.
       define_attribute :avs_check, String
 
-      # @!attribute backup_payment_method_used
-      #   @return [Boolean] Indicates if the transaction was completed using a backup payment
-      define_attribute :backup_payment_method_used, :Boolean
-
       # @!attribute billing_address
-      #   @return [Address]
-      define_attribute :billing_address, :Address
+      #   @return [AddressWithName]
+      define_attribute :billing_address, :AddressWithName
 
       # @!attribute collected_at
       #   @return [DateTime] Collected at, or if not collected yet, the time the transaction was created.
@@ -87,7 +83,7 @@ module Recurly
       define_attribute :invoice, :InvoiceMini
 
       # @!attribute ip_address_country
-      #   @return [String] Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
+      #   @return [String] IP address's country
       define_attribute :ip_address_country, String
 
       # @!attribute ip_address_v4

data/lib/recurly/resources/unique_coupon_code_params.rb

@@ -0,0 +1,26 @@
+# 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 UniqueCouponCodeParams < Resource
+
+      # @!attribute begin_time
+      #   @return [DateTime] The date-time to be included when listing UniqueCouponCodes
+      define_attribute :begin_time, DateTime
+
+      # @!attribute limit
+      #   @return [Integer] The number of UniqueCouponCodes that will be generated
+      define_attribute :limit, Integer
+
+      # @!attribute order
+      #   @return [String] Sort order to list newly generated UniqueCouponCodes (should always be `asc`)
+      define_attribute :order, String
+
+      # @!attribute sort
+      #   @return [String] Sort field to list newly generated UniqueCouponCodes (should always be `created_at`)
+      define_attribute :sort, String
+    end
+  end
+end

data/lib/recurly/resources/usage.rb

@@ -7,7 +7,7 @@ module Recurly
     class Usage < Resource
 
       # @!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 billed_at
@@ -39,7 +39,7 @@ module Recurly
       define_attribute :recording_timestamp, DateTime
 
       # @!attribute tier_type
-      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based).
+      #   @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
@@ -50,6 +50,10 @@ module Recurly
       #   @return [Float] Unit price
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Unit price that can optionally support a sub-cent value.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute updated_at
       #   @return [DateTime] When the usage record was billed on an invoice.
       define_attribute :updated_at, DateTime

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.28.0"
+  VERSION = "4.0.0"
 end