Gets a list of offset orders in reverse chronological order up to the provided limit number of orders per call.
Pagination is supported by passing the first order id from a previous call into ending_before to retrieve the
previous page, or the last order id from a previous call into starting_after to retrieve the next page.
List of Offset orders
Bad Request
Request Unauthorized
{- "data": [
- {
- "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": "fulfilled",
- "price_usd_cents": 2350,
}
]
}Places an order for carbon offsets by specifying the amount of offsets (in kilograms).
The order will remain in the placed state until it can be matched to available offsets.
| X-Subaccount-Id | string If present, the new order will be associated with 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. |
Order Parameters
Order Details
Bad Request
Request Unauthorized
Forbidden - Billing Not Set Up or Requested Portfolio not Available for the User
Concurrent Requests with Same Idempotency Key
Mismatched Requests with Same Idempotency Key
{- "metadata": "example metadata",
- "description": "On behalf of Jane Smith",
- "amount_kg": 100.5,
}{- "id": "Gre28Fc35bt3",
- "order_number": "47726-53238-46633-33562-7433",
- "amount_kg": 100,
- "metadata": "Customer metadata",
- "price_usd_cents": 2350
}Places an order for carbon offsets for a vehicle ride of the given distance (in kilometers).
The order will remain in the placed state until it can be matched to available offsets.
| X-Subaccount-Id | string If present, the new order will be associated with 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. |
Order Parameters
Order Details
Bad Request
Request Unauthorized
Forbidden - Billing Not Set Up or Requested Portfolio not Available for the User
Concurrent Requests with Same Idempotency Key
Mismatched Requests with Same Idempotency Key
{- "metadata": "example metadata",
- "distance_km": 10.5,
}{- "id": "XYZ",
- "metadata": "Customer metadata",
- "amount_kg": 15,
- "price_usd_cents": 2350,
- "state": "placed"
}Returns information about an offset order
Offset Order Details
Request Unauthorized
Order Not Found
{- "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": "placed",
- "price_usd_cents": 2350
}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.
| 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. |
Order Details
Request Unauthorized
Forbidden Due to Order Already Cancelled
Order Not Found
Concurrent Requests with Same Idempotency Key
Mismatched Requests with Same Idempotency Key
{- "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
}Get a price quote for offsetting given amount of CO2.
Quote Parameters
Quote Details
Bad Request
Request Unauthorized
{- "amount_kg": 8.5
}{- "amount_kg": 8.5,
- "price_usd_cents": 10
}Get a price quote for offsetting a vehicle ride. Will return amount of CO2 and price for offsetting a ride with given parameters.
Quote Parameters
Quote Details
Bad Request
Request Unauthorized
{- "distance_km": 10.5
}{- "amount_kg": 15,
- "price_usd_cents": 2350
}Endpoints for retrieving climate impact data and hosted public impact page configuration
Returns information about the total climate impact of the carbon credit purchases for this account (or a subaccount). This is the underlying information that is displayed on the hosted public impact page for the account / subaccount.
Impact Data
Request Unauthorized
{- "name": "Acme, Inc",
- "total_offset_kgs": 100000,
- "equivalents": {
- "cars_off_the_road": 10,
- "trees_planted": 30,
- "homes_annual_energy usages": 4,
- "flights_lax_to_nyc": 12
}, - "since_date": "2023-01-01T18:00:00.000000Z",
- "categories": [
- {
- "category": {
- "id": "XBfyJ8",
- "name": "Oxford Type 5 - Carbon Removal, Long-Term Storage"
}, - "offset_kgs": 100000,
- "projects": [
- {
- "project": {
- "id": "tbCjWP",
- "name": "Fuzhou Hongmiaoling Landfill Gas to Electricity Project",
- "summary": "This project collects landfill gas to generate 2.5MW of electricity at a landfill in southeastern China, avoiding the emission of methane (a potent greenhouse gas) into the atmosphere and using the methane to generate power and displace dirtier coal-fired power in the electric grid.",
- "description": "This project supports collection of landfill gas and generation of 2.5MW of electricity at a landfill in Fuzhou City in Fujian Province in southeastern China. The landfill received waste from 1995 until 2008, and—like most landfills—throws off methane as some of that waste decomposes. Credits are generated from two pieces of the project: (1) avoiding the emissions of methane (a potent greenhouse gas) into the atmosphere and (2) using the power generated from the methane (natural gas) to displace dirtier coal-fired power coming from the electric grid. The project clearly required carbon revenues to achieve these two goals and therefore generates high-quality carbon offsets.",
- "developer": "Fujian Tianyi Renewable Energy Technology & Utilization Co., Ltd.",
- "location_latitude": 26.0833,
- "location_longitude": 119.3,
- "location_name": "Fujian Province, China",
- "registry_id": "253",
- "registry_name": "Verra",
- "type": "Landfill Gas",
- "un_sdg_goals": [ ]
}, - "offset_kgs": 100000,
- "vintages": "2023"
}
]
}
]
}Returns information about the hosted public climate impact page configuration for the account (or a subaccount)
Impact Hosted Page Configuration
Request Unauthorized
{- "enabled": true,
- "enabled_equivalents": [
- "homes",
- "flights"
],
}Gets a list of subaccounts in reverse chronological order up to the provided limit number of subaccounts per call.
Pagination is supported by passing the first subaccount id from a previous call into ending_before to retrieve
the previous page, or the last subaccount id from a previous call into starting_after to retrieve the next page.
List of Subaccounts
Bad Request
Request Unauthorized
{- "data": [
- {
- "id": "5nubL0NS",
- "name": "Marketing Department",
- "default_portfolio_id": "mHvNvWbq",
- "created_on": "2023-08-01T18:00:00.000000Z"
}
]
}Creates a new Subaccount.
| 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. |
Subaccount Parameters
Subaccount Details
Invalid default portfolio ID
Request Unauthorized
Concurrent Requests with Same Idempotency Key
Mismatched Requests with Same Idempotency Key
{- "name": "Marketing Department",
- "default_portfolio_id": "mHvNvWbq"
}{- "id": "5nubL0NS",
- "name": "Marketing Department",
- "default_portfolio_id": "mHvNvWbq"
}Returns information about a subaccount
Subaccount Details
Request Unauthorized
Subaccount Not Found
{- "id": "5nubL0NS",
- "name": "Marketing Department",
- "default_portfolio_id": "mHvNvWbq"
}