Skip to main content
POST
Create Offset Order

Headers

x-api-key
string
required

API key for authentication

x-body-signature
string
required

Signature of the request body signed with API secret (private key)

Body

application/json
emission_amount
number
required

Amount of carbon credits to purchase

Required range: x >= 0
emission_unit
enum<string>
default:kgCO2

Unit of measurement for emissions (defaults to kgCO2 if not specified)

Available options:
kgCO2,
tonCO2e
callback_url
string<uri>

URL to receive webhook notifications about order status changes

user
object

User information

Response

Order created successfully

order_id
string

Unique identifier for the order

emission_amount
number

Amount of emissions to offset

emission_unit
string

Unit of emission measurement

user
object
callback_url
string<uri>

URL to receive webhook notifications about order status changes

payment_url
string<uri>

URL to complete the payment

created_at
string<date-time>

Order creation timestamp