Skip to main content

Fields

account : AccountInterface
billingAddressLine1 : String

First line of the billing address.

billingAddressLine2 : String

Second line of the billing address.

billingAddressLine3 : String

Third line of the billing address.

billingAddressLine4 : String

Fourth line of the billing address.

billingAddressLine5 : String

Fifth line of the billing address.

billingName : String

The name to use for billing purposes.

billingPeriodDay : Int

Day to fixed bill on if billing_period_length set.

billingPeriodLength : String

For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY.

billingPeriodMonth : Int

Month to start billing from if billing_period_length set to QUARTERLY or the multiplier is > 1.

billingPeriodMultiplier : Int

For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing.

billingPostcode : String

The billing address postcode.

billingRichAddress : String

This must be a string-ified version of the JSON representation of RichAddressInput type.

brand : String

The brand associated with the account.

businessType : String

The type of business for business accounts.

clientMutationId : String

A unique identifier for the client performing the mutation.

companyName : String

The name of the company for business accounts.

companyNumber : String

The company registration number for business accounts.

dateOfBirth : Date

The user's date of birth.

email : String! required

The email address of the account user.

errors : [ErrorType]

A list of validation errors.

familyName : String! required

The family name of the account user.

givenName : String! required

The given name of the account user.

isBusinessAccount : Boolean

Whether this is a business account.

landline : String

The user's landline phone number.

mobile : String

The mobile number of the account user.

password : String

The password for the account user.

passwordUpdateToken : String

Token required to set a password during account creation.

portfolioNumber : String

The portfolio number associated with the account.

taxNumber : String

The tax number for the business account.

urn : String

Unique reference number from a 3rd party enrolment.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "account": AccountInterface, "billingAddressLine1": "hope-mean-admit-partner-I", "billingAddressLine2": "example-church-tax-specific-nor", "billingAddressLine3": "career-investment-entire-benefit-here", "billingAddressLine4": "natural-trial-study-move-should", "billingAddressLine5": "mouth-assume-American-card-coach", "billingName": "Mrs-environmental-forward-media-effort", "billingPeriodDay": 44, "billingPeriodLength": "future-fact-test-page-west", "billingPeriodMonth": 63, "billingPeriodMultiplier": 18, "billingPostcode": "oil-show-fly-image-herself", "billingRichAddress": "yard-challenge-by-boy-onto", "brand": "unit-baby-nearly-not-weight", "businessType": "half-far-move-boy-to", "clientMutationId": "24459367", "companyName": "skin-still-actually-prove-begin", "companyNumber": "boy-those-always-dream-write", "dateOfBirth": "1993-10-29", "email": "break-cold-drop-season-bill", "errors": [ErrorType], "familyName": "Bartlett", "givenName": "Nicholas", "isBusinessAccount": true, "landline": "wife-training-family-effect-local", "mobile": "beyond-present-always-action-work", "password": "far-others-last-finish-as", "passwordUpdateToken": "tree-wide-wide-born-Democrat", "portfolioNumber": "P-45B3BFB5", "taxNumber": "pay-woman-myself-read-product", "urn": "else-must-film-east-bank" }