Get Order By Id
Returns information about an order
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
If present, scopes the operation to the subaccount with given id. See Subaccounts for more info.
Path Parameters
ID of order to return
"Gre28Fc35bt3"
Response
Identifier that can be used to retrieve the order details
"Gre28Fc35bt3"
Hex representation derived from the order id that will be shown on the certificate
"47726-53238-46633-33562-7433"
Timestamp of when the order was created (in UTC)
Optional metadata that was provided with the order
512
"internal_order_id=12345"
Optional public description for the order that will be shown on the certificate, as provided when order was placed
512
"on behalf of Jane Smith"
Amount of credits purchased, in kg of CO₂e
10.5
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
placed
, fulfilled
, cancelled
Amount charged for the credits purchased, in USD cents
2350
Callback URL to invoke when status of the order changes, if specified in the order
URL for the publicly accessible page showing order details and the certificate. This will be null if the order state is cancelled
"https://registry.cnaught.com/orders/ABCDE"
URL for downloading the certificate PDF. This will be null if the order state is cancelled
"https://registry.cnaught.com/api/certificates/ABCDE/pdf"
For fulfilled orders, a list of the projects that were used to fulfill the order
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.
"zpQ6QSNRQh"