RecurlyClient.Types.Account

Contains the types generated from the schema Account

Documentation

data Account

Defines the object schema located at components.schemas.Account.allOf in the specification.

Constructors

Account

Fields

• accountAddress :: Maybe Address

  address

• accountBill_to :: Maybe AccountBill_to

  bill_to: 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.

  Constraints:

  • Maximum length of 6
• accountBilling_info :: Maybe BillingInfo

  billing_info

• accountCc_emails :: Maybe Text

  cc_emails: 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.

  Constraints:

  • Maximum length of 255
• accountCode :: Maybe Text

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

  Constraints:

  • Maximum length of 50
• accountCompany :: Maybe Text

  company

  Constraints:

  • Maximum length of 50
• accountCreated_at :: Maybe JsonDateTime

  created_at: When the account was created.

• accountCustom_fields :: Maybe CustomFields

  custom_fields: 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.

• accountDeleted_at :: Maybe JsonDateTime

  deleted_at: If present, when the account was last marked inactive.

• accountDunning_campaign_id :: Maybe Text

  dunning_campaign_id: 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.

• accountEmail :: Maybe Text

  email: 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.

  Constraints:

  • Maximum length of 255
• accountEntity_use_code :: Maybe Text

  entity_use_code: 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.

• accountExemption_certificate :: Maybe Text

  exemption_certificate: 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.

  Constraints:

  • Maximum length of 30
• accountExternal_accounts :: Maybe [ExternalAccount]

  external_accounts: The external accounts belonging to this account

• accountFirst_name :: Maybe Text

  first_name

  Constraints:

  • Maximum length of 255
• accountHas_active_subscription :: Maybe Bool

  has_active_subscription: Indicates if the account has an active subscription.

• accountHas_canceled_subscription :: Maybe Bool

  has_canceled_subscription: Indicates if the account has a canceled subscription.

• accountHas_future_subscription :: Maybe Bool

  has_future_subscription: Indicates if the account has a future subscription.

• accountHas_live_subscription :: Maybe Bool

  has_live_subscription: Indicates if the account has a subscription that is either active, canceled, future, or paused.

• accountHas_past_due_invoice :: Maybe Bool

  has_past_due_invoice: Indicates if the account has a past due invoice.

• accountHas_paused_subscription :: Maybe Bool

  has_paused_subscription: Indicates if the account has a paused subscription.

• accountHosted_login_token :: Maybe Text

  hosted_login_token: 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}`.

  Constraints:

  • Maximum length of 32
• accountId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• accountInvoice_template_id :: Maybe Text

  invoice_template_id: Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.

• accountLast_name :: Maybe Text

  last_name

  Constraints:

  • Maximum length of 255
• accountObject :: Maybe Text

  object

• accountOverride_business_entity_id :: Maybe Text

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

• accountParent_account_id :: Maybe Text

  parent_account_id: The UUID of the parent account associated with this account.

  Constraints:

  • Maximum length of 13
• accountPreferred_locale :: Maybe AccountPreferred_locale

  preferred_locale: Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

• accountPreferred_time_zone :: Maybe Text

  preferred_time_zone: The IANA time zone name used to determine the time zone of emails sent on behalf of the merchant to the customer.

• accountShipping_addresses :: Maybe [ShippingAddress]

  shipping_addresses: The shipping addresses on the account.

• accountState :: Maybe AccountState

  state: Accounts can be either active or inactive.

• accountTax_exempt :: Maybe Bool

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

• accountUpdated_at :: Maybe JsonDateTime

  updated_at: When the account was last changed.

• accountUsername :: Maybe Text

  username: A secondary value for the account.

  Constraints:

  • Maximum length of 255
• accountVat_number :: Maybe Text

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

  Constraints:

  • Maximum length of 20

Instances

FromJSON Account

Defined in RecurlyClient.Types.Account

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

ToJSON Account

Defined in RecurlyClient.Types.Account

Methods

toJSON :: Account -> Value

toEncoding :: Account -> Encoding

toJSONList :: [Account] -> Value

toEncodingList :: [Account] -> Encoding

Show Account

Defined in RecurlyClient.Types.Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

Eq Account

Defined in RecurlyClient.Types.Account

Methods

(==) :: Account -> Account -> Bool

(/=) :: Account -> Account -> Bool

mkAccount :: Account

Create a new Account with all required fields.

data AccountBill_to

Defines the enum schema located at components.schemas.Account.allOf.properties.bill_to in the specification.

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.

Constructors

AccountBill_toOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

AccountBill_toTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

AccountBill_toEnumParent

Represents the JSON value "parent"

AccountBill_toEnumSelf

Represents the JSON value "self"

Instances

FromJSON AccountBill_to

Defined in RecurlyClient.Types.Account

Methods

parseJSON :: Value -> Parser AccountBill_to

parseJSONList :: Value -> Parser [AccountBill_to]

ToJSON AccountBill_to

Defined in RecurlyClient.Types.Account

Methods

toJSON :: AccountBill_to -> Value

toEncoding :: AccountBill_to -> Encoding

toJSONList :: [AccountBill_to] -> Value

toEncodingList :: [AccountBill_to] -> Encoding

Show AccountBill_to

Defined in RecurlyClient.Types.Account

Methods

showsPrec :: Int -> AccountBill_to -> ShowS

show :: AccountBill_to -> String

showList :: [AccountBill_to] -> ShowS

Eq AccountBill_to

Defined in RecurlyClient.Types.Account

Methods

(==) :: AccountBill_to -> AccountBill_to -> Bool

(/=) :: AccountBill_to -> AccountBill_to -> Bool

data AccountPreferred_locale

Defines the enum schema located at components.schemas.Account.allOf.properties.preferred_locale in the specification.

Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

Constructors

AccountPreferred_localeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

AccountPreferred_localeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

AccountPreferred_localeEnumDa_DK

Represents the JSON value "da-DK"

AccountPreferred_localeEnumDe_CH

Represents the JSON value "de-CH"

AccountPreferred_localeEnumDe_DE

Represents the JSON value "de-DE"

AccountPreferred_localeEnumEn_AU

Represents the JSON value "en-AU"

AccountPreferred_localeEnumEn_CA

Represents the JSON value "en-CA"

AccountPreferred_localeEnumEn_GB

Represents the JSON value "en-GB"

AccountPreferred_localeEnumEn_IE

Represents the JSON value "en-IE"

AccountPreferred_localeEnumEn_NZ

Represents the JSON value "en-NZ"

AccountPreferred_localeEnumEn_US

Represents the JSON value "en-US"

AccountPreferred_localeEnumEs_ES

Represents the JSON value "es-ES"

AccountPreferred_localeEnumEs_MX

Represents the JSON value "es-MX"

AccountPreferred_localeEnumEs_US

Represents the JSON value "es-US"

AccountPreferred_localeEnumFi_FI

Represents the JSON value "fi-FI"

AccountPreferred_localeEnumFr_BE

Represents the JSON value "fr-BE"

AccountPreferred_localeEnumFr_CA

Represents the JSON value "fr-CA"

AccountPreferred_localeEnumFr_CH

Represents the JSON value "fr-CH"

AccountPreferred_localeEnumFr_FR

Represents the JSON value "fr-FR"

AccountPreferred_localeEnumHi_IN

Represents the JSON value "hi-IN"

AccountPreferred_localeEnumIt_IT

Represents the JSON value "it-IT"

AccountPreferred_localeEnumJa_JP

Represents the JSON value "ja-JP"

AccountPreferred_localeEnumKo_KR

Represents the JSON value "ko-KR"

AccountPreferred_localeEnumNl_BE

Represents the JSON value "nl-BE"

AccountPreferred_localeEnumNl_NL

Represents the JSON value "nl-NL"

AccountPreferred_localeEnumPl_PL

Represents the JSON value "pl-PL"

AccountPreferred_localeEnumPt_BR

Represents the JSON value "pt-BR"

AccountPreferred_localeEnumPt_PT

Represents the JSON value "pt-PT"

AccountPreferred_localeEnumRo_RO

Represents the JSON value "ro-RO"

AccountPreferred_localeEnumRu_RU

Represents the JSON value "ru-RU"

AccountPreferred_localeEnumSk_SK

Represents the JSON value "sk-SK"

AccountPreferred_localeEnumSv_SE

Represents the JSON value "sv-SE"

AccountPreferred_localeEnumTr_TR

Represents the JSON value "tr-TR"

AccountPreferred_localeEnumZh_CN

Represents the JSON value "zh-CN"

Instances

FromJSON AccountPreferred_locale

Defined in RecurlyClient.Types.Account

Methods

parseJSON :: Value -> Parser AccountPreferred_locale

parseJSONList :: Value -> Parser [AccountPreferred_locale]

ToJSON AccountPreferred_locale

Defined in RecurlyClient.Types.Account

Methods

toJSON :: AccountPreferred_locale -> Value

toEncoding :: AccountPreferred_locale -> Encoding

toJSONList :: [AccountPreferred_locale] -> Value

toEncodingList :: [AccountPreferred_locale] -> Encoding

Show AccountPreferred_locale

Defined in RecurlyClient.Types.Account

Methods

showsPrec :: Int -> AccountPreferred_locale -> ShowS

show :: AccountPreferred_locale -> String

showList :: [AccountPreferred_locale] -> ShowS

Eq AccountPreferred_locale

Defined in RecurlyClient.Types.Account

Methods

(==) :: AccountPreferred_locale -> AccountPreferred_locale -> Bool

(/=) :: AccountPreferred_locale -> AccountPreferred_locale -> Bool

data AccountState

Defines the enum schema located at components.schemas.Account.allOf.properties.state in the specification.

Accounts can be either active or inactive.

Constructors

AccountStateOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

AccountStateTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

AccountStateEnumActive

Represents the JSON value "active"

AccountStateEnumInactive

Represents the JSON value "inactive"

Instances

FromJSON AccountState

Defined in RecurlyClient.Types.Account

Methods

parseJSON :: Value -> Parser AccountState

parseJSONList :: Value -> Parser [AccountState]

ToJSON AccountState

Defined in RecurlyClient.Types.Account

Methods

toJSON :: AccountState -> Value

toEncoding :: AccountState -> Encoding

toJSONList :: [AccountState] -> Value

toEncodingList :: [AccountState] -> Encoding

Show AccountState

Defined in RecurlyClient.Types.Account

Methods

showsPrec :: Int -> AccountState -> ShowS

show :: AccountState -> String

showList :: [AccountState] -> ShowS

Eq AccountState

Defined in RecurlyClient.Types.Account

Methods

(==) :: AccountState -> AccountState -> Bool

(/=) :: AccountState -> AccountState -> Bool