Billing

What changing plan would do, and cost today

Admins only.

POST/v1/organizations/{organizationId}/billing/preview

Request

curl --request POST \
  --url 'https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan": "free"
}'

import json
import requests

url = "https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"plan\":\"free\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "plan": "free"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"plan\":\"free\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview", bytes.NewBuffer([]byte("{\"plan\":\"free\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"plan\":\"free\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"plan\":\"free\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "kind": "first_subscription",
    "plan": "free",
    "interval": "monthly",
    "effectiveImmediately": true,
    "effectiveAt": null,
    "amountDueToday": null,
    "currency": null,
    "breakdown": {
      "unusedCredit": 123.45,
      "newCharge": 123.45,
      "tax": 123.45
    }
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Changes nothing. Says whether the change is immediate (an upgrade, charged now and prorated, with Stripe’s own figure for today), scheduled for the end of the paid period (a downgrade), or needs a checkout (no subscription yet). Refused with 501 while billing is not connected.

Requires the account:read scope. Operation billing.preview. MCP tool billing_preview. CLI, once published: gtable billing preview.

Path parameters

Name	Type	Required	Description
`organizationId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`plan`	“free” or “starter” or “team” or “custom”	yes
`interval`	“monthly” or “yearly”	no	Default `"monthly"`.

Response

application/json

Success

dataobjectrequired

Show child attributes

kindstringrequired

planstringrequired

intervalstringrequired

effectiveImmediatelybooleanrequired

effectiveAtstringnullrequired

amountDueTodaynumbernullrequired

currencystringnullrequired

breakdownobject | nullrequired

curl --request POST \ --url 'https://studio.gtable.app/v1/organizations/<organizationId>/billing/preview' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "plan": "free" }'

{ "data": { "kind": "first_subscription", "plan": "free", "interval": "monthly", "effectiveImmediately": true, "effectiveAt": null, "amountDueToday": null, "currency": null, "breakdown": { "unusedCredit": 123.45, "newCharge": 123.45, "tax": 123.45 } } }

What changing plan would do, and cost today

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown