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": "org_1GB56M1ST1S0GVNA",
  "credit_batch_quantities": [
    {
      "credit_batch_id": "ctb_1DRBTYA8Q1S07CBY",
      "credit_quantity_kg": 1000
    }
  ],
  "notes": "Retired with care.",
  "owner_organisation_id": "org_1GB56M1ST1S0GVNA",
  "retirement_purposes": [
    "corporate_targets"
  ],
  "supplier_id": "spl_1CC712KFS1S0YKPS"
}'
{
  "beneficiary": {
    "domain": "isometric.com",
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric"
  },
  "credit_batch_size_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "id": "ret_1FYBH4QDT1S0SVKF",
  "notes": "<string>",
  "owner": {
    "domain": "isometric.com",
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric"
  },
  "purposes": [
    "corporate_targets"
  ],
  "retired_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

A 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

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

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.

Required string length: 20 - 36
Example:

"org_1GB56M1ST1S0GVNA"

​
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.

Maximum length: 256
Example:

"Retired with care."

​
owner_organisation_id
string
required

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

Required string length: 20 - 36
Example:

"org_1GB56M1ST1S0GVNA"

​
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.

Required string length: 20 - 36
Example:

"spl_1CC712KFS1S0YKPS"

Response

200
application/json
Successful Response
​
beneficiary
object
required
​
credit_batch_size_total
object
required
​
id
string
required
Required string length: 20 - 36
Example:

"ret_1FYBH4QDT1S0SVKF"

​
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
​
url
string
required

Was this page helpful?