_spot` value sent for it is ignored. The `usd_pricing` targets are whole-server $/day figures validated against the USD range (0.1 to 10,000); out-of-range values clamp to the nearest bound.
>
> With `auto_renew_allowed` on (the default), `mrl` is also your repricing period: an order whose renter chose auto-renewal renews each time it reaches `mrl`, at your price at that moment. Setting it to `false` never ends a running rental: each order on the server finishes its current term and its renewal is declined with `host_disallowed`.
**Output**
| Field | Type | Description |
| ------ | ----- | ----------- |
| `code` | `int` | Status code |
**Example**
**Input:**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"name": "Jan Vykydal",
"availability":true,
"mrl":96,
"enabled-bitcoin":true,
"bitcoin_on_demand":0.0001,
"bitcoin_spot":0.00000113
}' 'https://api.clore.ai/v1/set_server_settings'
```
**Output:**
```
{
"code": 0
}
```
#### 8. `set_spot_price`
**About**
Set price per day on your SPOT market offer
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| --------------- | ------- | --------- | -------------------------- |
| `order_id` | `int` | Yes | Unique offer ID |
| `desired_price` | `float` | Yes | Your offered price per day |
> **A price below the server's current spot floor** is rejected with the current minimum included:
>
> ```
> { "error": "amount_too_low", "min_price": 0.0000012, "code": 6 }
> ```
>
> **A raise must be at least 1% above both your current bid and the server's top bid in the same currency** (rounded up to the currency's precision, capped at the price ceiling). A smaller raise is rejected with the lowest accepted price:
>
> ```
> { "error": "below_min_raise_step", "min_price": 0.00000425, "code": 6 }
> ```
**Example**
Let's try to update spot market price
**Input 1 (Step down was too big):**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000200
}' 'https://api.clore.ai/v1/set_spot_price'
```
**Possible output 1 (Step down was too big):**\
You can lower spot market offer price by max of 0.00000100 ₿
| Field | Type | Description |
| ---------- | -------- | ----------------------------------------------------------- |
| `code` | `int` | Status code |
| `error` | `string` | Error description field |
| `max_step` | `float` | Lowest possible value to what you can currently lower price |
```
{
"error":"exceeded_max_step",
"max_step":0.0000032,
"code":6
}
```
**Input 2 (Valid price step down):**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000320
}' 'https://api.clore.ai/v1/set_spot_price'
```
**Possible output 2 (Valid price step down):**
```
{
"code": 0
}
```
**Input 3 (Lower price even more after sending Input 2):**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":39,
"desired_price":0.00000220
}' 'https://api.clore.ai/v1/set_spot_price
```
**Possible output 3 (Lower price even more after sending Input 2):**\
You can lower spot price once in 600 seconds
| Field | Type | Description |
| ------------------ | -------- | ------------------------------------------------------- |
| `code` | `int` | Status code |
| `error` | `string` | Error description field |
| `time_to_lowering` | `float` | Remaining time (sec) to next possibility to lower price |
```
{
"error":"can_lower_every_600_seconds",
"time_to_lowering":513,
"code":6
}
```
#### 9. `cancel_order`
**About**
Cancel an active order or spot offer
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | `int` | Yes | Unique order/offer ID |
| `issue` | `string` | No | If you have encountered any issues with the server you can report them to [clore.ai](http://clore.ai/) team, maximum 2048 characters |
**Output**
| Field | Type | Description |
| ------ | ----- | ----------- |
| `code` | `int` | Status code |
**Example**
Cancel order/offer
**Input:**\
In this example we are reporting issues with GPU #1, if you don't have issues, don't include issue field.\
You can write any message to text field and we will investigate it
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"id":39,
"issue":"GPU #1 Was overheating and throttling"
}' 'https://api.clore.ai/v1/cancel_order'
```
**Output:**
```
{
"code": 0
}
```
#### 10. `create_order`
**About**
You can create spot offer or on demand order with this endpoint
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ---------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `currency` | `string` | Yes | Currency name |
| `image` | `string` | Yes | Valid image from dockerhub |
| `renting_server` | `int` | Yes | ID of server you want to rent |
| `type` | `string` | Yes | `on-demand` OR `spot` |
| `spotprice` | `float` | Depends | Offering price per day on spot market, required when making spot order |
| `ports` | `object` | No | Port forwarding configuration, max 5 records |
| `env` | `object` | No | Environment variables, limited to 12288 characters in total when stringified.
Variable name - 128 symbols max, must not contain -
Variable value - 1536 symbols max
Only the first 30 valid variables are kept; extras are silently dropped
|
| `jupyter_token` | `string` | No | Jupyter token for images that has jupyter notebooks, maximum 32 characters \* |
| `ssh_key` | `string` | No | SSH key for images with SSH, maximum 3072 characters \* |
| `ssh_password` | `string` | No | SSH password for images with SSH, maximum 32 characters \* |
| `command` | `string` | No | Command will be run on server after order creation |
| `required_price` | `float` | No | Specify price for what you want to start the order, if machine owner changes the price, then order will not start (on demand only) |
| `gpu_count` | `int` | No | Number of GPUs to rent on servers that support [partial rental](/for-renters/partial-gpu-rental.md). Omit to rent the whole rig. On-demand only, homogeneous rigs only |
| `gpu_indices` | `[]int` | No | 0-based GPU slot indices to rent; length must equal `gpu_count`. Take free slots from `partial_gpu_rental.free_indices`. Omit to let the backend pick free GPUs automatically |
| `autossh_entrypoint` | `bool` | No | Use clore.ai entrypoint, that autometically deploy SSH server and custom `/root/onstart.sh` script |
| `rental_hours` | `int` | No | On-demand only. How long you want the machine, in whole hours from 1 to 3000 (the platform maximum), counted from the order's creation. Omit it to request no limit: the order then ends at the server's `mrl` unless `auto_renew` is on, in which case it runs until you cancel. A value above the server's `mrl` requires `auto_renew: true`; a value at or below it ends the order after that many hours. Ignored on spot orders |
| `auto_renew` | `bool` | No | On-demand only. When the server's maximum rental length is reached, renew the order on the same container at the server's current price, as long as that price is at or under `auto_renew_max_price`, until `rental_hours` are used, or until you cancel when `rental_hours` is omitted. No creation fee is charged on a renewal. Refused on spot orders and on servers whose `auto_renew_allowed` is `false` |
| `auto_renew_max_price` | `float` | Depends | Required when `auto_renew` is `true`. Per-day price limit in the order's currency, above 0 and at most the marketplace's maximum price for that currency (0.1 BTC, 5,000,000 CLORE, 10,000 USD). At each renewal it is compared with the server's price per day, scaled to `gpu_count` on a partial rental |
\* To fields marked with star you can only input characters from this regexp group `/^[a-zA-Z0-9\s-=.@+/]+$/`
**Output**
| Field | Type | Description |
| ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | `int` | Status code |
| `error` | `string` | Present with code `6` (HTTP 200) when the order is refused. Rental length and auto-renewal refusals: `invalid_rental_hours` (not a whole number from 1 to 3000, or `null`), `rental_hours_exceeds_mrl` (above the server's `mrl` without `auto_renew: true`), `invalid_auto_renew` (`auto_renew` is not a boolean, or it is `true` without a positive `auto_renew_max_price`, or with one above the marketplace's maximum price for the currency), `auto_renew_not_supported` (`auto_renew: true` on a spot order), `auto_renew_not_allowed` (the server does not allow auto-renewal). Spot bid refusals are described below |
> **Spot bids below the server's floor** are rejected with the current minimum included, so you can retry immediately:
>
> ```
> { "error": "too_low_price", "min_price": 0.0000012, "code": 6 }
> ```
>
> The floor is recomputed from live coin rates roughly every 10 minutes, so a price read off the marketplace listing can be slightly stale — always use the returned `min_price` for the retry.
>
> **When the server already has spot bids in the same currency**, a new bid must be at least 1% above the top one (rounded up to the currency's precision, capped at the price ceiling). A lower bid is rejected with the lowest accepted price:
>
> ```
> { "error": "below_min_raise_step", "min_price": 0.00000425, "code": 6 }
> ```
**Example**
**Input 1 (Create spot offer):**
```
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
"currency":"bitcoin",
"image":"cloreai/ubuntu20.04-jupyter",
"renting_server":6,
"type":"spot",
"spotprice":0.000001,
"ports":{
"22":"tcp",
"8888":"http"
},
"env":{
"VARIABLE_NAME":"VARIABLE_VALUE",
},
"jupyter_token":"hoZluOjbCOQ5D5yH7R",
"ssh_password":"Hpcj08ZaOpCbTmn1Eu",
"command":"#!/bin/sh\napt update -y && apt install htop"
}' 'https://api.clore.ai/v1/create_order'
```
**Output 1 (Create spot offer):**
```
{
"code":0
}
```
**Input 2 (Create on demand order):**
```
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
"currency":"bitcoin",
"image":"cloreai/ubuntu20.04-jupyter",
"renting_server":6,
"type":"on-demand",
"ports":{
"22":"tcp",
"8888":"http"
},
"env":{
"VARIABLE_NAME":"VARIABLE_VALUE",
},
"jupyter_token":"hoZluOjbCOQ5D5yH7R",
"ssh_password":"Hpcj08ZaOpCbTmn1Eu",
"command":"#!/bin/sh\napt update -y && apt install htop"
}' 'https://api.clore.ai/v1/create_order'
```
**Output 2 (Create on demand order):**
```
{
"code":0
}
```
**Input 3 (On demand order for 48 hours with auto-renewal):**
```
curl -XPOST -H 'auth: 6FcuR7ibcwKR1Z32lEFoSotzUUtzKO2H' -H "Content-type: application/json" -d '
{
"currency":"CLORE-Blockchain",
"image":"cloreai/jupyter:ubuntu24.04-v2",
"renting_server":6,
"type":"on-demand",
"rental_hours":48,
"auto_renew":true,
"auto_renew_max_price":250
}' 'https://api.clore.ai/v1/create_order'
```
**Output 3 (On demand order for 48 hours with auto-renewal):**
```
{
"code":0
}
```
On a server with a 24-hour `mrl` the first term lasts 24 hours. At its end the order renews for another 24 hours at the server's price at that time, if it is at or under 250 CLORE per day, then ends because the 48 requested hours are used up. With `auto_renew` on, omitting `rental_hours` keeps it renewing until you cancel. Without `auto_renew`, the same `rental_hours` on that server is refused:
```
{ "error": "rental_hours_exceeds_mrl", "code": 6 }
```
#### 11. `renter_fees`
**About**
Get the current fee configuration: base renter fees, PoH fee reduction settings, order creation fees, and your PoH balance
**Headers**
| Field | Type | Mandatory | Description |
| ------ | -------- | --------- | ----------- |
| `auth` | `string` | Yes | API token |
**Output**
| Field | Type | Description |
| ---------------------------------- | -------- | ----------------------------------------------------- |
| `code` | `int` | Status code |
| `renter_fees.on_demand` | `object` | Base fee (%) per currency for on-demand orders |
| `renter_fees.spot` | `object` | Base fee (%) per currency for spot orders |
| `poh_config.max_reduction_percent` | `int` | Maximum base-fee reduction through PoH (%) |
| `poh_config.max_poh_amount` | `int` | PoH balance at which the maximum reduction is reached |
| `creation_fees.on_demand` | `object` | Order creation fee per currency |
| `creation_fees.spot` | `object` | Spot order creation fee per currency |
| `poh_balance` | `float` | Your PoH CLORE balance |
**Input:**
```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/renter_fees'
```
**Output:**
```
{
"renter_fees": {
"on_demand": {
"base": { "bitcoin": 5, "CLORE-Blockchain": 5, "USD-Blockchain": 5 }
},
"spot": {
"base": { "bitcoin": 1.25, "CLORE-Blockchain": 1.25, "USD-Blockchain": 1.25 }
}
},
"poh_config": { "max_reduction_percent": 50, "max_poh_amount": 2000000 },
"creation_fees": {
"on_demand": { "bitcoin": 3e-7, "CLORE-Blockchain": 0.5, "USD-Blockchain": 0.1 },
"spot": { "bitcoin": 1e-7, "CLORE-Blockchain": 0.05, "USD-Blockchain": 0.005 }
},
"poh_balance": 5000,
"code": 0
}
```
#### 12. `cancel_orders`
**About**
Cancel multiple orders at once (up to 256 per request)
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ----------- | ------- | --------- | -------------------------------- |
| `order_ids` | `[]int` | Yes | Order IDs to cancel, maximum 256 |
**Output**
| Field | Type | Description |
| ------------------ | ------- | ------------------------------------- |
| `code` | `int` | Status code |
| `failed_to_cancel` | `[]int` | Order IDs that could not be cancelled |
**Input:**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_ids": [38, 39]
}' 'https://api.clore.ai/v1/cancel_orders'
```
**Output:**
```
{
"failed_to_cancel": [],
"code": 0
}
```
#### 13. `poh_balance`
**About**
Get your Proof of Holding balance: items, totals, and PoH Marketplace offer amounts
**Headers**
| Field | Type | Mandatory | Description |
| ------ | -------- | --------- | ----------- |
| `auth` | `string` | Yes | API token |
**Output**
| Field | Type | Description |
| --------------------------------------------- | ---------- | --------------------------------------- |
| `code` | `int` | Status code |
| `items` | `[]object` | Your PoH items with individual balances |
| `balance.total` | `float` | Total PoH balance across all items |
| `balance.free_amount` | `float` | PoH balance not committed to offers |
| `balance.reward_amount` | `float` | Balance eligible for rewards |
| `balance.offers.rented_amount` | `float` | Amount rented out to other users |
| `balance.offers.rented_on_marketplace_amount` | `float` | Amount listed on the PoH Marketplace |
| `balance.offers.leased_amount` | `float` | Amount leased from other users |
**Input:**
```
curl -XGET -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' 'https://api.clore.ai/v1/poh_balance'
```
**Output:**
```
{
"items": [ { "balance": 5000 } ],
"balance": {
"total": 5000,
"free_amount": 4000,
"reward_amount": 5000,
"offers": {
"rented_amount": 0,
"rented_on_marketplace_amount": 1000,
"rented_finished_amount": 0,
"leased_amount": 0
}
},
"code": 0
}
```
#### 14. `server-config.json`
**About**
Get static API configuration data. No authentication required
**Input:**
```
curl -XGET 'https://api.clore.ai/v1/server-config.json'
```
#### 15. `get_relay`
**About**
Get TCP forwarding relay nodes for your detected country. No authentication required
**Output**
| Field | Type | Description |
| --------- | -------- | --------------------- |
| `code` | `int` | Status code |
| `country` | `string` | Detected country code |
| `nodes` | `object` | Available relay nodes |
**Input:**
```
curl -XGET 'https://api.clore.ai/v1/get_relay'
```
#### 16. `set_order_auto_renew`
**About**
Change the requested rental length, auto-renewal and its price limit of your active on-demand order. Send only the fields you want to change; an omitted field keeps its current value. POST only; a GET answers code `4`.
* The current term then ends at the requested end or at `term_start + term_mrl`, whichever comes first, and never sooner than 60 seconds from now. `mrl` and `term_end` change to match. Running past `term_start + term_mrl` needs `auto_renew`, and the renewal at the end of the term reprices it.
* Lengthening the request past `term_start + term_mrl` is possible only while `auto_renew` is on; otherwise it is refused with `rental_hours_exceeds_mrl`. Changing a set `rental_hours` to `null` while `auto_renew` stays off counts as lengthening, and an edit that switches `auto_renew` off while sending new `rental_hours` that end past `term_start + term_mrl` is refused the same way.
* Shortening the request without switching `auto_renew` off in the same change is always accepted, and so is switching `auto_renew` off without new hours or with `rental_hours: null`. If the new `rental_hours` are already used up, the order ends about a minute after the change. To stop a rental right away, use [`cancel_order`](#id-9-cancel_order).
* `rental_hours: null` removes the requested limit: with `auto_renew` on, the order then runs until you cancel.
* From 60 seconds before the end of a term until the term has renewed or the order has ended, the change is refused with `renewal_in_progress`. Read the order again with [`my_orders`](#id-5-my_orders) and retry.
* On an order created before auto-renewal shipped, the first change sets `term_start` to the creation time and `term_mrl` to the order's `mrl`, so without `auto_renew` it cannot run past its original end.
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ---------------------- | --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `order_id` | `int` | Yes | Unique order ID |
| `rental_hours` | `int` \| `null` | No | New requested length in whole hours (1 to 3000), counted from the order's creation. `null` removes the requested limit. Omit it to keep the current value |
| `auto_renew` | `bool` | No | Renew at the host's current price when the current term ends. Omit it to keep the current value. Turning it on is refused when the server's `auto_renew_allowed` is `false` |
| `auto_renew_max_price` | `float` | Depends | Per-day price limit in the order's currency, above 0 and at most the marketplace's maximum price for that currency. Required when this change turns `auto_renew` on and the order has no limit yet; otherwise omit it to keep the current limit |
**Output**
| Field | Type | Description |
| ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | `int` | Status code. `2` (HTTP 400) when the body has a wrong type, for example a missing or non-integer `order_id`, `rental_hours` that is neither a whole number nor `null`, a non-boolean `auto_renew` or a non-numeric `auto_renew_max_price`; this is checked before any error below |
| `error` | `string` | Present with code `6` (HTTP 200): `you_dont_own_this_order` (the order does not exist or is not yours), `order_not_active` (a spot or closed order, an order being cancelled, or one that ended while the change was being saved), `renewal_in_progress` (the current term ends within 60 seconds, or the order changed while the change was being saved; read the order again and retry), `invalid_rental_hours` (below 1 or above 3000), `rental_hours_exceeds_mrl` (see the rules above), `invalid_auto_renew` (`auto_renew` ends up on without a valid price limit), `auto_renew_not_allowed` (the change turns `auto_renew` on and the server does not allow auto-renewal) |
**Example**
**Input 1 (Keep renewing until cancelled):**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":12345,
"rental_hours":null,
"auto_renew":true,
"auto_renew_max_price":30
}' 'https://api.clore.ai/v1/set_order_auto_renew'
```
**Output 1 (Keep renewing until cancelled):**
```
{
"code": 0
}
```
**Input 2 (Stop renewing, the order ends with its current term):**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":12345,
"auto_renew":false
}' 'https://api.clore.ai/v1/set_order_auto_renew'
```
**Output 2 (Stop renewing, the order ends with its current term):**
```
{
"code": 0
}
```
Sent in the last 60 seconds of a term, the same request is refused until the order has renewed or ended:
```
{ "error": "renewal_in_progress", "code": 6 }
```
#### 17. `order_renewals`
**About**
Get the renewal history of your order: one row per renewal decision taken at a term end, renewed or declined, newest first, at most 1000 rows. An order that never reached a renewal decision returns an empty list, and the end at which an order stops because its requested hours are used up leaves no row. POST only; a GET answers code `4`.
**Headers**
| Field | Type | Mandatory | Description |
| -------------- | -------- | --------- | -------------------------- |
| `auth` | `string` | Yes | API token |
| `Content-type` | `string` | Yes | Must be `application/json` |
**Body**
| Field | Type | Mandatory | Description |
| ---------- | ----- | --------- | --------------- |
| `order_id` | `int` | Yes | Unique order ID |
**Output**
| Field | Type | Description |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `code` | `int` | Status code. `2` (HTTP 400) when `order_id` is missing or not an integer |
| `error` | `string` | `you_dont_own_this_order` with code `6` (HTTP 200) when the order does not exist or is not yours |
| `renewals` | `[]object` | Renewal decisions, newest first; present on success only |
| `renewals[x].order_id` | `int` | Unique order ID |
| `renewals[x].renewal_no` | `int` | The number this renewal has, or would have had, among the order's renewals, counting from 1 |
| `renewals[x].outcome` | `string` | `renewed` or `declined` |
| `renewals[x].reason` | `string` | Declined rows only: `price_above_cap`, `server_unlisted`, `host_disallowed`, `server_reserved` or `insufficient_balance` (see `orders[x].auto_renew_declined` in [`my_orders`](#id-5-my_orders)) |
| `renewals[x].decided_at` | `int` | UNIX time of the decision, taken when the term had ended |
| `renewals[x].applied_at` | `int` | UNIX time the renewal was confirmed to have taken effect. Absent on a decline and on a renewal decision that was not confirmed; a decision can stay unapplied when the order was cancelled or changed at the same moment |
| `renewals[x].old_price` | `float` | Per-day price of the term that ended |
| `renewals[x].new_price` | `float` | Per-day price of the new term, or on a decline the host's price that was declined; absent when no price could be computed |
| `renewals[x].cap` | `float` | Your per-day price limit when the decision was taken |
| `renewals[x].term_seconds` | `int` | Length of the new term in seconds; `0` on a decline |
| `renewals[x].term_start` | `int` | UNIX time the new term starts (the end of the previous one); on a decline, the start of the term that ended |
| `renewals[x].term_end` | `int` | UNIX time the new term ends; on a decline, the end of the term that ended |
**Example**
**Input:**
```
curl -XPOST -H 'auth: b8qwqRAL5W7YDyDJeB4XANVvKndbrrPk' -H "Content-type: application/json" -d '{
"order_id":12345
}' 'https://api.clore.ai/v1/order_renewals'
```
**Output:**
In this example the order renewed once at 24 per day, within its limit of 30. At the end of that term the host's price was 36, above the limit, so the renewal was declined and the order ended with that term.
```
{
"renewals": [
{
"order_id": 12345,
"renewal_no": 2,
"outcome": "declined",
"reason": "price_above_cap",
"decided_at": 1792209661,
"old_price": 24,
"new_price": 36,
"cap": 30,
"term_seconds": 0,
"term_start": 1792188060,
"term_end": 1792209660
},
{
"order_id": 12345,
"renewal_no": 1,
"outcome": "renewed",
"decided_at": 1792188061,
"applied_at": 1792188061,
"old_price": 20,
"new_price": 24,
"cap": 30,
"term_seconds": 21600,
"term_start": 1792188060,
"term_end": 1792209660
}
],
"code": 0
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.clore.ai/for-hosts/api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
