catalog_public_plans

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

Overview

Name	catalog_public_plans
Type	Resource
Id	ovh.order.catalog_public_plans

Fields

The following fields are returned by SELECT queries:

list

A commercial plan from the catalog

Name	Datatype	Description
plan_id	integer	Internal numeric plan identifier (wire: planId)
family_name	string	Name of the product family this plan belongs to (wire: familyName)
invoice_name	string	Name displayed on invoices for this plan (wire: invoiceName)
plan_code	string	Commercial offer identifier (wire: planCode)
pricing_type	string	Pricing type of the plan (consumption, purchase, rental) (wire: pricingType)
pricings	array	Pricings of the plan
promotions	array	Promotions applicable to the plan

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	ovh_subsidiary, product_name	x_pagination_cursor, x_pagination_size, plan_code	Returns the main plans paginated, or the plans matching the planCode query parameter when provided. When planCode is set, pagination is ignored.

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"}})
ovh_subsidiary	string	Subsidiary of the country you want to consult plans for (wire: ovhSubsidiary)
product_name	string	Product name whose plans you want to fetch (wire: productName)
plan_code	array	Optional list of plan codes to fetch (wire: planCode)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the main plans paginated, or the plans matching the planCode query parameter when provided. When planCode is set, pagination is ignored.

SELECT
plan_id,
family_name,
invoice_name,
plan_code,
pricing_type,
pricings,
promotions
FROM ovh.order.catalog_public_plans
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
AND product_name = '{{ product_name }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND plan_code = '{{ plan_code }}'
;