Create hosted checkout link

curl --request POST \
  --url https://demo.onlinebillingform.com/api/v2/checkout/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_id": 2,
  "cycle_id": 2,
  "callback_url": "<string>",
  "customer_id": 2
}
'

import requests

url = "https://demo.onlinebillingform.com/api/v2/checkout/create"

payload = {
    "package_id": 2,
    "cycle_id": 2,
    "callback_url": "<string>",
    "customer_id": 2
}
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({package_id: 2, cycle_id: 2, callback_url: '<string>', customer_id: 2})
};

fetch('https://demo.onlinebillingform.com/api/v2/checkout/create', 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://demo.onlinebillingform.com/api/v2/checkout/create",
  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([
    'package_id' => 2,
    'cycle_id' => 2,
    'callback_url' => '<string>',
    'customer_id' => 2
  ]),
  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://demo.onlinebillingform.com/api/v2/checkout/create"

	payload := strings.NewReader("{\n  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\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://demo.onlinebillingform.com/api/v2/checkout/create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://demo.onlinebillingform.com/api/v2/checkout/create")

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  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\n}"

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

{
  "success": true,
  "message": "Successfully",
  "url": "https://demo.onlinebillingform.com/checkout/00000000-0000-0000-0000-000000000000"
}

{
  "success": false,
  "errors": "Invalid API Key"
}

{
  "success": false,
  "errors": "Insufficient permissions for this endpoint."
}

{
  "success": false,
  "errors": [
    "The requested domain is not available."
  ]
}

{
  "success": false,
  "errors": [
    "Unable to check domain availability right now."
  ]
}

Create Hosted Checkout

Creates a short-lived hosted checkout URL for a package, one domain, or up to 50 domain registrations. Use package_id with cycle_id for an existing package, domain with years for one domain, or domains for multiple domain registrations. callback_url is required. customer_id is optional; when supplied, it must reference a customer account (account_type 2). The checkout link is cached for 30 minutes. When the customer opens it, BillingServ creates a checkout-only session, allows supported saved payment methods, and redirects back to callback_url after payment.

POST

checkout

create

Create hosted checkout link

curl --request POST \
  --url https://demo.onlinebillingform.com/api/v2/checkout/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_id": 2,
  "cycle_id": 2,
  "callback_url": "<string>",
  "customer_id": 2
}
'

import requests

url = "https://demo.onlinebillingform.com/api/v2/checkout/create"

payload = {
    "package_id": 2,
    "cycle_id": 2,
    "callback_url": "<string>",
    "customer_id": 2
}
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({package_id: 2, cycle_id: 2, callback_url: '<string>', customer_id: 2})
};

fetch('https://demo.onlinebillingform.com/api/v2/checkout/create', 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://demo.onlinebillingform.com/api/v2/checkout/create",
  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([
    'package_id' => 2,
    'cycle_id' => 2,
    'callback_url' => '<string>',
    'customer_id' => 2
  ]),
  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://demo.onlinebillingform.com/api/v2/checkout/create"

	payload := strings.NewReader("{\n  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\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://demo.onlinebillingform.com/api/v2/checkout/create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://demo.onlinebillingform.com/api/v2/checkout/create")

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  \"package_id\": 2,\n  \"cycle_id\": 2,\n  \"callback_url\": \"<string>\",\n  \"customer_id\": 2\n}"

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

{
  "success": true,
  "message": "Successfully",
  "url": "https://demo.onlinebillingform.com/checkout/00000000-0000-0000-0000-000000000000"
}

{
  "success": false,
  "errors": "Invalid API Key"
}

{
  "success": false,
  "errors": "Insufficient permissions for this endpoint."
}

{
  "success": false,
  "errors": [
    "The requested domain is not available."
  ]
}

{
  "success": false,
  "errors": [
    "Unable to check domain availability right now."
  ]
}

Use this endpoint when your own website owns the customer-facing dashboard but you still want BillingServ to host checkout and payment collection. The endpoint creates a hosted checkout URL for an existing package, one domain, or up to 50 domains. callback_url is required and customer_id is optional. If you provide customer_id, it must be a customer account (account_type 2). When the customer opens the returned URL, BillingServ creates a checkout-only session so supported saved payment methods can be used without giving the customer access to the full BillingServ panel. The link expires after 30 minutes if it is not completed.

Request

Send the request with an API key that has access to this endpoint:

curl -X POST "https://your-billingserv-domain.com/api/v2/checkout/create" \
  -H "Authorization: Bearer <live_api_key>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "billingserv.co.uk",
    "years": 1,
    "customer_id": 123,
    "callback_url": "https://your-site.example/account/billing/return"
  }'

Choose one checkout type for each request:

Checkout type	Fields
Existing package	`package_id` and `cycle_id`
One domain	`domain` and `years`
Multiple domains	`domains`, with `domain` and `years` for each item

Leave out customer_id for checkout-first flows where BillingServ collects the customer’s details. See the domain search and hosted checkout guide for complete domain lookup, multi-domain, and callback examples.

Response

{
  "success": true,
  "message": "Successfully",
  "url": "https://your-billingserv-domain.com/checkout/00000000-0000-0000-0000-000000000000"
}

Redirect the customer to the returned url. If a requested domain is unavailable, the API returns 422 and does not create a checkout link.

Callback

After payment, BillingServ redirects the customer back to callback_url with query parameters. Successful payment includes:

?transaction_id=<gateway_transaction_id>&internal_transaction_id=<billingserv_transaction_id>&status=success&order_ref=<payment_session_code>&external_customer_id=<customer_id>

Failed payment includes:

?status=failed&external_customer_id=<customer_id>

Treat the callback as a browser return URL. For server-side reconciliation, use the returned IDs with the transactions, orders, or invoices API.

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <live_api_key>.

Body

Option 1
Option 2
Option 3

Provide exactly one checkout type: an existing package, one domain, or a list of domains.

package_id

integer

required

Package or order-group package ID to add to checkout.

Required range: x >= 1

cycle_id

integer

required

Billing cycle ID for the selected package.

Required range: x >= 1

callback_url

string<uri>

required

URL BillingServ redirects to after hosted checkout succeeds or fails.

customer_id

integer | null

Optional existing BillingServ customer user ID. If supplied, the user must have account_type 2.

Required range: x >= 1

Response

A hosted checkout URL created by BillingServ. The URL expires after 30 minutes if it is not completed.

success

boolean

required

message

string

required

Example:

"Successfully"

url

string<uri>

required

Hosted checkout URL to open or redirect the customer to.

Getting Started

Webhooks

Endpoints

Create Hosted Checkout

Request

Response

Callback

Authorizations

Body

Response

​Request

​Response

​Callback

Authorizations

Body

Response

Request

Response

Callback