Organization API: Catalog & Services: Platform products

The 2 Organization API operations for platform products.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/platform-products`	The platform products this organization may link a product to
GET	`/api/v1/orgs/{org_slug}/platform-products/{platform_product_id}/object-storage`	Get platform object storage

The platform products this organization may link a product to

Section titled The platform products this organization may link a product to

GET /api/v1/orgs/{org_slug}/platform-products

The platform products this organization may link a product to.

The platform catalogue (active products, with subnet rentals only while they are on), plus the free plan when a platform admin has let the organization sell it. It leaves out what the platform does not sell to an organization's customers: products no longer sold, the account plans with their add-ons and the $0 services they include, the App Deployment usage rates, and the products billed by use (metadata.billing_model payg) other than pay as you go Object Storage, which a brand resells at its own rates (GET …/products/{id}/object-storage). The mail plans sold before the account plans stay. It carries no availability: it is for choosing what a product provisions, and the storefront reads availability itself.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].name`	string
`[].slug`	string
`[].description`	string or null
`[].group_name`	string or null
`[].module_name`	string
`[].hardware_tier_id`	integer or null
`[].hardware_tier`	HardwareTierSummary or null
`[].hardware_tier.id`	integer
`[].hardware_tier.slug`	string
`[].hardware_tier.name`	string
`[].hardware_tier.code`	string
`[].hardware_tier.description`	string or null
`[].status`	string
`[].config_schema`	object or null
`[].sort_order`	integer
`[].stock_limit`	integer or null
`[].metadata`	object or null
`[].pricing`	array of PricingResponse
`[].pricing[].id`	integer
`[].pricing[].product_id`	integer
`[].pricing[].name`	string
`[].pricing[].billing_cycle`	string
`[].pricing[].price`	number
`[].pricing[].setup_fee`	number
`[].pricing[].currency`	string
`[].pricing[].is_active`	boolean
`[].pricing[].sort_order`	integer
`[].pricing[].metadata`	object or null
`[].pricing[].created_at`	string (date-time)
`[].config_options`	array of ConfigOptionResponse
`[].config_options[].id`	integer
`[].config_options[].product_id`	integer
`[].config_options[].field_name`	string
`[].config_options[].label`	string
`[].config_options[].field_type`	string
`[].config_options[].options`	object or null
`[].config_options[].default_value`	string or null
`[].config_options[].required`	boolean
`[].config_options[].price_modifier`	number
`[].config_options[].sort_order`	integer
`[].is_orderable_now`	boolean or null
`[].stock_status`	string or null
`[].availability_reason`	string or null
`[].group_is_orderable_now`	boolean or null
`[].group_stock_status`	string or null
`[].locations`	array of ProductLocationAvailability
`[].locations[].id`	integer
`[].locations[].code`	string
`[].locations[].name`	string
`[].locations[].country_code`	string
`[].locations[].available`	boolean
`[].locations[].orderable`	boolean
`[].locations[].reason`	string or null
`[].created_at`	string (date-time)

Get platform object storage

Section titled Get platform object storage

GET /api/v1/orgs/{org_slug}/platform-products/{platform_product_id}/object-storage

The Object Storage rates a product linked to this platform product starts from: Coritan's list rates in your invoice currency, and the least each rate may be. It is what to show before the product exists; the answer has configured: false. Any member; 404 for any platform product but pay as you go Object Storage.

Parameters

Section titled Parameters

Name	In	Type	Required
`platform_product_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type	Description
`currency`	string	The currency the rates were saved in. It is `invoice_currency` unless that changed since.
`configured`	boolean	False while the product has no rates of its own and Coritan's list rates stand in.
`rates`	Rates	`storage_gb_month`, `class_a_million` and `class_b_million`.
`free`	Free	`storage_gb_month` (GB-months), `class_a` and `class_b` (operations), per customer each month.
`list_rates`	object or null	Coritan's list rates in `invoice_currency`, when they can be converted.
`wholesale_rates`	object or null	The least each rate may be, in `invoice_currency`: what Coritan charges you. `null` when no floor applies.
`limited`	boolean	Whether a rate under `wholesale_rates` is refused.
`reason`	string or null	Why there is no floor: `exempt`, `not_linked`, `no_list_price` or `no_rate`.
`discount_percent`	number	How far below list Coritan's wholesale rates are.
`invoice_currency`	string	The currency your invoices are made in. Rates in another currency wait until they are saved again.
`currency_matches`	boolean