For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/en/guides/account-and-service-management/managing-billing-payments-and-services/order-project-api.md.

Ordering Public Cloud projects using the OVHcloud API

View as Markdown

Find out how to order your Public Cloud project with the OVHcloud API

Objective

Creating a project is the first step in deploying Public Cloud instances.

This guide explains how to order a Public Cloud project via the OVHcloud API.

Requirements

Instructions

Open the according to the relevant guide and follow the steps below.

Step 1: Building your cart

The first step of an order is to create a 'shopping cart'. Following that you can add a Public Cloud project.

Create the cart

Use this call to create the cart:

POST/order/cart

Make sure to choose your appropriate OVHcloud API subsidiary. Take note of the cart number ("cartId") in the response; it will be required to identify this cart.

Next you will need to add a Public Cloud project as an item. Use this call with your "cartId" to verify the service availability:

GET/order/cart/{cartId}/cloud

In the response you can verify the parameters pertaining to a Public Cloud project:

planCode: "project.2018"

productName: "Public Cloud Project"

Add a project to the cart

Now use this call to add the item to your cart:

POST/order/cart/{cartId}/cloud

The following information, retrieved in the previous steps, needs to be provided:

FieldValue
cartIdID of your cart
durationP1M
planCodeproject.2018
pricingModedefault
quantity1

The response will include an "itemId" which can be used (together with the "cartId") to retrieve the cart item:

GET/order/cart/{cartId}/item/{itemId}

You can check the list of available configuration settings for this item with this call:

Use the following endpoint to name your project (label: "description"):

FieldValue
cartIdID of your cart
itemIdID of the item
labeldescription
valueYour project name

To apply a voucher code, use the same call with the label "voucher", etc.

The responses will include a "configurationId" which can be used (together with the "cartId" and "itemId") to retrieve the configuration (GET) or delete it, for example:

Step 2: Checking out the cart

You can verify your cart contents using the "cartId":

GET/order/cart/{cartId}/checkout

With the following call you can create a link to your order. It is required to first tick the relevant checkbox in order to waive the right of withdrawal.

POST/order/cart/{cartId}/checkout

Go further

Join our community of users.

Was this page helpful?