curl --request POST \
  --url https://api.cnaught.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": "example metadata",
  "description": "On behalf of Jane Smith",
  "amount_kg": 100.5,
  "notification_config": {
    "url": "https://www.example.com/callback"
  }
}'

{
  "id": "Gre28Fc35bt3",
  "order_number": "47726-53238-46633-33562-7433",
  "amount_kg": 100,
  "metadata": "Customer metadata",
  "price_usd_cents": 2350
}

Orders

Create Carbon Credits Order

Places an order for the specified amount of carbon credits (in kilograms), or for the specified total price (in USD cents). The order will remain in the placed state until it can be matched to available credits, after which the order will be fulfilled and moved to the fulfilled state. If specifying total price, we will determine the amount of carbon credits based on the unit price of the portfolio used for the order. Because the amount must be an integer number of kilograms, the final actual total price might be slightly different than the specified total price.

POST

orders

curl --request POST \
  --url https://api.cnaught.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": "example metadata",
  "description": "On behalf of Jane Smith",
  "amount_kg": 100.5,
  "notification_config": {
    "url": "https://www.example.com/callback"
  }
}'

{
  "id": "Gre28Fc35bt3",
  "order_number": "47726-53238-46633-33562-7433",
  "amount_kg": 100,
  "metadata": "Customer metadata",
  "price_usd_cents": 2350
}

Authorizations

Authorization

string

header

required

Headers

X-Subaccount-Id

string

Idempotency-Key

string

Body

application/json

Order By Amount
Order by Price

amount_kg

number

required

Examples:

metadata

string | null

Maximum length: 512

Examples:

description

string | null

Maximum length: 512

Examples:

notification_config

object | null

Show child attributes

portfolio_id

string | null

Examples:

Response

string

Examples:

order_number

string

Examples:

created_on

string

metadata

string | null

Maximum length: 512

Examples:

description

string | null

Maximum length: 512

Examples:

amount_kg

number

Examples:

state

enum<string>

Available options:

placed,

fulfilled,

cancelled

price_usd_cents

number

Examples:

callback_url

string

certificate_public_url

string | null

Examples:

certificate_download_public_url

string | null

Examples:

project_allocations

object[]

Show child attributes

checkout_session_id

string | null

Examples:

Get List of Orders Create Carbon Credits Order for Vehicle Ride

⌘I

API Documentation

Orders

Quotes

Subaccounts

Checkout Sessions

Climate Impact

Projects

Portfolios

Create Carbon Credits Order

Authorizations

Headers

Body

Response