Review a shared plan
curl --request GET \
--url https://api.halth.com/v1/plans/templates/links/{secret}import requests
url = "https://api.halth.com/v1/plans/templates/links/{secret}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.halth.com/v1/plans/templates/links/{secret}', 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.halth.com/v1/plans/templates/links/{secret}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halth.com/v1/plans/templates/links/{secret}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halth.com/v1/plans/templates/links/{secret}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/plans/templates/links/{secret}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"plan": {
"discountRate": 0.1,
"discountAmount": 10000,
"billingType": "recurring",
"public": true,
"popularityRank": 123,
"id": "<string>",
"createdAt": "<string>",
"name": "<string>",
"price": 123,
"currency": "<string>",
"deleted": true,
"items": [
{
"id": "<string>",
"createdAt": "<string>",
"planTemplateId": "<string>",
"sortOrder": 123,
"appointmentTypeId": "<string>",
"providerId": "<string>",
"billableItemId": "<string>",
"basePrice": 123,
"price": 123
}
],
"businessId": "<string>",
"billingIntervalCount": 123,
"statistics": {
"usageCount": 123,
"totalChargeAmount": 123
},
"links": [
{
"url": "<string>",
"id": "<string>",
"createdAt": "<string>",
"planTemplateId": "<string>",
"businessId": "<string>"
}
],
"description": "<string>"
},
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"brandImageUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
}
}Plan Template Link
Review a shared plan
Get the details of the plan behind a shareable link so a client can review it before purchasing.
GET
/
v1
/
plans
/
templates
/
links
/
{secret}
Review a shared plan
curl --request GET \
--url https://api.halth.com/v1/plans/templates/links/{secret}import requests
url = "https://api.halth.com/v1/plans/templates/links/{secret}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.halth.com/v1/plans/templates/links/{secret}', 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.halth.com/v1/plans/templates/links/{secret}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halth.com/v1/plans/templates/links/{secret}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halth.com/v1/plans/templates/links/{secret}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/plans/templates/links/{secret}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"plan": {
"discountRate": 0.1,
"discountAmount": 10000,
"billingType": "recurring",
"public": true,
"popularityRank": 123,
"id": "<string>",
"createdAt": "<string>",
"name": "<string>",
"price": 123,
"currency": "<string>",
"deleted": true,
"items": [
{
"id": "<string>",
"createdAt": "<string>",
"planTemplateId": "<string>",
"sortOrder": 123,
"appointmentTypeId": "<string>",
"providerId": "<string>",
"billableItemId": "<string>",
"basePrice": 123,
"price": 123
}
],
"businessId": "<string>",
"billingIntervalCount": 123,
"statistics": {
"usageCount": 123,
"totalChargeAmount": 123
},
"links": [
{
"url": "<string>",
"id": "<string>",
"createdAt": "<string>",
"planTemplateId": "<string>",
"businessId": "<string>"
}
],
"description": "<string>"
},
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"brandImageUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
}
}⌘I
