recurly 3.28.0 → 3.29.1

data/lib/recurly/errors/api_errors.rb

@@ -21,67 +21,36 @@ module Recurly
     }
 
     class ResponseError < Errors::APIError; end
-
     class ServerError < ResponseError; end
-
     class InternalServerError < ServerError; end
-
     class ServiceNotAvailableError < InternalServerError; end
-
     class TaxServiceError < InternalServerError; end
-
     class BadGatewayError < ServerError; end
-
     class ServiceUnavailableError < ServerError; end
-
     class RedirectionError < ResponseError; end
-
     class NotModifiedError < ResponseError; end
-
     class ClientError < Errors::APIError; end
-
     class BadRequestError < ClientError; end
-
     class InvalidContentTypeError < BadRequestError; end
-
     class UnauthorizedError < ClientError; end
-
     class PaymentRequiredError < ClientError; end
-
     class ForbiddenError < ClientError; end
-
     class InvalidApiKeyError < ForbiddenError; end
-
     class InvalidPermissionsError < ForbiddenError; end
-
     class NotFoundError < ClientError; end
-
     class NotAcceptableError < ClientError; end
-
     class UnknownApiVersionError < NotAcceptableError; end
-
     class UnavailableInApiVersionError < NotAcceptableError; end
-
     class InvalidApiVersionError < NotAcceptableError; end
-
     class PreconditionFailedError < ClientError; end
-
     class UnprocessableEntityError < ClientError; end
-
     class ValidationError < UnprocessableEntityError; end
-
     class MissingFeatureError < UnprocessableEntityError; end
-
     class TransactionError < UnprocessableEntityError; end
-
     class SimultaneousRequestError < UnprocessableEntityError; end
-
     class ImmutableSubscriptionError < UnprocessableEntityError; end
-
     class InvalidTokenError < UnprocessableEntityError; end
-
     class TooManyRequestsError < ClientError; end
-
     class RateLimitedError < TooManyRequestsError; end
   end
 end

data/lib/recurly/requests/account_create.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/account_purchase.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/account_update.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/add_on_create.rb

@@ -71,7 +71,7 @@ module Recurly
       define_attribute :revenue_schedule_type, 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`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
+      #   @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. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
       define_attribute :tax_code, String
 
       # @!attribute tier_type

data/lib/recurly/requests/add_on_update.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :revenue_schedule_type, 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`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
+      #   @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. If an `Item` is associated to the `AddOn` then `tax_code` must be absent.
       define_attribute :tax_code, String
 
       # @!attribute tiers

data/lib/recurly/requests/address.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @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/billing_info_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @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
@@ -51,7 +55,7 @@ module Recurly
       define_attribute :gateway_attributes, :GatewayAttributes
 
       # @!attribute gateway_code
-      #   @return [String] An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
+      #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String
 
       # @!attribute gateway_token
@@ -90,6 +94,10 @@ module Recurly
       #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
+      # @!attribute 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
@@ -98,6 +106,10 @@ module Recurly
       #   @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

data/lib/recurly/requests/billing_info_verify.rb

@@ -9,6 +9,10 @@ module Recurly
       # @!attribute gateway_code
       #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
     end
   end
 end

data/lib/recurly/requests/billing_info_verify_cvv.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 Requests
+    class BillingInfoVerifyCVV < Request
+
+      # @!attribute gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, String
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+
+      # @!attribute token_id
+      #   @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
+      define_attribute :token_id, String
+
+      # @!attribute verification_value
+      #   @return [String] Unique security code for a credit card.
+      define_attribute :verification_value, String
+    end
+  end
+end

data/lib/recurly/requests/credit_application_policy.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class CreditApplicationPolicy < Request
+
+      # @!attribute allowed_origins
+      #   @return [Array[String]] Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`.
+      define_attribute :allowed_origins, Array, { :item_type => String }
+
+      # @!attribute mode
+      #   @return [String]
+      define_attribute :mode, String
+    end
+  end
+end

data/lib/recurly/requests/custom_field.rb

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

@@ -7,7 +7,7 @@ module Recurly
     class GatewayAttributes < Request
 
       # @!attribute account_reference
-      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end

data/lib/recurly/requests/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @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_create.rb

@@ -14,6 +14,10 @@ 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
@@ -23,7 +27,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
@@ -37,6 +41,10 @@ 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/item_create.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tax_code
-      #   @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`.
+      #   @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.
       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] 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`.
+      #   @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.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/requests/line_item_create.rb

@@ -67,7 +67,7 @@ module Recurly
       define_attribute :start_date, DateTime
 
       # @!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 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.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -85,6 +85,10 @@ 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/plan_create.rb

@@ -87,7 +87,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 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 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.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/requests/plan_update.rb

@@ -75,7 +75,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 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 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.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/requests/purchase_create.rb

@@ -22,6 +22,10 @@ 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
@@ -73,6 +77,10 @@ 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

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

@@ -26,6 +26,10 @@ 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_create.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
       define_attribute :billing_info_id, String
 
+      # @!attribute bulk
+      #   @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
+      define_attribute :bulk, :Boolean
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String
@@ -30,6 +34,10 @@ module Recurly
       #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
       define_attribute :coupon_code, String
 
+      # @!attribute 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] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
       define_attribute :credit_customer_notes, String
@@ -87,7 +95,7 @@ module Recurly
       define_attribute :shipping, :SubscriptionShippingCreate
 
       # @!attribute starts_at
-      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      #   @return [DateTime] If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. Omit this field if the subscription should be started immediately.
       define_attribute :starts_at, DateTime
 
       # @!attribute tax_inclusive
@@ -113,6 +121,10 @@ module Recurly
       # @!attribute unit_amount
       #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
       define_attribute :unit_amount, Float
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] This will default to the VAT reverse charge notes text specified on the Invoice Settings. Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :vat_reverse_charge_notes, String
     end
   end
 end

data/lib/recurly/requests/subscription_purchase.rb

@@ -14,10 +14,22 @@ module Recurly
       #   @return [Boolean] Whether the subscription renews at the end of its term.
       define_attribute :auto_renew, :Boolean
 
+      # @!attribute bulk
+      #   @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
+      define_attribute :bulk, :Boolean
+
+      # @!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 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 customer_notes
+      #   @return [String] Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :customer_notes, String
+
       # @!attribute next_bill_date
       #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
       define_attribute :next_bill_date, DateTime
@@ -51,13 +63,17 @@ module Recurly
       define_attribute :shipping, :SubscriptionShippingPurchase
 
       # @!attribute starts_at
-      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      #   @return [DateTime] If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
       define_attribute :starts_at, DateTime
 
       # @!attribute tax_inclusive
       #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
       define_attribute :tax_inclusive, :Boolean
 
+      # @!attribute terms_and_conditions
+      #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      define_attribute :terms_and_conditions, String
+
       # @!attribute total_billing_cycles
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer
@@ -69,6 +85,10 @@ module Recurly
       # @!attribute unit_amount
       #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
       define_attribute :unit_amount, Float
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :vat_reverse_charge_notes, String
     end
   end
 end

data/lib/recurly/requests/subscription_update.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] Change collection method
       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 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 }
@@ -61,6 +65,10 @@ module Recurly
       # @!attribute terms_and_conditions
       #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
       define_attribute :terms_and_conditions, String
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :vat_reverse_charge_notes, String
     end
   end
 end

data/lib/recurly/resources/account.rb

@@ -50,6 +50,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/resources/add_on.rb

@@ -87,7 +87,7 @@ module Recurly
       define_attribute :state, String
 
       # @!attribute tax_code
-      #   @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`.
+      #   @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. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
       define_attribute :tax_code, String
 
       # @!attribute tier_type

data/lib/recurly/resources/address.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @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/resources/credit_application_policy.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class CreditApplicationPolicy < Resource
+
+      # @!attribute allowed_origins
+      #   @return [Array[String]] Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`.
+      define_attribute :allowed_origins, Array, { :item_type => String }
+
+      # @!attribute mode
+      #   @return [String]
+      define_attribute :mode, String
+    end
+  end
+end

data/lib/recurly/resources/custom_field.rb

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

@@ -7,7 +7,7 @@ module Recurly
     class GatewayAttributes < Resource
 
       # @!attribute account_reference
-      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end