maxio-advanced-billing-sdk 5.0.0 → 5.2.0

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -11,7 +11,7 @@ module AdvancedBilling
     # Subscription's open, payable invoices.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [AccountBalances] response from the API call
+    # @return [AccountBalances] response from the API call.
     def read_account_balances(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -39,7 +39,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CreatePrepaymentRequest] body Optional parameter: Example:
-    # @return [CreatePrepaymentResponse] response from the API call
+    # @return [CreatePrepaymentResponse] response from the API call.
     def create_prepayment(subscription_id,
                           body: nil)
       new_api_call_builder
@@ -80,7 +80,7 @@ module AdvancedBilling
     # Use in query `per_page=200`.
     # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
     # for List Prepayments operations
-    # @return [PrepaymentsResponse] response from the API call
+    # @return [PrepaymentsResponse] response from the API call.
     def list_prepayments(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -110,7 +110,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [IssueServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCredit] response from the API call
+    # @return [ServiceCredit] response from the API call.
     def issue_service_credit(subscription_id,
                              body: nil)
       new_api_call_builder
@@ -141,7 +141,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [DeductServiceCreditRequest] body Optional parameter: Example:
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def deduct_service_credit(subscription_id,
                               body: nil)
       new_api_call_builder
@@ -174,7 +174,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] prepayment_id Required parameter: id of prepayment
     # @param [RefundPrepaymentRequest] body Optional parameter: Example:
-    # @return [PrepaymentResponse] response from the API call
+    # @return [PrepaymentResponse] response from the API call.
     def refund_prepayment(subscription_id,
                           prepayment_id,
                           body: nil)

data/lib/advanced_billing/controllers/subscription_notes_controller.rb

@@ -19,7 +19,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def create_subscription_note(subscription_id,
                                  body: nil)
       new_api_call_builder
@@ -55,7 +55,7 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 20. The maximum
     # allowed values is 200; any per_page value over 200 will be changed to 200.
     # Use in query `per_page=200`.
-    # @return [Array[SubscriptionNoteResponse]] response from the API call
+    # @return [Array[SubscriptionNoteResponse]] response from the API call.
     def list_subscription_notes(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -81,7 +81,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def read_subscription_note(subscription_id,
                                note_id)
       new_api_call_builder
@@ -108,7 +108,7 @@ module AdvancedBilling
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
     # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def update_subscription_note(subscription_id,
                                  note_id,
                                  body: nil)
@@ -138,7 +138,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def delete_subscription_note(subscription_id,
                                  note_id)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscription_products_controller.rb

@@ -103,7 +103,7 @@ module AdvancedBilling
     # the subscription
     # @param [SubscriptionProductMigrationRequest] body Optional parameter:
     # Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def migrate_subscription_product(subscription_id,
                                      body: nil)
       new_api_call_builder
@@ -140,7 +140,7 @@ module AdvancedBilling
     # the subscription
     # @param [SubscriptionMigrationPreviewRequest] body Optional parameter:
     # Example:
-    # @return [SubscriptionMigrationPreviewResponse] response from the API call
+    # @return [SubscriptionMigrationPreviewResponse] response from the API call.
     def preview_subscription_product_migration(subscription_id,
                                                body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscription_status_controller.rb

@@ -14,7 +14,7 @@ module AdvancedBilling
     # The response will be `422 "Unprocessable Entity`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def retry_subscription(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -40,7 +40,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def cancel_subscription(subscription_id,
                             body: nil)
       new_api_call_builder
@@ -77,7 +77,7 @@ module AdvancedBilling
     # @param [ResumptionCharge] calendar_billing_resumption_charge Optional
     # parameter: (For calendar billing subscriptions only) The way that the
     # resumed subscription's charge should be handled
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def resume_subscription(subscription_id,
                             calendar_billing_resumption_charge: ResumptionCharge::PRORATED)
       new_api_call_builder
@@ -108,7 +108,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def pause_subscription(subscription_id,
                            body: nil)
       new_api_call_builder
@@ -143,7 +143,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def update_automatic_subscription_resumption(subscription_id,
                                                  body: nil)
       new_api_call_builder
@@ -309,7 +309,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [ReactivateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def reactivate_subscription(subscription_id,
                                 body: nil)
       new_api_call_builder
@@ -343,7 +343,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [DelayedCancellationResponse] response from the API call
+    # @return [DelayedCancellationResponse] response from the API call.
     def initiate_delayed_cancellation(subscription_id,
                                       body: nil)
       new_api_call_builder
@@ -375,7 +375,7 @@ module AdvancedBilling
     # will be successful.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [DelayedCancellationResponse] response from the API call
+    # @return [DelayedCancellationResponse] response from the API call.
     def cancel_delayed_cancellation(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -399,7 +399,7 @@ module AdvancedBilling
     # active and the active Dunner will be resolved.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def cancel_dunning(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -451,7 +451,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [RenewalPreviewRequest] body Optional parameter: Example:
-    # @return [RenewalPreviewResponse] response from the API call
+    # @return [RenewalPreviewResponse] response from the API call.
     def preview_renewal(subscription_id,
                         body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscriptions_controller.rb

@@ -795,7 +795,7 @@ module AdvancedBilling
     #   }
     # ```
     # @param [CreateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def create_subscription(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -881,7 +881,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionListInclude]] include Optional parameter: Allows
     # including additional data in the response. Use in query:
     # `include[]=self_service_page_token`.
-    # @return [Array[SubscriptionResponse]] response from the API call
+    # @return [Array[SubscriptionResponse]] response from the API call.
     def list_subscriptions(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -977,7 +977,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [UpdateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def update_subscription(subscription_id,
                             body: nil)
       new_api_call_builder
@@ -1012,7 +1012,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionInclude]] include Optional parameter: Allows
     # including additional data in the response. Use in query:
     # `include[]=coupons&include[]=self_service_page_token`.
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def read_subscription(subscription_id,
                           include: nil)
       new_api_call_builder
@@ -1068,7 +1068,7 @@ module AdvancedBilling
     # the subscription
     # @param [OverrideSubscriptionRequest] body Optional parameter: Only these
     # fields are available to be set.
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def override_subscription(subscription_id,
                               body: nil)
       new_api_call_builder
@@ -1093,7 +1093,7 @@ module AdvancedBilling
 
     # Use this endpoint to find a subscription by its reference.
     # @param [String] reference Optional parameter: Subscription reference
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def find_subscription(reference: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -1125,7 +1125,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionPurgeType]] cascade Optional parameter: Options
     # are "customer" or "payment_profile". Use in query:
     # `cascade[]=customer&cascade[]=payment_profile`.
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def purge_subscription(subscription_id,
                            ack,
                            cascade: nil)
@@ -1151,7 +1151,7 @@ module AdvancedBilling
     # the subscription
     # @param [UpsertPrepaidConfigurationRequest] body Optional parameter:
     # Example:
-    # @return [PrepaidConfigurationResponse] response from the API call
+    # @return [PrepaidConfigurationResponse] response from the API call.
     def update_prepaid_subscription_configuration(subscription_id,
                                                   body: nil)
       new_api_call_builder
@@ -1208,7 +1208,7 @@ module AdvancedBilling
     # If you'd like to calculate subscriptions that do not include tax, please
     # feel free to leave off the billing information.
     # @param [CreateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionPreviewResponse] response from the API call
+    # @return [SubscriptionPreviewResponse] response from the API call.
     def preview_subscription(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -1243,7 +1243,7 @@ module AdvancedBilling
     # @param [String] code Optional parameter: A code for the coupon that would
     # be applied to a subscription
     # @param [AddCouponsRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def apply_coupons_to_subscription(subscription_id,
                                       code: nil,
                                       body: nil)
@@ -1278,7 +1278,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [String] coupon_code Optional parameter: The coupon code
-    # @return [String] response from the API call
+    # @return [String] response from the API call.
     def remove_coupon_from_subscription(subscription_id,
                                         coupon_code: nil)
       new_api_call_builder
@@ -1355,7 +1355,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [ActivateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def activate_subscription(subscription_id,
                               body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/webhooks_controller.rb

@@ -53,7 +53,7 @@ module AdvancedBilling
     # Webhooks are returned.
     # @param [Integer] subscription Optional parameter: The Advanced Billing id
     # of a subscription you'd like to filter for
-    # @return [Array[WebhookResponse]] response from the API call
+    # @return [Array[WebhookResponse]] response from the API call.
     def list_webhooks(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -77,7 +77,7 @@ module AdvancedBilling
 
     # This method allows you to enable webhooks via API for your site
     # @param [EnableWebhooksRequest] body Optional parameter: Example:
-    # @return [EnableWebhooksResponse] response from the API call
+    # @return [EnableWebhooksResponse] response from the API call.
     def enable_webhooks(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -100,7 +100,7 @@ module AdvancedBilling
     # You may submit an array of up to 1000 webhook IDs to replay in the
     # request.
     # @param [ReplayWebhooksRequest] body Optional parameter: Example:
-    # @return [ReplayWebhooksResponse] response from the API call
+    # @return [ReplayWebhooksResponse] response from the API call.
     def replay_webhooks(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -124,7 +124,7 @@ module AdvancedBilling
     # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
     # Reference#events)
     # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
-    # @return [EndpointResponse] response from the API call
+    # @return [EndpointResponse] response from the API call.
     def create_endpoint(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -146,7 +146,7 @@ module AdvancedBilling
     end
 
     # This method returns created endpoints for site.
-    # @return [Array[Endpoint]] response from the API call
+    # @return [Array[Endpoint]] response from the API call.
     def list_endpoints
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -176,7 +176,7 @@ module AdvancedBilling
     # @param [Integer] endpoint_id Required parameter: The Advanced Billing id
     # for the endpoint that should be updated
     # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
-    # @return [EndpointResponse] response from the API call
+    # @return [EndpointResponse] response from the API call.
     def update_endpoint(endpoint_id,
                         body: nil)
       new_api_call_builder

data/lib/advanced_billing/models/cancellation_method.rb

@@ -21,7 +21,10 @@ module AdvancedBilling
       BILLING_PORTAL = 'billing_portal'.freeze,
 
       # TODO: Write general description for UNKNOWN
-      UNKNOWN = 'unknown'.freeze
+      UNKNOWN = 'unknown'.freeze,
+
+      # TODO: Write general description for IMPORTED
+      IMPORTED = 'imported'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/advanced_billing/models/create_invoice_payment.rb

@@ -13,7 +13,8 @@ module AdvancedBilling
     # @return [Object]
     attr_accessor :amount
 
-    # A description to be attached to the payment.
+    # A description to be attached to the payment. Applicable only to `external`
+    # payments.
     # @return [String]
     attr_accessor :memo
 
@@ -21,7 +22,8 @@ module AdvancedBilling
     # @return [InvoicePaymentMethodType]
     attr_accessor :method
 
-    # Additional information related to the payment method (eg. Check #)
+    # Additional information related to the payment method (eg. Check #).
+    # Applicable only to `external` payments.
     # @return [String]
     attr_accessor :details
 
@@ -29,6 +31,12 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :payment_profile_id
 
+    # Date reflecting when the payment was received from a customer. Must be in
+    # the past. Applicable only to 
+    # `external` payments.
+    # @return [Date]
+    attr_accessor :received_on
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -37,6 +45,7 @@ module AdvancedBilling
       @_hash['method'] = 'method'
       @_hash['details'] = 'details'
       @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['received_on'] = 'received_on'
       @_hash
     end
 
@@ -48,6 +57,7 @@ module AdvancedBilling
         method
         details
         payment_profile_id
+        received_on
       ]
     end
 
@@ -57,12 +67,14 @@ module AdvancedBilling
     end
 
     def initialize(amount: SKIP, memo: SKIP, method: SKIP, details: SKIP,
-                   payment_profile_id: SKIP, additional_properties: {})
+                   payment_profile_id: SKIP, received_on: SKIP,
+                   additional_properties: {})
       @amount = amount unless amount == SKIP
       @memo = memo unless memo == SKIP
       @method = method unless method == SKIP
       @details = details unless details == SKIP
       @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @received_on = received_on unless received_on == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -83,6 +95,7 @@ module AdvancedBilling
       details = hash.key?('details') ? hash['details'] : SKIP
       payment_profile_id =
         hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      received_on = hash.key?('received_on') ? hash['received_on'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -93,6 +106,7 @@ module AdvancedBilling
                                method: method,
                                details: details,
                                payment_profile_id: payment_profile_id,
+                               received_on: received_on,
                                additional_properties: hash)
     end
 

data/lib/advanced_billing/models/customer.rb

@@ -85,8 +85,7 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :phone
 
-    # Is the customer verified to use ACH as a payment method. Available only on
-    # Authorize.Net gateway
+    # Is the customer verified to use ACH as a payment method.
     # @return [TrueClass | FalseClass]
     attr_accessor :verified
 
@@ -133,6 +132,14 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :salesforce_id
 
+    # The Tax Exemption Reason Code for the customer
+    # @return [String]
+    attr_accessor :tax_exempt_reason
+
+    # The default auto-renewal profile ID for the customer
+    # @return [Integer]
+    attr_accessor :default_auto_renewal_profile_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -166,6 +173,9 @@ module AdvancedBilling
       @_hash['default_subscription_group_uid'] =
         'default_subscription_group_uid'
       @_hash['salesforce_id'] = 'salesforce_id'
+      @_hash['tax_exempt_reason'] = 'tax_exempt_reason'
+      @_hash['default_auto_renewal_profile_id'] =
+        'default_auto_renewal_profile_id'
       @_hash
     end
 
@@ -200,6 +210,8 @@ module AdvancedBilling
         locale
         default_subscription_group_uid
         salesforce_id
+        tax_exempt_reason
+        default_auto_renewal_profile_id
       ]
     end
 
@@ -227,6 +239,8 @@ module AdvancedBilling
         locale
         default_subscription_group_uid
         salesforce_id
+        tax_exempt_reason
+        default_auto_renewal_profile_id
       ]
     end
 
@@ -240,6 +254,8 @@ module AdvancedBilling
                    portal_invite_last_accepted_at: SKIP, tax_exempt: SKIP,
                    vat_number: SKIP, parent_id: SKIP, locale: SKIP,
                    default_subscription_group_uid: SKIP, salesforce_id: SKIP,
+                   tax_exempt_reason: SKIP,
+                   default_auto_renewal_profile_id: SKIP,
                    additional_properties: {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -281,6 +297,11 @@ module AdvancedBilling
           default_subscription_group_uid
       end
       @salesforce_id = salesforce_id unless salesforce_id == SKIP
+      @tax_exempt_reason = tax_exempt_reason unless tax_exempt_reason == SKIP
+      unless default_auto_renewal_profile_id == SKIP
+        @default_auto_renewal_profile_id =
+          default_auto_renewal_profile_id
+      end
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -342,6 +363,10 @@ module AdvancedBilling
       default_subscription_group_uid =
         hash.key?('default_subscription_group_uid') ? hash['default_subscription_group_uid'] : SKIP
       salesforce_id = hash.key?('salesforce_id') ? hash['salesforce_id'] : SKIP
+      tax_exempt_reason =
+        hash.key?('tax_exempt_reason') ? hash['tax_exempt_reason'] : SKIP
+      default_auto_renewal_profile_id =
+        hash.key?('default_auto_renewal_profile_id') ? hash['default_auto_renewal_profile_id'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -375,6 +400,8 @@ module AdvancedBilling
                    locale: locale,
                    default_subscription_group_uid: default_subscription_group_uid,
                    salesforce_id: salesforce_id,
+                   tax_exempt_reason: tax_exempt_reason,
+                   default_auto_renewal_profile_id: default_auto_renewal_profile_id,
                    additional_properties: hash)
     end
 

data/lib/advanced_billing/models/customer_attributes.rb

@@ -105,6 +105,10 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :salesforce_id
 
+    # (Optional) The default auto-renewal profile ID for the customer
+    # @return [Integer]
+    attr_accessor :default_auto_renewal_profile_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -127,6 +131,8 @@ module AdvancedBilling
       @_hash['metafields'] = 'metafields'
       @_hash['parent_id'] = 'parent_id'
       @_hash['salesforce_id'] = 'salesforce_id'
+      @_hash['default_auto_renewal_profile_id'] =
+        'default_auto_renewal_profile_id'
       @_hash
     end
 
@@ -152,6 +158,7 @@ module AdvancedBilling
         metafields
         parent_id
         salesforce_id
+        default_auto_renewal_profile_id
       ]
     end
 
@@ -161,6 +168,7 @@ module AdvancedBilling
         address_2
         parent_id
         salesforce_id
+        default_auto_renewal_profile_id
       ]
     end
 
@@ -170,6 +178,7 @@ module AdvancedBilling
                    zip: SKIP, country: SKIP, phone: SKIP, verified: SKIP,
                    tax_exempt: SKIP, vat_number: SKIP, metafields: SKIP,
                    parent_id: SKIP, salesforce_id: SKIP,
+                   default_auto_renewal_profile_id: SKIP,
                    additional_properties: {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -190,6 +199,10 @@ module AdvancedBilling
       @metafields = metafields unless metafields == SKIP
       @parent_id = parent_id unless parent_id == SKIP
       @salesforce_id = salesforce_id unless salesforce_id == SKIP
+      unless default_auto_renewal_profile_id == SKIP
+        @default_auto_renewal_profile_id =
+          default_auto_renewal_profile_id
+      end
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -221,6 +234,8 @@ module AdvancedBilling
       metafields = hash.key?('metafields') ? hash['metafields'] : SKIP
       parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
       salesforce_id = hash.key?('salesforce_id') ? hash['salesforce_id'] : SKIP
+      default_auto_renewal_profile_id =
+        hash.key?('default_auto_renewal_profile_id') ? hash['default_auto_renewal_profile_id'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -245,6 +260,7 @@ module AdvancedBilling
                              metafields: metafields,
                              parent_id: parent_id,
                              salesforce_id: salesforce_id,
+                             default_auto_renewal_profile_id: default_auto_renewal_profile_id,
                              additional_properties: hash)
     end