POST
/
v1
/
quotes
{
    "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/"
            },
        }
    }
]

​
Headers

​
api-key
string
required

Authorisation requires an API key in the header of the request. Please see this page for more information.

​
Request Fields

​
account_id
uuid
required

A unique ID assigned to the account. This identifier is used to reference the account within the system.

​
emissions_in_kg
long
required

The amount of carbon emissions to be offset, specified in kilograms and as a whole number.

Minimum Value: 1

Maximum Value: 10,000

​
currency
string
required

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

​
quote_id
uuid

A unique ID assigned to the quote. This identifier is used to reference the quote within the system.

​
total_cost
decimal

The total cost required to offset the specified carbon emissions.

​
provider_cost
decimal

The base cost required by the carbon provider to offset the specified carbon emissions.

​
service_cost
decimal

The service fee applied to all carbon orders.

​
currency
string

The currency in which the cost is denominated. This field specifies the monetary unit used for the offsetting cost.

​
emissions_in_kg
long

The amount of carbon emissions to be offset, specified in kilograms.

​
portfolio
object
{
    "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/"
            },
        }
    }
]