line_offers
Creates, updates, deletes, gets or lists a line_offers resource.
Overview​
| Name | line_offers |
| Type | Resource |
| Id | ovh.telephony.line_offers |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | The offer name |
description | string | The offer description |
price | object | Offer price per month |
Informations related to a line offer
| Name | Datatype | Description |
|---|---|---|
name | string | The offer name |
description | string | The offer description |
price | object | Offer price per month |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | billing_account, service_name | Get the line offer | |
list | select | country | Get all available line offer compatible |
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"}}) |
billing_account | string | The name of your billingAccount (wire: billingAccount) |
country | string | The country |
service_name | string | (wire: serviceName) |
SELECT examples​
- get
- list
Get the line offer
SELECT
name,
description,
price
FROM ovh.telephony.line_offers
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Get all available line offer compatible
SELECT
name,
description,
price
FROM ovh.telephony.line_offers
WHERE country = '{{ country }}' -- required
;