Skip to main content

sub_services_keep_service_terms

Creates, updates, deletes, gets or lists a sub_services_keep_service_terms resource.

Overview​

Namesub_services_keep_service_terms
TypeResource
Idovh.pack_xdsl.sub_services_keep_service_terms

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
is_allowedbooleanTells whether or not the service can be unpacked (wire: isAllowed)
priceobjectPrice bill on the unpack action
renew_periodnumberRenew period in month of the service (wire: renewPeriod)
renew_priceobjectThe price it will cost when it will be renew (wire: renewPrice)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdomain, pack_nameGet the unpack terms of a service of an xDSL pack. Returns whether the service can be taken out of the pack, the price billed and its renewal price and period.

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"}})
domainstring
pack_namestringThe internal name of your pack (wire: packName)

SELECT examples​

Get the unpack terms of a service of an xDSL pack. Returns whether the service can be taken out of the pack, the price billed and its renewal price and period.

SELECT
is_allowed,
price,
renew_period,
renew_price
FROM ovh.pack_xdsl.sub_services_keep_service_terms
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;