Evaluate Promotions Endpoint
curl --request POST \
--url https://api.decodahealth.com/billing/promotions/evaluate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"patientId": "<string>",
"providerId": "<string>",
"locationId": "<string>",
"cartId": "<string>",
"items": [
{
"itemId": "<string>",
"quantity": 1
}
],
"subtotalCents": 123
}
'import requests
url = "https://api.decodahealth.com/billing/promotions/evaluate"
payload = {
"patientId": "<string>",
"providerId": "<string>",
"locationId": "<string>",
"cartId": "<string>",
"items": [
{
"itemId": "<string>",
"quantity": 1
}
],
"subtotalCents": 123
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
providerId: '<string>',
locationId: '<string>',
cartId: '<string>',
items: [{itemId: '<string>', quantity: 1}],
subtotalCents: 123
})
};
fetch('https://api.decodahealth.com/billing/promotions/evaluate', 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.decodahealth.com/billing/promotions/evaluate",
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([
'patientId' => '<string>',
'providerId' => '<string>',
'locationId' => '<string>',
'cartId' => '<string>',
'items' => [
[
'itemId' => '<string>',
'quantity' => 1
]
],
'subtotalCents' => 123
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/billing/promotions/evaluate"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.decodahealth.com/billing/promotions/evaluate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/promotions/evaluate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Promotions
Evaluate Promotions Endpoint
Evaluate which promotions apply to a cart.
Returns two lists:
- auto_apply: promotions that should be automatically applied
- available: promotions the user can manually choose to apply
POST
/
billing
/
promotions
/
evaluate
Evaluate Promotions Endpoint
curl --request POST \
--url https://api.decodahealth.com/billing/promotions/evaluate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"patientId": "<string>",
"providerId": "<string>",
"locationId": "<string>",
"cartId": "<string>",
"items": [
{
"itemId": "<string>",
"quantity": 1
}
],
"subtotalCents": 123
}
'import requests
url = "https://api.decodahealth.com/billing/promotions/evaluate"
payload = {
"patientId": "<string>",
"providerId": "<string>",
"locationId": "<string>",
"cartId": "<string>",
"items": [
{
"itemId": "<string>",
"quantity": 1
}
],
"subtotalCents": 123
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
providerId: '<string>',
locationId: '<string>',
cartId: '<string>',
items: [{itemId: '<string>', quantity: 1}],
subtotalCents: 123
})
};
fetch('https://api.decodahealth.com/billing/promotions/evaluate', 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.decodahealth.com/billing/promotions/evaluate",
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([
'patientId' => '<string>',
'providerId' => '<string>',
'locationId' => '<string>',
'cartId' => '<string>',
'items' => [
[
'itemId' => '<string>',
'quantity' => 1
]
],
'subtotalCents' => 123
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/billing/promotions/evaluate"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.decodahealth.com/billing/promotions/evaluate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/promotions/evaluate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"providerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"cartId\": \"<string>\",\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"subtotalCents\": 123\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Response
Successful Response
The response is of type Response Evaluate Promotions Endpoint Billing Promotions Evaluate Post · object.
⌘I
