Get List of Orders

GET

orders

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Subaccount-Id

string

If present, scopes the operation to the subaccount with given id. See Subaccounts for more info.

Query Parameters

limit

integer | null

default: 20

Limits the number of orders returned, default is 20, max is 100

Required range: 1 < x < 100

starting_after

string | null

If specified, returns orders submitted before (earlier than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

ending_before

string | null

If specified, returns orders submitted after (later than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

Response

200 - application/json

data

object[]

data.id

string

Identifier that can be used to retrieve the order details

data.order_number

string

Hex representation derived from the order id that will be shown on the certificate

data.created_on

string

Timestamp of when the order was created (in UTC)

data.metadata

string | null

Optional metadata that was provided with the order

Maximum length: 512

data.description

string | null

Optional public description for the order that will be shown on the certificate, as provided when order was placed

Maximum length: 512

data.amount_kg

number

Amount of credits purchased, in kg of CO<sub>2</sub>e

data.state

enum<string>

The current state of the order.

placed - the order has been placed, and is waiting to be matched against available credits in our system.
fulfilled - the order has been fulfilled by matching it against available credits in our system, which have been retired.
canceled - the order has been canceled

Available options:

placed,

fulfilled,

cancelled

data.price_usd_cents

number

Amount charged for the credits purchased, in cents (integer)

data.callback_url

string

Callback URL to invoke when status of the order changes, if specified in the order

data.certificate_public_url

string | null

URL for the publicly accessible page showing order details and the certificate. This will be null if the order state is cancelled

data.certificate_download_public_url

string | null

URL for downloading the certificate PDF. This will be null if the order state is cancelled

data.project_allocations

object[]

For fulfilled orders, a list of the projects that were used to fulfill the order

data.project_allocations.project

object

Details of the project for this allocation

data.project_allocations.amount_kg

number

Amount (in kg CO<sub>2</sub>e) of the order fulfilled from this project

data.project_allocations.retirements

object[]

List of retirement records for this project allocation

data.checkout_session_id

string | null

Id of the checkout session whose completion resulted in the creation of this order. Null if the order did not originate from a checkout session.

Overview Create Carbon Credits Order

API Documentation

Orders

Quotes

Subaccounts

Checkout Sessions

Climate Impact

Projects

Portfolios

Authorizations

Headers

Query Parameters

Response