accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	ovh.me.accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Customer name
display_name	string	Display name shown instead of the organisation name. (wire: displayName)
address	string	Address of nichandle
area	string	Area of nichandle
birth_city	string	City of birth (wire: birthCity)
birth_day	string	Birth date (wire: birthDay)
city	string	City of nichandle
company_national_identification_number	string	Company National Identification Number (wire: companyNationalIdentificationNumber)
complementary_address	string	Complementary Address (wire: complementaryAddress)
corporation_type	string	Corporation type (wire: corporationType)
country	string	Customer country (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, UNKNOWN, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW)
currency	object	Customer currency
customer_code	string	Your customer code (a numerical value used for identification when contacting support via phone call) (wire: customerCode)
einvoicing_billing_address	string	Default e-invoicing billing address (wire: einvoicingBillingAddress)
email	string	Email address
fax	string	Fax number
firstname	string	First name
italian_sdi	string	Italian SDI (wire: italianSDI)
kyc_validated	boolean	KYC validation state (wire: kycValidated)
language	string	Language (cs_CZ, de_DE, en_AU, en_CA, en_GB, en_IE, en_US, es_ES, fi_FI, fr_CA, fr_FR, fr_MA, fr_SN, fr_TN, it_IT, lt_LT, nl_NL, pl_PL, pt_PT)
legalform	string	Customer legal form (administration, association, corporation, individual, other, personalcorporation)
national_identification_number	string	National Identification Number (wire: nationalIdentificationNumber)
nichandle	string	Customer identifier
organisation	string	Name of organisation
ovh_company	string	OVH company (kimsufi, ovh, soyoustart) (wire: ovhCompany)
ovh_subsidiary	string	OVH subsidiary (CZ, DE, ES, EU, FI, FR, GB, IE, IT, LT, MA, NL, PL, PT, SN, TN) (wire: ovhSubsidiary)
phone	string	Phone number
phone_country	string	Countries a nichandle can choose (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, UNKNOWN, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW) (wire: phoneCountry)
phone_type	string	Type of phone(mobile, landline) (landline, mobile) (wire: phoneType)
purpose_of_purchase	string	Customer purpose of purchase (wire: purposeOfPurchase)
sex	string	Gender (female, male)
spare_email	string	Spare email (wire: spareEmail)
state	string	Nichandle state (complete, incomplete)
vat	string	VAT number
zip	string	Zipcode

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Get details about your nichandle
update	update			Update details of your nichandle
account	exec			Create a new account whose billing will be linked to your current account's billing (Alpha version)
api_log_url	exec	kind		Generate a temporary URL to retrieve logs
carbon_calculator_csv	exec	endMonth, startMonth		Create a carbon footprint csv generation task
carbon_calculator_pdf	exec	month		Create a carbon footprint pdf generation task
change_email	exec	newEmail		Initiate an email change procedure
change_password	exec			Initiate a password change procedure
credit_code	exec	inputCode		Validate a code to generate associated credit movement
geolocation	exec			Fetch visitor country & region
mailing_list_subscribe	exec	email, mailingList		Subscribe an email to a restricted mailing list
password_recover	exec	ovhCompany, ovhId		Request a password recover
voucher_check_validity	exec	voucher		Verify existing voucher

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})

SELECT examples

get

Get details about your nichandle

SELECT
name,
display_name,
address,
area,
birth_city,
birth_day,
city,
company_national_identification_number,
complementary_address,
corporation_type,
country,
currency,
customer_code,
einvoicing_billing_address,
email,
fax,
firstname,
italian_sdi,
kyc_validated,
language,
legalform,
national_identification_number,
nichandle,
organisation,
ovh_company,
ovh_subsidiary,
phone,
phone_country,
phone_type,
purpose_of_purchase,
sex,
spare_email,
state,
vat,
zip
FROM ovh.me.accounts
;

UPDATE examples

update

Update details of your nichandle

UPDATE ovh.me.accounts
SET 
address = '{{ address }}',
area = '{{ area }}',
birth_city = '{{ birth_city }}',
birth_day = '{{ birth_day }}',
city = '{{ city }}',
company_national_identification_number = '{{ company_national_identification_number }}',
complementary_address = '{{ complementary_address }}',
corporation_type = '{{ corporation_type }}',
country = '{{ country }}',
display_name = '{{ display_name }}',
einvoicing_billing_address = '{{ einvoicing_billing_address }}',
fax = '{{ fax }}',
firstname = '{{ firstname }}',
italian_sdi = '{{ italian_sdi }}',
language = '{{ language }}',
legalform = '{{ legalform }}',
name = '{{ name }}',
national_identification_number = '{{ national_identification_number }}',
organisation = '{{ organisation }}',
phone = '{{ phone }}',
phone_country = '{{ phone_country }}',
phone_type = '{{ phone_type }}',
purpose_of_purchase = '{{ purpose_of_purchase }}',
sex = '{{ sex }}',
spare_email = '{{ spare_email }}',
vat = '{{ vat }}',
zip = '{{ zip }}';

Lifecycle Methods

EXEC variables use wire (API) names.

account

Create a new account whose billing will be linked to your current account's billing (Alpha version)

EXEC ovh.me.accounts.account 
@@json=
'{
"address": "{{ address }}", 
"area": "{{ area }}", 
"billingAccount": "{{ billingAccount }}", 
"birthCity": "{{ birthCity }}", 
"birthDay": "{{ birthDay }}", 
"city": "{{ city }}", 
"companyNationalIdentificationNumber": "{{ companyNationalIdentificationNumber }}", 
"complementaryAddress": "{{ complementaryAddress }}", 
"corporationType": "{{ corporationType }}", 
"country": "{{ country }}", 
"einvoicingBillingAddress": "{{ einvoicingBillingAddress }}", 
"email": "{{ email }}", 
"fax": "{{ fax }}", 
"firstname": "{{ firstname }}", 
"italianSDI": "{{ italianSDI }}", 
"language": "{{ language }}", 
"legalform": "{{ legalform }}", 
"name": "{{ name }}", 
"nationalIdentificationNumber": "{{ nationalIdentificationNumber }}", 
"organisation": "{{ organisation }}", 
"phone": "{{ phone }}", 
"phoneCountry": "{{ phoneCountry }}", 
"phoneType": "{{ phoneType }}", 
"purposeOfPurchase": "{{ purposeOfPurchase }}", 
"sex": "{{ sex }}", 
"spareEmail": "{{ spareEmail }}", 
"vat": "{{ vat }}", 
"zip": "{{ zip }}"
}'
;

api_log_url

Generate a temporary URL to retrieve logs

EXEC ovh.me.accounts.api_log_url 
@@json=
'{
"kind": "{{ kind }}"
}'
;

carbon_calculator_csv

Create a carbon footprint csv generation task

EXEC ovh.me.accounts.carbon_calculator_csv 
@@json=
'{
"endMonth": "{{ endMonth }}", 
"startMonth": "{{ startMonth }}"
}'
;

carbon_calculator_pdf

Create a carbon footprint pdf generation task

EXEC ovh.me.accounts.carbon_calculator_pdf 
@@json=
'{
"month": "{{ month }}"
}'
;

change_email

Initiate an email change procedure

EXEC ovh.me.accounts.change_email 
@@json=
'{
"newEmail": "{{ newEmail }}"
}'
;

change_password

Initiate a password change procedure

EXEC ovh.me.accounts.change_password 
;

credit_code

Validate a code to generate associated credit movement

EXEC ovh.me.accounts.credit_code 
@@json=
'{
"inputCode": "{{ inputCode }}", 
"serviceId": {{ serviceId }}
}'
;

geolocation

Fetch visitor country & region

EXEC ovh.me.accounts.geolocation 
;

mailing_list_subscribe

Subscribe an email to a restricted mailing list

EXEC ovh.me.accounts.mailing_list_subscribe 
@@json=
'{
"email": "{{ email }}", 
"mailingList": "{{ mailingList }}"
}'
;

password_recover

Request a password recover

EXEC ovh.me.accounts.password_recover 
@@json=
'{
"ovhCompany": "{{ ovhCompany }}", 
"ovhId": "{{ ovhId }}"
}'
;

voucher_check_validity

Verify existing voucher

EXEC ovh.me.accounts.voucher_check_validity 
@@json=
'{
"voucher": "{{ voucher }}"
}'
;