POST
/
retirements
curl --request POST \
  --url https://api.sandbox.isometric.com/registry/v0/retirements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "beneficiary_organisation_id": "pfx_1H0G39139CF0DZB2",
  "credit_batch_quantities": [
    {
      "credit_batch_id": "pfx_1H0G39139CF0DZB2",
      "credit_quantity_kg": 1000
    }
  ],
  "notes": "Retired with care.",
  "owner_organisation_id": "pfx_1H0G39139CF0DZB2",
  "retirement_purposes": [
    "corporate_targets"
  ],
  "supplier_id": "pfx_1H0G39139CF0DZB2"
}'
{
  "beneficiary": {
    "domain": "isometric.com",
    "id": "abc_1H0G39139CF0DZB2",
    "name": "Isometric"
  },
  "credit_batch_size_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "id": "abc_1H0G39139CF0DZB2",
  "notes": "<string>",
  "owner": {
    "domain": "isometric.com",
    "id": "abc_1H0G39139CF0DZB2",
    "name": "Isometric"
  },
  "purposes": [
    "corporate_targets"
  ],
  "retired_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
headerrequired

An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Body

application/json
beneficiary_organisation_id
string
required

The ID of the organisation that the credits will be retired in the name of, this can be the same as owner_organisation_id.

credit_batch_quantities
object[]
required

A list of credit batch IDs and kilogram amounts of each to retire.

notes
string | null
required

A publicly visible note stored with the credit retirement.

owner_organisation_id
string
required

The ID of the organisation owns the credits to be retired. Typically this would be your own organisation ID.

retirement_purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
regulatory_requirement,
other
supplier_id
string
required

All credits in a retirement must originate from the same supplier.

Response

200 - application/json
beneficiary
object
required
credit_batch_size_total
object
required
id
string
required
notes
string | null
required
owner
object
required
purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
regulatory_requirement,
other
retired_at
string
required

Was this page helpful?

ProjectRetirement