Parameters
Each region and add-on adds its monthly price to the plan. A region or add-on the product does not offer is refused by the API.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
| Name | Type | Required | Description |
|---|---|---|---|
productId | string | Yes | Product ID to purchase |
period | 1 | 3 | 6 | Yes | Subscription period in months |
quantity | number | No | Number of instances to purchase (default: 1) |
customName | string | No | Custom name for the instance (max 100 characters) |
region | string | No | Region code from list_products (EU, US-CENTRAL, US-EAST, US-WEST, UK, JPN, IND, AUS), default EU |
addOns | string[] | No | VPS only: add-on ids from list_products, at most one per type |
Purchase 3 months of product abc123
Buy 1 month of VPS-XS with the name "my-server"
Buy 1 month of VPS Starter in US-EAST with the OpenClaw add-on
## Order Created Successfully
**Order ID:** order_xyz789
**Status:** completed
**User:** 0x1234...abcd
**Created:** 2025-01-15T10:30:00.000Z
### Products:
- Product: abc123
Period: 3 month(s)
Quantity: 1
### Instance:
- ID: inst_456
- Type: vps
- Status: provisioning
> Use `get_order` with order ID to check provisioning status and get instance details.