Override incentives

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

import requests

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

payload = {
    "reference_id": "<string>",
    "address": {
        "address_line_1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>",
        "address_line_2": "<string>",
        "country_code": "US"
    },
    "customer_devices": [
        {
            "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "partner_device_reference": "<string>",
            "details": {}
        }
    ],
    "eiaid": "<string>",
    "customer_details": {},
    "create_application": False,
    "include_preview": 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>',
    address: {
      address_line_1: '<string>',
      city: '<string>',
      state: '<string>',
      zip_code: '<string>',
      address_line_2: '<string>',
      country_code: 'US'
    },
    customer_devices: [
      {
        device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        customer_device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        partner_device_reference: '<string>',
        details: {}
      }
    ],
    eiaid: '<string>',
    customer_details: {},
    create_application: false,
    include_preview: false
  })
};

fetch('https://api.leap.energy/beta/incentives/overrides', 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/overrides",
  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>',
    'address' => [
        'address_line_1' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'zip_code' => '<string>',
        'address_line_2' => '<string>',
        'country_code' => 'US'
    ],
    'customer_devices' => [
        [
                'device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'customer_device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'partner_device_reference' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'eiaid' => '<string>',
    'customer_details' => [
        
    ],
    'create_application' => false,
    'include_preview' => 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/overrides"

	payload := strings.NewReader("{\n  \"reference_id\": \"<string>\",\n  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": 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/overrides")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference_id\": \"<string>\",\n  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": 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>"
      }
    ]
  }
}

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

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

POST

beta

incentives

overrides

Override incentives

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

import requests

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

payload = {
    "reference_id": "<string>",
    "address": {
        "address_line_1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>",
        "address_line_2": "<string>",
        "country_code": "US"
    },
    "customer_devices": [
        {
            "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "customer_device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "partner_device_reference": "<string>",
            "details": {}
        }
    ],
    "eiaid": "<string>",
    "customer_details": {},
    "create_application": False,
    "include_preview": 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>',
    address: {
      address_line_1: '<string>',
      city: '<string>',
      state: '<string>',
      zip_code: '<string>',
      address_line_2: '<string>',
      country_code: 'US'
    },
    customer_devices: [
      {
        device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        customer_device_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        partner_device_reference: '<string>',
        details: {}
      }
    ],
    eiaid: '<string>',
    customer_details: {},
    create_application: false,
    include_preview: false
  })
};

fetch('https://api.leap.energy/beta/incentives/overrides', 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/overrides",
  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>',
    'address' => [
        'address_line_1' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'zip_code' => '<string>',
        'address_line_2' => '<string>',
        'country_code' => 'US'
    ],
    'customer_devices' => [
        [
                'device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'customer_device_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'partner_device_reference' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'eiaid' => '<string>',
    'customer_details' => [
        
    ],
    'create_application' => false,
    'include_preview' => 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/overrides"

	payload := strings.NewReader("{\n  \"reference_id\": \"<string>\",\n  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": 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/overrides")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference_id\": \"<string>\",\n  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"address\": {\n    \"address_line_1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"country_code\": \"US\"\n  },\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  \"eiaid\": \"<string>\",\n  \"customer_details\": {},\n  \"create_application\": false,\n  \"include_preview\": 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>"
      }
    ]
  }
}

{
  "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

Your stable identifier for this customer. Leap uses it to recognise a returning customer, and you'll send it again on Refresh incentives, Override incentives, and when searching applications. It's scoped to you — another partner using the same value is a different customer.

Required string length: 1 - 256

address

object

required

Show child attributes

customer_devices

object[]

required

One entry per installation, at least one and at most 50. Each names a catalog device_id and an optional partner_device_reference that tells two installations of the same device apart. The inline details object carries per-installation attributes, for example customer_device.purchase_price or customer_device.installation_date.

On Override incentives this list replaces the customer's device set: every installation on file is discarded first, so their customer_device_ids are regenerated.

Required array length: 1 - 50 elements

Show child attributes

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

eiaid

string

Optional utility override. Supply it when you already know the customer's serving utility and the address-based match is unavailable or ambiguous: Leap uses this EIA utility id to select candidate programs instead of resolving the utility from the address. On this path the address isn't geocoded, so the response omits the geocoding block and any stored coordinates are left as they are. A value matching no utility fails the same way an unserved address does (404 NO_UTILITY_AT_ADDRESS).

Minimum string length: 1

customer_details

object

Customer attributes you're supplying, keyed by field name, for example {"customer.utility_account_number": "0123456789"}. Values are always strings. Facts about one installation go in that entry's details object instead.

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

Omit or leave empty if you have none. Maximum 100 entries.

Show child attributes

create_application

boolean

default:false

Create the Connect application records for this lookup's eligible programs, so the returned connect_url is a link the customer can open. Provisioning runs in the background and is normally in place within seconds. Defaults to false: lookup-only integrations are unaffected and no applications are created for them. No effect on billing or rate limits.

include_preview

boolean

default:false

Include your own unpublished partner offer in the results so you can test it before publishing. Only your own offer is ever included. Utility, state, and market programs are unaffected. Defaults to false.

Response

Customer rebuilt from the request and eligibility re-evaluated.

reference_id

string

required

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

customer_classification

enum<string>

required

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

Override incentives

Authorizations

Body

Response