Close a billing account - Akua

POST

billing_accounts

{billing_account}

:close

Close a billing account

curl --request POST \
  --url https://api.akua.dev/v1/billing_accounts/{billing_account}:close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.akua.dev/v1/billing_accounts/{billing_account}:close"

payload = { "reason": "<string>" }
headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'if-match': '<if-match>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.akua.dev/v1/billing_accounts/{billing_account}:close', 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.akua.dev/v1/billing_accounts/{billing_account}:close",
  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([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "if-match: <if-match>"
  ],
]);

$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.akua.dev/v1/billing_accounts/{billing_account}:close"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

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

	req.Header.Add("if-match", "<if-match>")
	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.akua.dev/v1/billing_accounts/{billing_account}:close")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/billing_accounts/{billing_account}:close")

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

request = Net::HTTP::Post.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "billingAccounts/bac_4kQ9mXr2Tz7Lw1",
  "organization_id": "<string>",
  "display_name": "<string>",
  "state": "PENDING",
  "payment_method": {
    "type": "card",
    "card": {
      "brand": "visa",
      "last4": "<string>",
      "exp_month": 6,
      "exp_year": 2099,
      "verified_at": 4503599627370495
    }
  },
  "currency_code": "EUR",
  "conditions": [
    {
      "reason": "agent-offline",
      "severity": "error",
      "message": "<string>",
      "remedy": {
        "kind": "free-capacity",
        "metric": "kaas/clusters",
        "limit": 123,
        "usage": 123,
        "hint": "<string>"
      },
      "last_transition_at": 1
    }
  ],
  "created_at": 4503599627370495,
  "updated_at": 4503599627370495,
  "closed_at": 4503599627370495,
  "etag": "<string>"
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

Authorizations

Authorization

string

header

required

Bearer token for the authenticated caller.

Headers

idempotency-key

string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64

Example:

"create-prod-2026-05-07"

if-match

string

required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256

Example:

"42"

Path Parameters

billing_account

string

required

Required string length: 3 - 54

Body

application/json

reason

string

Required string length: 1 - 512

Response

BillingAccount

string

required

Required string length: 3 - 54

name

string

required

Pattern: ^billingAccounts\/bac_[A-Za-z0-9]+$

Example:

"billingAccounts/bac_4kQ9mXr2Tz7Lw1"

organization_id

string

required

Required string length: 3 - 54

display_name

string

required

Required string length: 1 - 100

state

enum<string>

required

Available options:

PENDING,

ACTIVE,

CLOSED

payment_method

object

required

Option 1
Option 2

Show child attributes

currency_code

enum<string>

required

Available options:

EUR

conditions

object[]

required

Problems and notable facts that hold now, beside state; empty when there are none. See each reason in the resource description.

Maximum array length: 32

Show child attributes

created_at

integer

required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991

updated_at

integer

required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991

closed_at

integer | null

required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991

etag

string

required

Maximum string length: 64

Close a billing account

curl --request POST \
  --url https://api.akua.dev/v1/billing_accounts/{billing_account}:close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.akua.dev/v1/billing_accounts/{billing_account}:close"

payload = { "reason": "<string>" }
headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'if-match': '<if-match>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.akua.dev/v1/billing_accounts/{billing_account}:close', 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.akua.dev/v1/billing_accounts/{billing_account}:close",
  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([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "if-match: <if-match>"
  ],
]);

$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.akua.dev/v1/billing_accounts/{billing_account}:close"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

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

	req.Header.Add("if-match", "<if-match>")
	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.akua.dev/v1/billing_accounts/{billing_account}:close")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/billing_accounts/{billing_account}:close")

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

request = Net::HTTP::Post.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "billingAccounts/bac_4kQ9mXr2Tz7Lw1",
  "organization_id": "<string>",
  "display_name": "<string>",
  "state": "PENDING",
  "payment_method": {
    "type": "card",
    "card": {
      "brand": "visa",
      "last4": "<string>",
      "exp_month": 6,
      "exp_year": 2099,
      "verified_at": 4503599627370495
    }
  },
  "currency_code": "EUR",
  "conditions": [
    {
      "reason": "agent-offline",
      "severity": "error",
      "message": "<string>",
      "remedy": {
        "kind": "free-capacity",
        "metric": "kaas/clusters",
        "limit": 123,
        "usage": 123,
        "hint": "<string>"
      },
      "last_transition_at": 1
    }
  ],
  "created_at": 4503599627370495,
  "updated_at": 4503599627370495,
  "closed_at": 4503599627370495,
  "etag": "<string>"
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}