Cancel Order

When cancelling an order that has been fulfilled, a credit for the price of the order will be applied to the current invoice. This means that it is possible for the credit for a cancellation to appear on the invoice of the following billing period. For example, if a billing period ends between when the order was placed and when it is cancelled, then the credit will be applied to the latter billing period rather than the one during which the order was placed.

POST/orders/{id}/cancel

Authorizations#

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your CNaught API key.

Headers#

X-Subaccount-Id

string

If present, will only cancel the order if it belongs to the subaccount with given id.

Idempotency-Key

string

If present, a unique identifier that allows you to retry a request multiple times while only performing the action once. See Idempotency for more info.

Path Parameters#

string

required

ID of order to cancel

Response#

200

Order Details

Show response attributes

string

Identifier that can be used to retrieve the order details

order_number

string

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

created_on

string

Timestamp of when the order was created (in UTC)

metadata

string | null

Optional metadata that was provided with the order

description

string | null

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

amount_kg

number

Amount of credits purchased, in kg of CO₂e

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

Options:

placedfulfilledcancelled

price_usd_cents

number

Amount charged for the credits purchased, in USD cents

callback_url

string

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

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

certificate_download_public_url

string | null

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

project_allocations

ProjectAllocation[]

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

Show child attributes

project

Project

Details of the project for this allocation

Show child attributes

string

Identifier that can be used to retrieve the project details

name

string

Name of the project

summary

string | null

A short summary of the project

description

string | null

A longer description of the project

type

string

Type of project, eg Afforrestation, Renewable Energy, etc

activity_types

string[]

List of activity types for the project

developer

string | null

The name of the company or organization sponsoring the project

registry_name

string | null

The name of the registry on which the project's credits are registered

registry_id

string | null

The id of the project within the registry

registry_url

string | null

The full url to the project's documentation on the registry website

location_name

string | null

Location of the project

location_latitude

number | null

Latitude for the location of the project

location_longitude

number | null

Longitude for the location of the project

primary_image_url

string | null

URL for the primary image of the project

un_sdg_goals

number[]

list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals

methodology

string | null

The methodology used for the project

verifier

string | null

The verifier of the project

permanence

string | null

Information about the permanence of the carbon removal

lifetime

object

The lifetime of the project

Show child attributes

impact_type

string | null

The type of impact the project has (avoided emissions, removal, or mix of both)

due_diligence

string | null

Information about the due diligence performed on the project

beyond_carbon

string | null

Information about benefits beyond carbon reduction

risk_of_reversal

string | null

Information about the risk of carbon reversal

third_party_labels

string[] | null

List of third-party labels or certifications

notable_buyers

object[] | null

List of notable buyers of credits from this project

Show child attributes

due_diligence_figure

object | null

Figure illustrating due diligence information

Show child attributes

news_articles

object[] | null

List of news articles related to the project

Show child attributes

amount_kg

number

Amount (in kg CO₂e) of the order fulfilled from this project

retirements

Retirement[]

List of retirement records for this project allocation

Show child attributes

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.

Get Order By Id

Get Quote by Emissions Mass

Cancel Order

curl --request POST \
  --url https://api.cnaught.com/v1/orders/<id>/cancel \
  --header 'Authorization: Bearer <token>'

{
  "id": "Gre28Fc35bt3",
  "order_number": "47726-53238-46633-33562-7433",
  "created_on": "2022-08-01T18:00:00.000000Z",
  "metadata": "Customer metadata",
  "description": "On behalf of Jane Smith",
  "amount_kg": 10.5,
  "state": "cancelled",
  "price_usd_cents": 2350,
  "certificate_public_url": null,
  "certificate_download_public_url": null
}