Refresh incentives

curl --request POST \
  --url https://api.leap.energy/beta/incentives/refreshes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "<string>",
  "customer_details": {},
  "customer_devices": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_device_reference": "<string>",
      "details": {}
    }
  ],
  "remove_customer_device_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "remove_device_references": [
    "<string>"
  ],
  "eiaid": "<string>",
  "create_application": false
}
'

import requests

url = "https://api.leap.energy/beta/incentives/refreshes"

payload = {
    "reference_id": "<string>",
    "customer_details": {},
    "customer_devices": [
        {
            "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "partner_device_reference": "<string>",
            "details": {}
        }
    ],
    "remove_customer_device_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "remove_device_references": ["<string>"],
    "eiaid": "<string>",
    "create_application": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reference_id: '<string>',
    customer_details: {},
    customer_devices: [
      {
        device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        customer_device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        partner_device_reference: '<string>',
        details: {}
      }
    ],
    remove_customer_device_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    remove_device_references: ['<string>'],
    eiaid: '<string>',
    create_application: false
  })
};

fetch('https://api.leap.energy/beta/incentives/refreshes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leap.energy/beta/incentives/refreshes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reference_id' => '<string>',
    'customer_details' => [
        
    ],
    'customer_devices' => [
        [
                'device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'customer_device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'partner_device_reference' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'remove_customer_device_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'remove_device_references' => [
        '<string>'
    ],
    'eiaid' => '<string>',
    'create_application' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leap.energy/beta/incentives/refreshes"

	payload := strings.NewReader("{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.leap.energy/beta/incentives/refreshes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.leap.energy/beta/incentives/refreshes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}"

response = http.request(request)
puts response.read_body

{
  "reference_id": "<string>",
  "customer_classification": "RESIDENTIAL",
  "customer_devices": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_device_reference": "<string>",
      "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "incentive_summary": {
    "upfront_amount": 123,
    "install_amount": 123,
    "ongoing_amount": 123
  },
  "utilities": {
    "primary": {
      "eiaid": "<string>",
      "name": "<string>",
      "state": "<string>"
    },
    "possible_utilities": [
      {
        "eiaid": "<string>",
        "name": "<string>",
        "state": "<string>"
      }
    ]
  },
  "program_details": [
    {
      "name": "<string>",
      "upfront_amount": 123,
      "install_amount": 123,
      "ongoing_amount": 123,
      "tiers": [
        {
          "tier_id": "<string>",
          "payment_type": "UPFRONT",
          "incentive_amount": 123,
          "device_results": [
            {
              "partner_device_reference": "<string>",
              "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "status": "<string>",
              "eligibility_details": [
                {
                  "requirement": "<string>",
                  "status": "<string>",
                  "code": "<string>",
                  "reason": "<string>",
                  "source_program_identifier": "<string>",
                  "expected_values": [
                    "<string>"
                  ],
                  "actual_value": "<string>",
                  "operator": "<string>",
                  "severity": "<string>"
                }
              ]
            }
          ],
          "tier_name": "<string>"
        }
      ],
      "operator_name": "<string>",
      "device_category": "<string>",
      "display_name": "<string>",
      "logo_url": "<string>",
      "terms_url": "<string>",
      "description": "<string>",
      "is_partner_offer": true,
      "covered_programs": [
        {
          "identifier": "<string>",
          "name": "<string>"
        }
      ],
      "program_identifier": "<string>",
      "included_leap_program_ids": [
        "<string>"
      ]
    }
  ],
  "connect_url": "<string>",
  "geocoding": {
    "latitude": 123,
    "longitude": 123,
    "formatted_address": "<string>"
  },
  "partner": {
    "name": "<string>",
    "logo_url": "<string>"
  },
  "devices_ignored": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reason": "NOT_ON_EXISTING_CUSTOMER",
      "partner_device_reference": "<string>"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

POST

beta

incentives

refreshes

Refresh incentives

curl --request POST \
  --url https://api.leap.energy/beta/incentives/refreshes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "<string>",
  "customer_details": {},
  "customer_devices": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_device_reference": "<string>",
      "details": {}
    }
  ],
  "remove_customer_device_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "remove_device_references": [
    "<string>"
  ],
  "eiaid": "<string>",
  "create_application": false
}
'

import requests

url = "https://api.leap.energy/beta/incentives/refreshes"

payload = {
    "reference_id": "<string>",
    "customer_details": {},
    "customer_devices": [
        {
            "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "partner_device_reference": "<string>",
            "details": {}
        }
    ],
    "remove_customer_device_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "remove_device_references": ["<string>"],
    "eiaid": "<string>",
    "create_application": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reference_id: '<string>',
    customer_details: {},
    customer_devices: [
      {
        device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        customer_device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        partner_device_reference: '<string>',
        details: {}
      }
    ],
    remove_customer_device_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    remove_device_references: ['<string>'],
    eiaid: '<string>',
    create_application: false
  })
};

fetch('https://api.leap.energy/beta/incentives/refreshes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leap.energy/beta/incentives/refreshes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reference_id' => '<string>',
    'customer_details' => [
        
    ],
    'customer_devices' => [
        [
                'device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'customer_device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'partner_device_reference' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'remove_customer_device_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'remove_device_references' => [
        '<string>'
    ],
    'eiaid' => '<string>',
    'create_application' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leap.energy/beta/incentives/refreshes"

	payload := strings.NewReader("{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.leap.energy/beta/incentives/refreshes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.leap.energy/beta/incentives/refreshes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reference_id\": \"<string>\",\n  \"customer_details\": {},\n  \"customer_devices\": [\n    {\n      \"device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"customer_device_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"partner_device_reference\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"remove_customer_device_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_device_references\": [\n    \"<string>\"\n  ],\n  \"eiaid\": \"<string>\",\n  \"create_application\": false\n}"

response = http.request(request)
puts response.read_body

{
  "reference_id": "<string>",
  "customer_classification": "RESIDENTIAL",
  "customer_devices": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_device_reference": "<string>",
      "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "incentive_summary": {
    "upfront_amount": 123,
    "install_amount": 123,
    "ongoing_amount": 123
  },
  "utilities": {
    "primary": {
      "eiaid": "<string>",
      "name": "<string>",
      "state": "<string>"
    },
    "possible_utilities": [
      {
        "eiaid": "<string>",
        "name": "<string>",
        "state": "<string>"
      }
    ]
  },
  "program_details": [
    {
      "name": "<string>",
      "upfront_amount": 123,
      "install_amount": 123,
      "ongoing_amount": 123,
      "tiers": [
        {
          "tier_id": "<string>",
          "payment_type": "UPFRONT",
          "incentive_amount": 123,
          "device_results": [
            {
              "partner_device_reference": "<string>",
              "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "status": "<string>",
              "eligibility_details": [
                {
                  "requirement": "<string>",
                  "status": "<string>",
                  "code": "<string>",
                  "reason": "<string>",
                  "source_program_identifier": "<string>",
                  "expected_values": [
                    "<string>"
                  ],
                  "actual_value": "<string>",
                  "operator": "<string>",
                  "severity": "<string>"
                }
              ]
            }
          ],
          "tier_name": "<string>"
        }
      ],
      "operator_name": "<string>",
      "device_category": "<string>",
      "display_name": "<string>",
      "logo_url": "<string>",
      "terms_url": "<string>",
      "description": "<string>",
      "is_partner_offer": true,
      "covered_programs": [
        {
          "identifier": "<string>",
          "name": "<string>"
        }
      ],
      "program_identifier": "<string>",
      "included_leap_program_ids": [
        "<string>"
      ]
    }
  ],
  "connect_url": "<string>",
  "geocoding": {
    "latitude": 123,
    "longitude": 123,
    "formatted_address": "<string>"
  },
  "partner": {
    "name": "<string>",
    "logo_url": "<string>"
  },
  "devices_ignored": [
    {
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reason": "NOT_ON_EXISTING_CUSTOMER",
      "partner_device_reference": "<string>"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "error_code": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Your Leap API key as a Bearer token. Send it in the Authorization header: Authorization: Bearer <api-key>.

Body

application/json

reference_id

string

required

Partner's stable identifier for the customer. Must match an existing customer scoped to the authenticated partner_id; unknown reference IDs return 404.

Required string length: 1 - 256

customer_details

object

Customer attributes to merge before re-evaluating, keyed by field name. Values are always strings. A key you send replaces what's on file, and a key you leave out is untouched. Use this to fill in facts as you learn them, rather than repeating a lookup.

Send project costs here, once per customer. customer.installation_cost is the services total for the whole job, before tax: labor, materials, and permits. customer.total_project_cost is the deal total including tax. Each device's equipment price goes in that device's details as customer_device.purchase_price.

In cost-based amounts, customer.installation_cost replaces each device's installation cost and the regional estimate. In installation cost checks, it stands in for the device's customer_device.installation_cost. Each cost calculation counts it once, and each program and each tier is its own calculation. Leap doesn't split it between devices or programs. It stays on file until you clear it. Send it as an empty string on a refresh, or leave it out of an override body.

Leap ignores a value that is negative, above 1,000,000,000, or written with more than six decimal places. Device-level costs apply instead. Text that isn't a number returns 400. A zero is a real zero. No calculation reads customer.total_project_cost yet.

An unrecognised key returns 400 and no incentives. The Requirements reference lists every key and its value form.

Omit or leave empty for no attribute changes. Maximum 100 entries.

Show child attributes

customer_devices

object[]

Optional device merge set. An entry carrying a customer_device_id updates that installation in place; an entry without one adds a new installation. Installations already on file that you don't list are left untouched — sending a subset never deletes the rest.

Maximum array length: 50

Show child attributes

remove_customer_device_ids

string<uuid>[]

Remove installations by customer_device_id. Ids that don't match a device on this customer are ignored, so retries are safe.

remove_device_references

string[]

Remove installations by partner_device_reference. Every installation with a matching reference is removed; unknown references are ignored.

eiaid

string

Optional utility override, matching the one on Look up incentives. Supply an EIA utility id to re-resolve the customer's serving utility instead of reusing the one on file. Leap re-selects candidate programs against it, re-runs eligibility, and keeps the override for later calls on this customer.

Minimum string length: 1

create_application

boolean

default:false

Create the Connect application records for this refresh's eligible programs, so the returned connect_url is a link the customer can open. It matches the flag on Look up incentives and defaults to false. Only a refresh that changes something has anything to create: one that supplies customer_devices, customer_details or a removal. A bare re-evaluation creates nothing, flag or no flag. No effect on billing or rate limits.

Response

Eligibility re-evaluated using the customer's stored state.

reference_id

string

required

Echoes the reference_id from the request — the partner's stable identifier for this customer.

customer_classification

enum<string>

required

The customer or site classification used to determine eligibility. RESIDENTIAL and COMMERCIAL are the long-standing values; MULTIFAMILY and MANUFACTURED_HOME exist because rebate qualification differs across single-family, multifamily, and manufactured housing.

Available options:

RESIDENTIAL,

MULTIFAMILY,

MANUFACTURED_HOME,

COMMERCIAL

customer_devices

object[]

required

Per-installation echo. One entry per request entry, with the resolved (server-filled if absent) partner_device_reference and the upserted customer_device.id.

Show child attributes

incentive_summary

object

required

Show child attributes

utilities

object

required

Show child attributes

program_details

object[]

required

One entry per eligible (or conditionally eligible) program. Empty when no candidate programs match the (utility, customer_classification, device_category) filter.

Show child attributes

connect_url

string<uri>

Deep link to hand the customer so they can apply: https://connect.incentives.leap.energy/{company}/refId/{reference_id}, where {company} is your registration nickname. Omitted entirely when the lookup surfaces no eligible incentive — there is nothing to apply for, so check that the field is present before showing a link.

geocoding

object

Show child attributes

partner

object

Your brand name and logo as configured on your Leap account, so a surface rendering these results can show your branding without a second call.

Show child attributes

devices_ignored

object[]

/incentives/lookups only. Entries the request named that were NOT written, because the request resolved to a customer that already exists and the entry named an installation that customer does not have. Absent or empty on every other outcome, and always absent for a customer created by this request. /incentives/lookups establishes a customer's device set. Adding to one that already exists is what /incentives/refreshes does — send the new installation there. The call still returns 200 and still evaluates the entries that WERE recognised, so a partner-side mistake never fails an otherwise-answerable eligibility request; the entries in this array are the ones that had no effect. Each entry echoes only what the caller sent. The customer's stored installations are never listed.

Show child attributes

Get Started

VPP Offers

Incentives

Applications

Programs

Devices

Refresh incentives

Authorizations

Body

Response