Skip to main content

eligibilities

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

Overview​

Nameeligibilities
TypeResource
Idovh.cloud.eligibilities

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
actions_requiredarrayActions to perform to be eligible (wire: actionsRequired)
minimum_creditobjectCloud project order (wire: minimumCredit)
payment_methods_authorizedarrayPayment method accepted to order Public Cloud project (wire: paymentMethodsAuthorized)
voucherobjectInformation about voucher code

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvoucherCheck project order eligibility. Returns the actions required before ordering a project, the minimum credit and the accepted payment methods. Give a voucher code to check its credit at the same time. (Beta version)

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.

NameDatatypeDescription
api_hoststringThe 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"}})
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
voucherstring (password)Voucher code

SELECT examples​

Check project order eligibility. Returns the actions required before ordering a project, the minimum credit and the accepted payment methods. Give a voucher code to check its credit at the same time. (Beta version)

SELECT
actions_required,
minimum_credit,
payment_methods_authorized,
voucher
FROM ovh.cloud.eligibilities
WHERE voucher = '{{ voucher }}'
;