promotion_code_capabilities
Creates, updates, deletes, gets or lists a promotion_code_capabilities resource.
Overview​
| Name | promotion_code_capabilities |
| Type | Resource |
| Id | ovh.pack_xdsl.promotion_code_capabilities |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
amount | object | Amount of the promotion code |
can_generate | boolean | True if the promotion code generation is available (wire: canGenerate) |
engagement | integer | Number of months of engagement |
reason_codes | array | Enum of the possible errors (wire: reasonCodes) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | pack_name | Get the promotion code capabilities of an xDSL pack. Returns whether a promotion code can be generated, its amount, the engagement it requires and the reasons when it cannot. |
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"}}) |
pack_name | string | The internal name of your pack (wire: packName) |
SELECT examples​
- get
Get the promotion code capabilities of an xDSL pack. Returns whether a promotion code can be generated, its amount, the engagement it requires and the reasons when it cannot.
SELECT
amount,
can_generate,
engagement,
reason_codes
FROM ovh.pack_xdsl.promotion_code_capabilities
WHERE pack_name = '{{ pack_name }}' -- required
;