Class: Recurly::Requests::AccountPurchase

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/account_purchase.rb

Instance Attribute Summary collapse

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#acquisition ⇒ AccountAcquisitionUpdate

Returns:



11
 
# File 'lib/recurly/requests/account_purchase.rb', line 11

define_attribute :acquisition, :AccountAcquisitionUpdate

#address ⇒ Address

Returns:



15
 
# File 'lib/recurly/requests/account_purchase.rb', line 15

define_attribute :address, :Address

#bill_to ⇒ String

Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

Returns:

  • (String) —

    An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.



19
 
# File 'lib/recurly/requests/account_purchase.rb', line 19

define_attribute :bill_to, String

#billing_info ⇒ BillingInfoCreate

Returns:



23
 
# File 'lib/recurly/requests/account_purchase.rb', line 23

define_attribute :billing_info, :BillingInfoCreate

#cc_emails ⇒ String

Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

Returns:

  • (String) —

    Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.



27
 
# File 'lib/recurly/requests/account_purchase.rb', line 27

define_attribute :cc_emails, String

#code ⇒ String

Returns The unique identifier of the account. This cannot be changed once the account is created.

Returns:

  • (String) —

    The unique identifier of the account. This cannot be changed once the account is created.



31
 
# File 'lib/recurly/requests/account_purchase.rb', line 31

define_attribute :code, String

#company ⇒ String

Returns:

  • (String) 


35
 
# File 'lib/recurly/requests/account_purchase.rb', line 35

define_attribute :company, String

#custom_fields ⇒ Array[CustomField]

Returns 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.

Returns:

  • (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.



39
 
# File 'lib/recurly/requests/account_purchase.rb', line 39

define_attribute :custom_fields, Array, { :item_type => :CustomField }

#dunning_campaign_id ⇒ String

Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

Returns:

  • (String) —

    Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.



43
 
# File 'lib/recurly/requests/account_purchase.rb', line 43

define_attribute :dunning_campaign_id, String

#email ⇒ String

Returns 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.

Returns:

  • (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.



47
 
# File 'lib/recurly/requests/account_purchase.rb', line 47

define_attribute :email, String

#entity_use_code ⇒ String

Returns 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.

Returns:

  • (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.



51
 
# File 'lib/recurly/requests/account_purchase.rb', line 51

define_attribute :entity_use_code, String

#exemption_certificate ⇒ String

Returns 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.

Returns:

  • (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.



55
 
# File 'lib/recurly/requests/account_purchase.rb', line 55

define_attribute :exemption_certificate, String

#first_name ⇒ String

Returns:

  • (String) 


59
 
# File 'lib/recurly/requests/account_purchase.rb', line 59

define_attribute :first_name, String

#id ⇒ String

Returns Optional, but if present allows an existing account to be used and updated as part of the purchase.

Returns:

  • (String) —

    Optional, but if present allows an existing account to be used and updated as part of the purchase.



63
 
# File 'lib/recurly/requests/account_purchase.rb', line 63

define_attribute :id, String

#invoice_template_id ⇒ String

Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.

Returns:

  • (String) —

    Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.



67
 
# File 'lib/recurly/requests/account_purchase.rb', line 67

define_attribute :invoice_template_id, String

#last_name ⇒ String

Returns:

  • (String) 


71
 
# File 'lib/recurly/requests/account_purchase.rb', line 71

define_attribute :last_name, String

#override_business_entity_id ⇒ String

Returns Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.

Returns:

  • (String) —

    Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.



75
 
# File 'lib/recurly/requests/account_purchase.rb', line 75

define_attribute :override_business_entity_id, String

#parent_account_code ⇒ String

Returns The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.

Returns:

  • (String) —

    The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.



79
 
# File 'lib/recurly/requests/account_purchase.rb', line 79

define_attribute :parent_account_code, String

#parent_account_id ⇒ String

Returns The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.

Returns:

  • (String) —

    The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.



83
 
# File 'lib/recurly/requests/account_purchase.rb', line 83

define_attribute :parent_account_id, String

#preferred_locale ⇒ String

Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.

Returns:

  • (String) —

    Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.



87
 
# File 'lib/recurly/requests/account_purchase.rb', line 87

define_attribute :preferred_locale, String

#preferred_time_zone ⇒ String

Returns Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names).

Returns:



91
 
# File 'lib/recurly/requests/account_purchase.rb', line 91

define_attribute :preferred_time_zone, String

#tax_exempt ⇒ Boolean

Returns The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

Returns:

  • (Boolean) —

    The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.



95
 
# File 'lib/recurly/requests/account_purchase.rb', line 95

define_attribute :tax_exempt, :Boolean

#transaction_type ⇒ String

Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

Returns:

  • (String) —

    An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.



99
 
# File 'lib/recurly/requests/account_purchase.rb', line 99

define_attribute :transaction_type, String

#username ⇒ String

Returns A secondary value for the account.

Returns:

  • (String) —

    A secondary value for the account.



103
 
# File 'lib/recurly/requests/account_purchase.rb', line 103

define_attribute :username, String

#vat_number ⇒ String

Returns The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

Returns:

  • (String) —

    The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.



107
 
# File 'lib/recurly/requests/account_purchase.rb', line 107

define_attribute :vat_number, String