Charge a client plan
curl --request POST \
--url https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions \
--header 'Content-Type: application/json' \
--data '
{
"payment": {
"paymentMethodId": "<string>",
"bookingCreditId": "<string>",
"expectedChargeAmount": 123
}
}
'import requests
url = "https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions"
payload = { "payment": {
"paymentMethodId": "<string>",
"bookingCreditId": "<string>",
"expectedChargeAmount": 123
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
payment: {
paymentMethodId: '<string>',
bookingCreditId: '<string>',
expectedChargeAmount: 123
}
})
};
fetch('https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions', 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/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions",
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([
'payment' => [
'paymentMethodId' => '<string>',
'bookingCreditId' => '<string>',
'expectedChargeAmount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"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.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions"
payload := strings.NewReader("{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions")
.header("Content-Type", "application/json")
.body("{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{}Client Plan
Charge a client plan
Charge a client plan’s current cycle. Line items and amount are derived from the plan; only the payment details are supplied. For a recurring plan this kicks off its current-due cycle (e.g. the first cycle) immediately and advances the billing schedule; subsequent cycles are billed automatically. Returns the charge, which may be pending until an asynchronous payment (e.g. a payment link) completes.
POST
/
v1
/
organisations
/
{organisationId}
/
clients
/
{clientId}
/
plans
/
{clientPlanId}
/
transactions
Charge a client plan
curl --request POST \
--url https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions \
--header 'Content-Type: application/json' \
--data '
{
"payment": {
"paymentMethodId": "<string>",
"bookingCreditId": "<string>",
"expectedChargeAmount": 123
}
}
'import requests
url = "https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions"
payload = { "payment": {
"paymentMethodId": "<string>",
"bookingCreditId": "<string>",
"expectedChargeAmount": 123
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
payment: {
paymentMethodId: '<string>',
bookingCreditId: '<string>',
expectedChargeAmount: 123
}
})
};
fetch('https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions', 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/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions",
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([
'payment' => [
'paymentMethodId' => '<string>',
'bookingCreditId' => '<string>',
'expectedChargeAmount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"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.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions"
payload := strings.NewReader("{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions")
.header("Content-Type", "application/json")
.body("{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/plans/{clientPlanId}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment\": {\n \"paymentMethodId\": \"<string>\",\n \"bookingCreditId\": \"<string>\",\n \"expectedChargeAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{}⌘I
