service_scheduled_offer_changes

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

Overview

Name	service_scheduled_offer_changes
Type	Resource
Id	ovh.telephony.service_scheduled_offer_changes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
offer	string	The current offer will be replace by this one on the next renew.

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 scheduled offer change
create	insert	billing_account, service_name, offer		Schedule an offer change
delete	delete	billing_account, service_name		Cancel the scheduled offer change

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)
service_name	string	(wire: serviceName)

SELECT examples

get

Get the scheduled offer change

SELECT
offer
FROM ovh.telephony.service_scheduled_offer_changes
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Schedule an offer change

INSERT INTO ovh.telephony.service_scheduled_offer_changes (
offer,
billing_account,
service_name
)
SELECT 
'{{ offer }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: service_scheduled_offer_changes
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the service_scheduled_offer_changes resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the service_scheduled_offer_changes resource.
  - name: offer
    value: "{{ offer }}"
    description: |
      The future offer

DELETE examples

delete

Cancel the scheduled offer change

DELETE FROM ovh.telephony.service_scheduled_offer_changes
WHERE billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
;