API Reference

Offboard site and assets

Offboard a site and all its associated assets in a single operation.

Unenrols from every proposition, and deletes the site and assets in accordance with data retention policies.

Use when the user is leaving entirely — for example, they’ve moved house, or your support team is removing them. Payments can no longer be accessed afterwards.

If the user is only opting out of one proposition (e.g. toggling Flex Lite off in your app), use unenrol instead — it preserves the site and any other propositions they’re enrolled in.

POST

entities

site

{site_id}

offboard-site-and-assets

Offboard Site And Assets

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/offboard-site-and-assets \
  --header 'Authorization: Bearer <token>'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [],
    "dispatch_methods": [],
    "tariff": {
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id

string<uuid>

required

Response

Successfully offboarded site and asset

Response model for onboarding operation.

site

Site · object

required

Created site details

Show child attributes

asset

Asset · object

required

Created asset details

Show child attributes

Get balance withdrawal URLGet a temporary link to an Axle-hosted form through which users can view and withdraw rewards. Requires an organisational bearer token.

⌘I

Offboard Site And Assets

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/offboard-site-and-assets \
  --header 'Authorization: Bearer <token>'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [],
    "dispatch_methods": [],
    "tariff": {
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}