Billing

Buy credits with the saved card or bank account

Charges the company’s saved card or bank account off-session and grants the credits, and the bonus its tier gives, once Stripe reports the money received: at once for a card that succeeds, else when the payment settles. The server prices every purchase: expected_credit_cents must equal what it quotes, expected_surcharge_cents the credit card fee it charges (0 when left out), expected_payment_method_key the payment method it charges (not checked when left out), and terms_version the terms in force, or nothing is charged (409). A repeat of the same purchase_key charges once and returns the first purchase (200). A declined card returns the purchase as failed with its reason. A card charged with the merchant present may be waiting for the cardholder to confirm it with their bank (3D Secure): the purchase is processing with action_required true, nothing is charged yet, and next_action carries what the browser needs to finish it. A new purchase is refused (409, purchase_awaiting_action) while one waits. Needs billing.update; never a Droplet token.

POST

api

settings

billing

credits

purchases

Buy credits with the saved card or bank account

curl --request POST \
  --url https://api.fluid.app/api/settings/billing/credits/purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_cents": 100000,
  "expected_credit_cents": 110000,
  "purchase_key": "3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36",
  "terms_version": "2026-10-06"
}
'

import requests

url = "https://api.fluid.app/api/settings/billing/credits/purchases"

payload = {
    "amount_cents": 100000,
    "expected_credit_cents": 110000,
    "purchase_key": "3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36",
    "terms_version": "2026-10-06"
}
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({
    amount_cents: 100000,
    expected_credit_cents: 110000,
    purchase_key: '3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36',
    terms_version: '2026-10-06'
  })
};

fetch('https://api.fluid.app/api/settings/billing/credits/purchases', 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.fluid.app/api/settings/billing/credits/purchases",
  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([
    'amount_cents' => 100000,
    'expected_credit_cents' => 110000,
    'purchase_key' => '3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36',
    'terms_version' => '2026-10-06'
  ]),
  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://api.fluid.app/api/settings/billing/credits/purchases"

	payload := strings.NewReader("{\n  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\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://api.fluid.app/api/settings/billing/credits/purchases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/settings/billing/credits/purchases")

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  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\n}"

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

{
  "credit_purchase": {
    "id": 7342,
    "origin": "manual",
    "status": "succeeded",
    "instrument_type": "card",
    "failure_message": null,
    "invoice_available": false,
    "action_required": false,
    "top_up_cents": null,
    "amount_cents": 100000,
    "bonus_percent": 10,
    "bonus_cents": 10000,
    "credit_cents": 110000,
    "surcharge_cents": 0,
    "total_cents": 100000,
    "refunded_cents": 0,
    "credits_expire_at": "2027-09-12T16:20:05Z",
    "created_at": "2026-09-12T16:19:58Z",
    "succeeded_at": "2026-09-12T16:20:05Z",
    "failed_at": null
  },
  "balance_cents": 185500,
  "duplicate": true,
  "next_action": null,
  "status": 200,
  "meta": {
    "request_id": "f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90",
    "timestamp": "2026-09-30T14:05:11Z"
  }
}

{
  "credit_purchase": {
    "id": 7342,
    "origin": "manual",
    "status": "succeeded",
    "instrument_type": "card",
    "failure_message": null,
    "invoice_available": false,
    "action_required": false,
    "top_up_cents": null,
    "amount_cents": 100000,
    "bonus_percent": 10,
    "bonus_cents": 10000,
    "credit_cents": 110000,
    "surcharge_cents": 0,
    "total_cents": 100000,
    "refunded_cents": 0,
    "credits_expire_at": "2027-09-12T16:20:05Z",
    "created_at": "2026-09-12T16:19:58Z",
    "succeeded_at": "2026-09-12T16:20:05Z",
    "failed_at": null
  },
  "balance_cents": 185500,
  "duplicate": false,
  "next_action": null,
  "status": 201,
  "meta": {
    "request_id": "f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90",
    "timestamp": "2026-09-30T14:05:11Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Body

application/json

amount_cents

integer

required

What to pay

Required range: x >= 1

expected_credit_cents

integer

required

The credits the page quoted

Required range: x >= 1

purchase_key

string<uuid>

required

Caller-supplied UUID naming this purchase

terms_version

string

required

The purchase terms version shown before Buy.

expected_surcharge_cents

integer

The credit card fee the page showed, in cents, charged on top of amount_cents. Left out means the page showed no fee.

Required range: x >= 0

expected_payment_method_key

string

The payment_method.key the page showed. A new purchase is refused (409 quote_changed, details.payment_method_changed true, nothing reserved) when the saved method is another. A repeat of a purchase_key already used charges the method that purchase was reserved on. Left out means the method is not checked.

Minimum string length: 1

Response

A repeat of the purchase key; the first purchase

credit_purchase

object

required

One purchase of credits: what was paid, what it granted, and where its money stands. succeeded means the credits were granted; processing means the payment is still settling. origin is manual (the merchant bought), auto_reload (a low balance bought), or settlement (a charge for what a credit-billed company owes, with any auto-reload top-up).

Show child attributes

balance_cents

integer

required

The credit balance after the purchase

duplicate

boolean

required

Whether this returns a purchase already made with the same key.

next_action

object | null

required

Set while credit_purchase.action_required: confirm the payment with the cardholder's bank. Null otherwise, and when Stripe could not be read (then GET the purchase's authentication).

Show child attributes

Buy credits with the saved card or bank account

curl --request POST \
  --url https://api.fluid.app/api/settings/billing/credits/purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_cents": 100000,
  "expected_credit_cents": 110000,
  "purchase_key": "3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36",
  "terms_version": "2026-10-06"
}
'

import requests

url = "https://api.fluid.app/api/settings/billing/credits/purchases"

payload = {
    "amount_cents": 100000,
    "expected_credit_cents": 110000,
    "purchase_key": "3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36",
    "terms_version": "2026-10-06"
}
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({
    amount_cents: 100000,
    expected_credit_cents: 110000,
    purchase_key: '3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36',
    terms_version: '2026-10-06'
  })
};

fetch('https://api.fluid.app/api/settings/billing/credits/purchases', 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.fluid.app/api/settings/billing/credits/purchases",
  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([
    'amount_cents' => 100000,
    'expected_credit_cents' => 110000,
    'purchase_key' => '3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36',
    'terms_version' => '2026-10-06'
  ]),
  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://api.fluid.app/api/settings/billing/credits/purchases"

	payload := strings.NewReader("{\n  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\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://api.fluid.app/api/settings/billing/credits/purchases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/settings/billing/credits/purchases")

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  \"amount_cents\": 100000,\n  \"expected_credit_cents\": 110000,\n  \"purchase_key\": \"3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36\",\n  \"terms_version\": \"2026-10-06\"\n}"

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

{
  "credit_purchase": {
    "id": 7342,
    "origin": "manual",
    "status": "succeeded",
    "instrument_type": "card",
    "failure_message": null,
    "invoice_available": false,
    "action_required": false,
    "top_up_cents": null,
    "amount_cents": 100000,
    "bonus_percent": 10,
    "bonus_cents": 10000,
    "credit_cents": 110000,
    "surcharge_cents": 0,
    "total_cents": 100000,
    "refunded_cents": 0,
    "credits_expire_at": "2027-09-12T16:20:05Z",
    "created_at": "2026-09-12T16:19:58Z",
    "succeeded_at": "2026-09-12T16:20:05Z",
    "failed_at": null
  },
  "balance_cents": 185500,
  "duplicate": true,
  "next_action": null,
  "status": 200,
  "meta": {
    "request_id": "f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90",
    "timestamp": "2026-09-30T14:05:11Z"
  }
}

{
  "credit_purchase": {
    "id": 7342,
    "origin": "manual",
    "status": "succeeded",
    "instrument_type": "card",
    "failure_message": null,
    "invoice_available": false,
    "action_required": false,
    "top_up_cents": null,
    "amount_cents": 100000,
    "bonus_percent": 10,
    "bonus_cents": 10000,
    "credit_cents": 110000,
    "surcharge_cents": 0,
    "total_cents": 100000,
    "refunded_cents": 0,
    "credits_expire_at": "2027-09-12T16:20:05Z",
    "created_at": "2026-09-12T16:19:58Z",
    "succeeded_at": "2026-09-12T16:20:05Z",
    "failed_at": null
  },
  "balance_cents": 185500,
  "duplicate": false,
  "next_action": null,
  "status": 201,
  "meta": {
    "request_id": "f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90",
    "timestamp": "2026-09-30T14:05:11Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Storefront

Commerce

Checkout

Member API

Member Sites APIs

Messaging

Cowork

People

Payments

DAM

Website

Portal

Mobile app

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Unsorted endpoints

Portal & Widgets

Buy credits with the saved card or bank account

Authorizations

Body

Response