CompensateOrder

Use this call to compensate an order — at the end of the month we will send you an invoice for the total compensation amount

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supply the compensation amount the customer paid or in case of merchant paying, the amount you are willing and agreed to pay for this order.

Supplying the orderlineitems is optional and the data will be used for

  1. reference checks - we are proactively improving our estimation algorithms and we prioritise items that are more frequently purchased
  2. analytics and reporting on your company’s offsets - ex. we can build a report about the level of climate contributions per product category

We can also accept 0 as Amount. In those cases, we will require you to send some line items, as we will register the order but without a compensation being made. This can be useful for us to provide insights about your business being able to analyse all orders and the footprint of them even when no compensations were made.

Body Params
string
required

The unique ID of your order

string
required
Defaults to EUR

The currency of this order in ISO 4217 e.g. EUR or USD.

int32
required

The compensation already paid over this order usually by the customer. This is useful if you use get order footprint and customers compensate orders.

lineItems
array of objects
lineItems
string

User ID is optional, but if you provide it, we will be able to calculate how much a particular customer of yours contributed. In the future, this information will be available in the dashboard.

Headers
string
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json