Preview a team plan checkout

curl --request POST \
  --url https://api.checkfu.com/v1/billing/checkout/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/billing/checkout/preview"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/billing/checkout/preview', 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/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/billing/checkout/preview"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	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/preview")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/billing/checkout/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "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>"
}

{
  "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": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "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"
  }
}

Preview a team plan checkout

Produces a signed checkout preview for the team plan: preview_id, preview_digest, plan and catalog versions, amount due today and the recurring amount in minor units, and preview_expires_at. Nothing is charged and no subscription changes. Pass the returned object back verbatim to billing.startTeamCheckout before it expires — the digest binds the exact quoted terms.

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

billing

checkout

preview

Preview a team plan checkout

curl --request POST \
  --url https://api.checkfu.com/v1/billing/checkout/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/billing/checkout/preview"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/billing/checkout/preview', 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/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/billing/checkout/preview"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	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/preview")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/billing/checkout/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "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>"
}

{
  "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": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

Response

Success

preview_id

string

required

Pattern: ^bco_[0-9a-f]{32}$

generation

integer

required

Required range: x > 0

preview_digest

string

required

Pattern: ^sha256:[0-9a-f]{64}$

request_fingerprint

string

required

Pattern: ^sha256:[0-9a-f]{64}$

plan_id

enum<string>

required

Available options:

team

plan_version

integer

required

Required range: x > 0

catalog_version

string

required

Required string length: 1 - 64

due_today_minor_units

integer

required

Required range: x >= 0

recurring_minor_units

integer | null

required

Required range: x >= 0

currency

enum<string>

required

Available options:

usd

redirects_to_checkout

boolean

required

success_url

string

required

Maximum string length: 2048

Pattern: ^https:\/\/[^\s]+$

preview_expires_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Preview a team plan checkout

Authorizations

Headers

Response