API Reference

CompensateOrder

put
https://api.climateclick.com/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…
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

Updated 11 months ago

What’s Next

Great, you are almost there! Just a cancel order is left in case you need to cancel the compensation of an order.

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

Updated 11 months ago

What’s Next

Great, you are almost there! Just a cancel order is left in case you need to cancel the compensation of an order.