POST
/
v1
/
orders
/
cancel
{
    "order_id": "28d816c1-49ed-6173-f5bd-c6beefaf3a41",
    "account_id": "be564a30-8eb0-fecb-57c2-775b5509f464"
}

{
    "order_id": "f49ca591-6c4f-46ae-a56e-fa94b0ac0520",
    "emissions_in_kg": 1000,
    "total_cost": "20.00",
    "currency": "GBP",
    "status": "CANCELLED",
    "account_id": "09569fa2-b2b2-449d-af8b-24bc3694ecbc",
    "created_at": "2024-06-10T16:35:49.644304",
    "cancelled_at": "2024-06-10T16:35:49.644304",
}

​
Headers

​
api-key
string
required
Authorisation requires an API key in the header of the request. Please see this page for more information.

​
Request Fields

​
order_id
uuid
required
A unique ID assigned to the order. This identifier is used to reference the order within the system.
​
account_id
uuid
required
A unique ID assigned to the account. This identifier is used to reference the account within the system.

​
Response Fields

​
order_id
uuid
A unique ID assigned to the order. This identifier is used to reference the order within the system.
​
emissions_in_kg
long
The amount of carbon emissions to be offset, specified in kilograms.
​
total_cost
decimal
The total cost required to offset the specified carbon emissions.
​
currency
string
The currency in which the cost is denominated. This field specifies the monetary unit used for the offsetting cost.
​
status
string
The status of the order. This field specifies the status that the order is currently in. An order can be in one of the following states: INITIATED, UNFULFILLED, FULFILLED or CANCELLED.
​
account_id
uuid
A unique ID assigned to the account. This identifier is used to reference the account within the system.
​
created_at
timestamp
The date and time when the order was created. This timestamp is recorded in UTC and used for tracking the orders creation date.
​
cancelled_at
timestamp
The date and time when the order was cancelled. This timestamp is recorded in UTC and used for tracking the orders cancellation date. This field is nullable.
{
    "order_id": "28d816c1-49ed-6173-f5bd-c6beefaf3a41",
    "account_id": "be564a30-8eb0-fecb-57c2-775b5509f464"
}

{
    "order_id": "f49ca591-6c4f-46ae-a56e-fa94b0ac0520",
    "emissions_in_kg": 1000,
    "total_cost": "20.00",
    "currency": "GBP",
    "status": "CANCELLED",
    "account_id": "09569fa2-b2b2-449d-af8b-24bc3694ecbc",
    "created_at": "2024-06-10T16:35:49.644304",
    "cancelled_at": "2024-06-10T16:35:49.644304",
}