resiliation_terms
Creates, updates, deletes, gets or lists a resiliation_terms resource.
Overview​
| Name | resiliation_terms |
| Type | Resource |
| Id | ovh.xdsl.resiliation_terms |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
due | object | Price with it's currency and textual representation |
engage_date | string (date-time) | Date until which the customer is engaged (wire: engageDate) |
min_resiliation_date | string (date-time) | Minumum resiliationDate (wire: minResiliationDate) |
resiliation_date | string (date-time) | Date at which the access will be resiliated (wire: resiliationDate) |
resiliation_reasons | array | List of available resiliation reasons (wire: resiliationReasons) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | resiliation_date | Returns, for a resiliation date, the amount due, the engagement end date, the minimum resiliation date and the available resiliation reasons. |
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"}}) |
service_name | string | Service name (wire: serviceName) |
resiliation_date | string (date-time) | The desired resiliation date (wire: resiliationDate) |
SELECT examples​
- get
Returns, for a resiliation date, the amount due, the engagement end date, the minimum resiliation date and the available resiliation reasons.
SELECT
due,
engage_date,
min_resiliation_date,
resiliation_date,
resiliation_reasons
FROM ovh.xdsl.resiliation_terms
WHERE service_name = '{{ service_name }}' -- required
AND resiliation_date = '{{ resiliation_date }}'
;