Start a team plan checkout
curl --request POST \
--url https://api.checkfu.com/v1/billing/checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"preview_id": "<string>",
"generation": 1,
"preview_digest": "<string>",
"request_fingerprint": "<string>",
"plan_id": "team",
"plan_version": 1,
"catalog_version": "<string>",
"due_today_minor_units": 1,
"recurring_minor_units": 1,
"currency": "usd",
"redirects_to_checkout": true,
"success_url": "<string>",
"preview_expires_at": "<string>"
}
'import requests
url = "https://api.checkfu.com/v1/billing/checkout"
payload = {
"preview_id": "<string>",
"generation": 1,
"preview_digest": "<string>",
"request_fingerprint": "<string>",
"plan_id": "team",
"plan_version": 1,
"catalog_version": "<string>",
"due_today_minor_units": 1,
"recurring_minor_units": 1,
"currency": "usd",
"redirects_to_checkout": True,
"success_url": "<string>",
"preview_expires_at": "<string>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
preview_id: '<string>',
generation: 1,
preview_digest: '<string>',
request_fingerprint: '<string>',
plan_id: 'team',
plan_version: 1,
catalog_version: '<string>',
due_today_minor_units: 1,
recurring_minor_units: 1,
currency: 'usd',
redirects_to_checkout: true,
success_url: '<string>',
preview_expires_at: '<string>'
})
};
fetch('https://api.checkfu.com/v1/billing/checkout', 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.checkfu.com/v1/billing/checkout",
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([
'preview_id' => '<string>',
'generation' => 1,
'preview_digest' => '<string>',
'request_fingerprint' => '<string>',
'plan_id' => 'team',
'plan_version' => 1,
'catalog_version' => '<string>',
'due_today_minor_units' => 1,
'recurring_minor_units' => 1,
'currency' => 'usd',
'redirects_to_checkout' => true,
'success_url' => '<string>',
'preview_expires_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>",
"idempotency-key: <idempotency-key>"
],
]);
$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.checkfu.com/v1/billing/checkout"
payload := strings.NewReader("{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("idempotency-key", "<idempotency-key>")
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.checkfu.com/v1/billing/checkout")
.header("checkfu-version", "<checkfu-version>")
.header("idempotency-key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/billing/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"state": "redirect",
"url": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "billing.payment_required",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#billing-payment-required"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.idempotency_conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-idempotency-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}{
"error": {
"type": "billing.entitlement_unavailable",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#billing-entitlement-unavailable"
}
}Start a team plan checkout
Submits a previously previewed checkout; the payload must be the exact billing.previewTeamCheckout response, whose digest and request fingerprint fence the quoted terms. Idempotency-Key is required, and a retry under the same key replays the stored outcome rather than starting a second checkout. Returns state redirect with a hosted checkout URL, or state confirmed when no redirect is needed.
Checkfu support posture: preview; rollout_fenced. Required evidence journey: platform-supply-billing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.
POST
/
v1
/
billing
/
checkout
Start a team plan checkout
curl --request POST \
--url https://api.checkfu.com/v1/billing/checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"preview_id": "<string>",
"generation": 1,
"preview_digest": "<string>",
"request_fingerprint": "<string>",
"plan_id": "team",
"plan_version": 1,
"catalog_version": "<string>",
"due_today_minor_units": 1,
"recurring_minor_units": 1,
"currency": "usd",
"redirects_to_checkout": true,
"success_url": "<string>",
"preview_expires_at": "<string>"
}
'import requests
url = "https://api.checkfu.com/v1/billing/checkout"
payload = {
"preview_id": "<string>",
"generation": 1,
"preview_digest": "<string>",
"request_fingerprint": "<string>",
"plan_id": "team",
"plan_version": 1,
"catalog_version": "<string>",
"due_today_minor_units": 1,
"recurring_minor_units": 1,
"currency": "usd",
"redirects_to_checkout": True,
"success_url": "<string>",
"preview_expires_at": "<string>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
preview_id: '<string>',
generation: 1,
preview_digest: '<string>',
request_fingerprint: '<string>',
plan_id: 'team',
plan_version: 1,
catalog_version: '<string>',
due_today_minor_units: 1,
recurring_minor_units: 1,
currency: 'usd',
redirects_to_checkout: true,
success_url: '<string>',
preview_expires_at: '<string>'
})
};
fetch('https://api.checkfu.com/v1/billing/checkout', 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.checkfu.com/v1/billing/checkout",
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([
'preview_id' => '<string>',
'generation' => 1,
'preview_digest' => '<string>',
'request_fingerprint' => '<string>',
'plan_id' => 'team',
'plan_version' => 1,
'catalog_version' => '<string>',
'due_today_minor_units' => 1,
'recurring_minor_units' => 1,
'currency' => 'usd',
'redirects_to_checkout' => true,
'success_url' => '<string>',
'preview_expires_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>",
"idempotency-key: <idempotency-key>"
],
]);
$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.checkfu.com/v1/billing/checkout"
payload := strings.NewReader("{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("idempotency-key", "<idempotency-key>")
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.checkfu.com/v1/billing/checkout")
.header("checkfu-version", "<checkfu-version>")
.header("idempotency-key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/billing/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preview_id\": \"<string>\",\n \"generation\": 1,\n \"preview_digest\": \"<string>\",\n \"request_fingerprint\": \"<string>\",\n \"plan_id\": \"team\",\n \"plan_version\": 1,\n \"catalog_version\": \"<string>\",\n \"due_today_minor_units\": 1,\n \"recurring_minor_units\": 1,\n \"currency\": \"usd\",\n \"redirects_to_checkout\": true,\n \"success_url\": \"<string>\",\n \"preview_expires_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"state": "redirect",
"url": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "billing.payment_required",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#billing-payment-required"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.idempotency_conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-idempotency-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}{
"error": {
"type": "billing.entitlement_unavailable",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#billing-entitlement-unavailable"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-24 Required string length:
1 - 255Body
application/json
Pattern:
^bco_[0-9a-f]{32}$Required range:
x > 0Pattern:
^sha256:[0-9a-f]{64}$Pattern:
^sha256:[0-9a-f]{64}$Available options:
team Required range:
x > 0Required string length:
1 - 64Required range:
x >= 0Required range:
x >= 0Available options:
usd Maximum string length:
2048Pattern:
^https:\/\/[^\s]+$