Create quote

Generate an impact quote that is not tied to a transaction.

This endpoint locks in pricing and rates for sustainability contributions and carbon credits. It does not calculate a footprint or quote amounts: the quote is a rate card and amounts are supplied at funds allocation. Use it when there is no purchase to quote against.

The returned quote must be used during funds allocation. One quote can be allocated funds once.

Sending sessionReference is optional but recommended. It ties the quotes for one order, cart or checkout together, so quotes sharing a reference are grouped as one session and can be matched back to your own records.

Each quote includes sustainability contribution rates and a rate card for each credit type the organisation's portfolio can fund. The credits and contribution blocks are only present when the portfolio funds them, so treat each block as optional and ignore any you do not handle.

Body Params
uuid
required
string
length between 1 and 255

Optional but recommended. Ties the quotes for one order, cart or checkout together: quotes sent with the same reference belong to one session. Use a value unique to the session.

Do not include personal data.

string
required
length between 3 and 3

Currency the quote is priced in. All rates and unit prices in the response apply to amounts in this currency.

consumer
object
required

The consumer making the transaction.

string
Defaults to en-GB

Locale used to localise impact partner copy in the response. If the requested locale is not supported, it defaults to en-GB.

projectFilters
object | null
responseOptions
object | null
Headers
string
required
^\d{4}-\d{2}-\d{2}\.[a-z]+$
Defaults to 2026-10-06.pangolin

The API version the request was built against, as YYYY-MM-DD.animal. Required on every request. See Versioning.

string
length between 1 and 255

Optional but recommended on every POST. A retry that carries the same key returns the first attempt's outcome instead of performing the operation twice.

Reuse the key on every retry. A different request needs a different key. See Idempotency.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json