Authorisation requires an API key in the header of the request. Please see this page for more information. Request Fields A unique ID assigned to the account. This identifier is used to reference the account within the system.
The amount of carbon emissions to be offset, specified in kilograms and as a whole number. Minimum Value : 1Maximum Value : 10,000
The currency you would like the quote to be returned in. This must be ISO 4217. Possible Values : GBP, USD, EUR, CAD or ZAR.
Response Fields A unique ID assigned to the quote. This identifier is used to reference the quote within the system.
The total cost required to offset the specified carbon emissions.
The base cost required by the carbon provider to offset the specified carbon emissions.
The service fee applied to all carbon orders.
The currency in which the cost is denominated. This field specifies the monetary unit used for the offsetting cost.
The amount of carbon emissions to be offset, specified in kilograms.
The name of the portfolio. This field identifies the portfolio by its designated title.
A brief summary of the portfolio. This field provides a concise overview of what the portfolio entails.
carbon_portfolio_description
A detailed description of the portfolio. This field includes comprehensive information about the portfolio’s contents and objectives.
carbon_portfolio_image_url
An image of the portfolio. This field is nullable.
The name of the carbon offset provider. This field specifies the organization responsible for providing the carbon offset services.
The official website of the carbon offset provider. This URL directs to the provider’s online presence where more information can be obtained.
{ "account_id" : "09569fa2-b2b2-449d-af8b-24bc3694ecbc" , "emissions_in_kg" : 1000 , "currency" : "GBP" } [ { "quote_id" : "09569fa2-b2b2-449d-af8b-24bc3694ecbc" , "total_cost" : "24.00" , "provider_cost" : "20.00" , "service_cost" : "4.00" , "currency" : "GBP" , "emissions_in_kg" : 1000 , "portfolio" : { "name" : "Example Portfolio" , "carbon_portfolio_summary" : "Example Portfolio Summary" , "carbon_portfolio_description" : "Example Portfolio Description" "carbon_portfolio_image_url" : "https://example.com" "carbon_provider" : { "name" : "Example Provider" , "website" : "https://example.com/" }, } } ]
