recurly 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1182927b43b3f1815fc6e5fbdc029e655d5310898044087cdaa297e53c3a13ce
-  data.tar.gz: 39fb2a708a7beba058967282ecd06a7713ed2ad62397ce86a73998fdc2f0542c
+  metadata.gz: 99cf91ec895437237664b160b439857ab93cb4912f7e4d694d427ab5982c2ef7
+  data.tar.gz: cfcc67cb06f2ba9205f691037b4d499c9673c96f14a9c94f4c6ed9ad05cc4647
 SHA512:
-  metadata.gz: 62e800e4c9ca3a1802f24bf46801e86e4bece4b462da4f362a49b8c6f93166ed5364cca83c6999b58fad38b3d5a175d6fc75f12d9d5e381b81410017f9c426e7
-  data.tar.gz: 4f5df171887b926abd2142d3b79f43beaee6ec4d17cb2481dfc374a4dbab59b4122fc7df3a7216a7f4ca1b9d1f44080054f3aca47f56c2a379da18d7dd20f342
+  metadata.gz: 70c0e1df17040b1564bd1eaaf550e0e9990dee25a007d011c8c97c3cd90d218fe90ce8d81abeb00bebcc7e893fdd4bad7c44e544875918ae7cca03a737cb2135
+  data.tar.gz: b764eea762df6d3d2e061413d83d885705337cf8587259233f2400d112e0f331076ec5202a04ffeb6846925def2821dc027513865c9fae430e3745f34cffc070

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.2.2
+current_version = 3.3.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/GETTING_STARTED.md

@@ -226,7 +226,7 @@ You can specify up to 10 endpoints through the application. All notifications wi
 be sent to all configured endpoints for your site. 
 
 See our [product docs](https://docs.recurly.com/docs/webhooks) to learn more about webhooks
-and see our [dev docs](https://dev.recurly.com/page/webhooks) to learn about what payloads
+and see our [dev docs](https://developers.recurly.com/pages/webhooks.html) to learn about what payloads
 are available.
 
 Although our API is now JSON, our webhook payloads are still formatted as XML for the time being.

data/README.md

@@ -7,7 +7,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 
 ## Reference Documentation
 
-Getting Started Guide and reference tdocumentation can be found on [rubydoc.info](https://www.rubydoc.info/github/recurly/recurly-client-ruby/).
+Getting Started Guide and reference documentation can be found on [rubydoc.info](https://www.rubydoc.info/github/recurly/recurly-client-ruby/).
 
 ## Contributing
 

data/lib/recurly/client/operations.rb

@@ -262,7 +262,7 @@ module Recurly
     #
     # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
-    # @return [Empty] Acquisition data was succesfully deleted.
+    # @return [Resources::Empty] Acquisition data was succesfully deleted.
     # @example
     #   begin
     #     acquisition = @client.remove_account_acquisition(account_id: account_id)
@@ -380,7 +380,7 @@ module Recurly
     #
     # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
-    # @return [Empty] Billing information deleted
+    # @return [Resources::Empty] Billing information deleted
     # @example
     #   begin
     #     @client.remove_billing_info(account_id: account_id)
@@ -916,7 +916,7 @@ module Recurly
     # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
     # @param shipping_address_id [String] Shipping Address ID.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
-    # @return [Empty] Shipping address deleted.
+    # @return [Resources::Empty] Shipping address deleted.
     # @example
     #   begin
     #     @client.remove_shipping_address(
@@ -1397,6 +1397,12 @@ module Recurly
     # @param state [String] Filter by state.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Pager<Resources::Item>] A list of the site's items.
+    # @example
+    #   items = @client.list_items(limit: 200)
+    #   items.each do |item|
+    #     puts "Item: #{item.code}"
+    #   end
+    #
     def list_items(**options)
       path = interpolate_path("/items")
       pager(path, **options)
@@ -1409,6 +1415,28 @@ module Recurly
     # @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Resources::Item] A new item.
+    # @example
+    #   begin
+    #     item_create = {
+    #       code: item_code,
+    #       name: "Item Name",
+    #       description: "Item Description",
+    #       external_sku: "a35JE-44",
+    #       accounting_code: "item-code-127",
+    #       revenue_schedule_type: "at_range_end",
+    #       custom_fields: [{
+    #         name: "custom-field-1",
+    #         value: "Custom Field 1 value"
+    #       }]
+    #     }
+    #     item = @client.create_item(body: item_create)
+    #     puts "Created Item #{item}"
+    #   rescue Recurly::Errors::ValidationError => e
+    #     # If the request was invalid, you may want to tell your user
+    #     # why. You can find the invalid params and reasons in e.recurly_error.params
+    #     puts "ValidationError: #{e.recurly_error.params}"
+    #   end
+    #
     def create_item(body:, **options)
       path = interpolate_path("/items")
       post(path, body, Requests::ItemCreate, **options)
@@ -1421,6 +1449,16 @@ module Recurly
     # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Resources::Item] An item.
+    # @example
+    #   begin
+    #     item = @client.get_item(item_id: item_id)
+    #     puts "Got Item #{item}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
+    #
     def get_item(item_id:, **options)
       path = interpolate_path("/items/{item_id}", item_id: item_id)
       get(path, **options)
@@ -1434,6 +1472,23 @@ module Recurly
     # @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Resources::Item] The updated item.
+    # @example
+    #   begin
+    #     item_update = {
+    #       name: "New Item Name",
+    #       description: "New Item Description"
+    #     }
+    #     item = @client.update_item(
+    #       item_id: item_id,
+    #       body: item_update
+    #     )
+    #     puts "Updated Item #{item}"
+    #   rescue Recurly::Errors::ValidationError => e
+    #     # If the request was invalid, you may want to tell your user
+    #     # why. You can find the invalid params and reasons in e.recurly_error.params
+    #     puts "ValidationError: #{e.recurly_error.params}"
+    #   end
+    #
     def update_item(item_id:, body:, **options)
       path = interpolate_path("/items/{item_id}", item_id: item_id)
       put(path, body, Requests::ItemUpdate, **options)
@@ -1446,6 +1501,16 @@ module Recurly
     # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Resources::Item] An item.
+    # @example
+    #   begin
+    #     item = @client.deactivate_item(item_id: item_id)
+    #     puts "Deactivated Item #{item}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
+    #
     def deactivate_item(item_id:, **options)
       path = interpolate_path("/items/{item_id}", item_id: item_id)
       delete(path, **options)
@@ -1458,6 +1523,16 @@ module Recurly
     # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     # @return [Resources::Item] An item.
+    # @example
+    #   begin
+    #     item = @client.reactivate_item(item_id: item_id)
+    #     puts "Reactivated Item #{item}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
+    #
     def reactivate_item(item_id:, **options)
       path = interpolate_path("/items/{item_id}/reactivate", item_id: item_id)
       put(path, **options)
@@ -1861,7 +1936,7 @@ module Recurly
     #
     # @param line_item_id [String] Line Item ID.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
-    # @return [Empty] Line item deleted.
+    # @return [Resources::Empty] Line item deleted.
     # @example
     #   begin
     #     @client.remove_line_item(
@@ -2483,6 +2558,18 @@ module Recurly
       put(path, **options)
     end
 
+    # Convert trial subscription
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api documenation}
+    #
+    # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    # @return [Resources::Subscription] A subscription.
+    def convert_trial(subscription_id:, **options)
+      path = interpolate_path("/subscriptions/{subscription_id}/convert_trial", subscription_id: subscription_id)
+      put(path, **options)
+    end
+
     # Fetch a subscription's pending change
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documenation}
@@ -2543,7 +2630,7 @@ module Recurly
     #
     # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
     # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
-    # @return [Empty] Subscription change was deleted.
+    # @return [Resources::Empty] Subscription change was deleted.
     # @example
     #   begin
     #     @client.remove_subscription_change(

data/lib/recurly/errors/api_errors.rb

@@ -35,5 +35,7 @@ module Recurly
     class ValidationError < Errors::APIError; end
 
     class MissingFeatureError < Errors::APIError; end
+
+    class RateLimitedError < Errors::APIError; end
   end
 end

data/lib/recurly/requests/account_acquisition_updatable.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :channel, String
 
       # @!attribute cost
-      #   @return [AccountAcquisitionCost]
+      #   @return [AccountAcquisitionCost] Account balance
       define_attribute :cost, :AccountAcquisitionCost
 
       # @!attribute subchannel

data/lib/recurly/requests/account_create.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 email

data/lib/recurly/requests/account_purchase.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 email

data/lib/recurly/requests/account_update.rb

@@ -27,7 +27,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 email

data/lib/recurly/requests/add_on_create.rb

@@ -7,15 +7,15 @@ module Recurly
     class AddOnCreate < Request
 
       # @!attribute accounting_code
-      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.
+      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `code` must be absent.
       define_attribute :accounting_code, String
 
       # @!attribute code
-      #   @return [String] The unique identifier for the add-on within its plan.
+      #   @return [String] The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] Add-on pricing
+      #   @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.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -26,8 +26,16 @@ module Recurly
       #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
       define_attribute :display_quantity, :Boolean
 
+      # @!attribute item_code
+      #   @return [String] Unique code to identify an item, when the `Catalog: Item Add-Ons` 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] Available when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      define_attribute :item_id, String
+
       # @!attribute name
-      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
       define_attribute :name, String
 
       # @!attribute plan_id
@@ -35,7 +43,7 @@ module Recurly
       define_attribute :plan_id, String
 
       # @!attribute tax_code
-      #   @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`.
+      #   @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`. If `item_code`/`item_id` is part of the request then `code` must be absent.
       define_attribute :tax_code, String
     end
   end

data/lib/recurly/requests/add_on_update.rb

@@ -7,11 +7,11 @@ module Recurly
     class AddOnUpdate < Request
 
       # @!attribute accounting_code
-      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.
+      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.
       define_attribute :accounting_code, String
 
       # @!attribute code
-      #   @return [String] The unique identifier for the add-on within its plan.
+      #   @return [String] The unique identifier for the add-on within its plan. If an `Item` is associated to the `AddOn` then `code` must be absent.
       define_attribute :code, String
 
       # @!attribute currencies
@@ -31,11 +31,11 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute name
-      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
       define_attribute :name, String
 
       # @!attribute tax_code
-      #   @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`.
+      #   @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`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
       define_attribute :tax_code, String
     end
   end

data/lib/recurly/requests/billing_info_create.rb

@@ -30,6 +30,14 @@ module Recurly
       #   @return [String] Fraud Session ID
       define_attribute :fraud_session_id, String
 
+      # @!attribute gateway_code
+      #   @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
+      #   @return [String] A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
+      define_attribute :gateway_token, String
+
       # @!attribute ip_address
       #   @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
       define_attribute :ip_address, String

data/lib/recurly/requests/item_create.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :Pricing }
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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

data/lib/recurly/requests/item_update.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :Pricing }
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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

data/lib/recurly/requests/line_item_create.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Available when the Catalog feature is enabled.
       define_attribute :item_id, String
 
+      # @!attribute origin
+      #   @return [String] Only allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Can only have a value of `external_gift_card`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements.
+      define_attribute :origin, String
+
       # @!attribute product_code
       #   @return [String] Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.
       define_attribute :product_code, String

data/lib/recurly/requests/purchase_create.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :account, :AccountPurchase
 
       # @!attribute collection_method
-      #   @return [String] Collection method
+      #   @return [String] Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
       define_attribute :collection_method, String
 
       # @!attribute coupon_codes

data/lib/recurly/requests/subscription_change_create.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :quantity, Integer
 
       # @!attribute shipping
-      #   @return [SubscriptionChangeShippingCreate]
+      #   @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
       define_attribute :shipping, :SubscriptionChangeShippingCreate
 
       # @!attribute timeframe

data/lib/recurly/requests/subscription_create.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 customer_notes

data/lib/recurly/requests/subscription_purchase.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :auto_renew, :Boolean
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 next_bill_date

data/lib/recurly/requests/subscription_update.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :collection_method, String
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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 customer_notes
@@ -43,7 +43,7 @@ module Recurly
       define_attribute :renewal_billing_cycles, Integer
 
       # @!attribute shipping
-      #   @return [SubscriptionShippingUpdate]
+      #   @return [SubscriptionShippingUpdate] Subscription shipping details
       define_attribute :shipping, :SubscriptionShippingUpdate
 
       # @!attribute terms_and_conditions

data/lib/recurly/resources/account.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :created_at, DateTime
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @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
@@ -54,6 +54,30 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute has_active_subscription
+      #   @return [Boolean] Indicates if the account has an active subscription.
+      define_attribute :has_active_subscription, :Boolean
+
+      # @!attribute has_canceled_subscription
+      #   @return [Boolean] Indicates if the account has a canceled subscription.
+      define_attribute :has_canceled_subscription, :Boolean
+
+      # @!attribute has_future_subscription
+      #   @return [Boolean] Indicates if the account has a future subscription.
+      define_attribute :has_future_subscription, :Boolean
+
+      # @!attribute has_live_subscription
+      #   @return [Boolean] Indicates if the account has a subscription that is either active, canceled, future, or paused.
+      define_attribute :has_live_subscription, :Boolean
+
+      # @!attribute has_past_due_invoice
+      #   @return [Boolean] Indicates if the account has a past due invoice.
+      define_attribute :has_past_due_invoice, :Boolean
+
+      # @!attribute has_paused_subscription
+      #   @return [Boolean] Indicates if the account has a paused subscription.
+      define_attribute :has_paused_subscription, :Boolean
+
       # @!attribute hosted_login_token
       #   @return [String] The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `https://{subdomain}.recurly.com/account/{hosted_login_token}`.
       define_attribute :hosted_login_token, String