---
title: "Ordering Public Cloud projects using the OVHcloud API"
description: "Find out how to order your Public Cloud project with the OVHcloud API"
url: https://docs.ovhcloud.com/en/guides/account-and-service-management/managing-billing-payments-and-services/order-project-api
lang: en
lastUpdated: 2020-12-09
---
# Ordering Public Cloud projects using the OVHcloud API

## Objective

Creating a project is the first step in deploying [Public Cloud instances](https://www.ovhcloud.com/en-gb/public-cloud/).

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

## Requirements

- User credentials for an active OVHcloud account
- A valid [payment method](/en/guides/account-and-service-management/managing-billing-payments-and-services/manage-payment-methods.md) saved in your OVHcloud account
- Consulting the [OVHcloud API first steps guide](/en/guides/manage-and-operate/api/first-steps.md) to familiarise yourself with the OVHcloud APIv6

## Instructions

Log in to the [OVHcloud API interface](https://eu.api.ovh.com/) according to the [relevant guide](/en/guides/manage-and-operate/api/first-steps.md) 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:


🇪🇺EU▾

[POST/order/cart](https://eu.api.ovh.com/console/?section=/order&branch=v1#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:


🇪🇺EU▾

[GET/order/cart/{cartId}/cloud](https://eu.api.ovh.com/console/?section=/order&branch=v1#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:


🇪🇺EU▾

[POST/order/cart/{cartId}/cloud](https://eu.api.ovh.com/console/?section=/order&branch=v1#post-/order/cart/-cartId-/cloud)

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

| Field       | Value             |
| ----------- | ----------------- |
| cartId      | _ID of your cart_ |
| duration    | P1M               |
| planCode    | project.2018      |
| pricingMode | default           |
| quantity    | 1                 |

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


🇪🇺EU▾

[GET/order/cart/{cartId}/item/{itemId}](https://eu.api.ovh.com/console/?section=/order&branch=v1#get-/order/cart/-cartId-/item/-itemId-)

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


🇪🇺EU▾

[GET/order/cart/{cartId}/item/{itemId}/requiredConfiguration](https://eu.api.ovh.com/console/?section=/order&branch=v1#get-/order/cart/-cartId-/item/-itemId-/requiredConfiguration)

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


🇪🇺EU▾

[POST/order/cart/{cartId}/item/{itemId}/configuration](https://eu.api.ovh.com/console/?section=/order&branch=v1#post-/order/cart/-cartId-/item/-itemId-/configuration)

| Field  | Value               |
| ------ | ------------------- |
| cartId | _ID of your cart_   |
| itemId | _ID of the item_    |
| label  | description         |
| value  | _Your 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:


🇪🇺EU▾

[DELETE/order/cart/{cartId}/item/{itemId}/configuration/{configurationId}](https://eu.api.ovh.com/console/?section=/order&branch=v1#delete-/order/cart/-cartId-/item/-itemId-/configuration/-configurationId-)

### Step 2: Checking out the cart

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


🇪🇺EU▾

[GET/order/cart/{cartId}/checkout](https://eu.api.ovh.com/console/?section=/order&branch=v1#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.


🇪🇺EU▾

[POST/order/cart/{cartId}/checkout](https://eu.api.ovh.com/console/?section=/order&branch=v1#post-/order/cart/-cartId-/checkout)

## Go further

Join our [community of users](https://community.ovhcloud.com/).