Create subscription checkout
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"price_sid": "<string>",
"quantity": 2,
"team_sid": "<string>",
"addons": [
{
"price_sid": "<string>",
"quantity": 2
}
]
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout"
payload = {
"price_sid": "<string>",
"quantity": 2,
"team_sid": "<string>",
"addons": [
{
"price_sid": "<string>",
"quantity": 2
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
price_sid: '<string>',
quantity: 2,
team_sid: '<string>',
addons: [{price_sid: '<string>', quantity: 2}]
})
};
fetch('https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-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([
'price_sid' => '<string>',
'quantity' => 2,
'team_sid' => '<string>',
'addons' => [
[
'price_sid' => '<string>',
'quantity' => 2
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout"
payload := strings.NewReader("{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"owner_user_sid": "<string>",
"team_sid": "<string>",
"paddle_subscription_id": "<string>",
"status": "active",
"collection_mode": "automatic",
"price_sid": "<string>",
"quantity": 123,
"addons": [
{
"product_sid": "<string>",
"price_sid": "<string>",
"paddle_item_id": "<string>",
"quantity": 123,
"status": "active"
}
],
"currency": "<string>",
"current_period_starts_at": "<string>",
"current_period_ends_at": "<string>",
"next_billed_at": "<string>",
"paused_at": "<string>",
"scheduled_resume_at": "<string>",
"scheduled_change": {
"action": "cancel",
"effective_at": "<string>",
"resume_at": "<string>"
},
"canceled_at": "<string>",
"canceled_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"reason": "<string>",
"request_sid": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}billing_subscriptions
Create subscription checkout
Start a self-serve purchase of a subscription. DANGEROUS (charges money): it pre-creates a billed Paddle transaction and returns a hosted checkout_url the buyer pays in the Paddle overlay (server-side preview→commit gate applies). Resolves the bracket price for the requested slot count, optionally applies to team_sid on activation (omit to buy floating), and can bundle add-ons in the same checkout. The real subscription row is born on the billing-subscriptions.activated webhook; poll get/search afterwards. Requires billing.manage.
Contract:
- REST only: no MCP tool serves this route (registry package
mcp.id/billing_subscriptions, surface api). - Operation
action, response envelopeaction. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
POST
/
api
/
billing-subscriptions
/
create-checkout
Create subscription checkout
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"price_sid": "<string>",
"quantity": 2,
"team_sid": "<string>",
"addons": [
{
"price_sid": "<string>",
"quantity": 2
}
]
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout"
payload = {
"price_sid": "<string>",
"quantity": 2,
"team_sid": "<string>",
"addons": [
{
"price_sid": "<string>",
"quantity": 2
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
price_sid: '<string>',
quantity: 2,
team_sid: '<string>',
addons: [{price_sid: '<string>', quantity: 2}]
})
};
fetch('https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-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([
'price_sid' => '<string>',
'quantity' => 2,
'team_sid' => '<string>',
'addons' => [
[
'price_sid' => '<string>',
'quantity' => 2
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout"
payload := strings.NewReader("{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/billing-subscriptions/create-checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"price_sid\": \"<string>\",\n \"quantity\": 2,\n \"team_sid\": \"<string>\",\n \"addons\": [\n {\n \"price_sid\": \"<string>\",\n \"quantity\": 2\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"owner_user_sid": "<string>",
"team_sid": "<string>",
"paddle_subscription_id": "<string>",
"status": "active",
"collection_mode": "automatic",
"price_sid": "<string>",
"quantity": 123,
"addons": [
{
"product_sid": "<string>",
"price_sid": "<string>",
"paddle_item_id": "<string>",
"quantity": 123,
"status": "active"
}
],
"currency": "<string>",
"current_period_starts_at": "<string>",
"current_period_ends_at": "<string>",
"next_billed_at": "<string>",
"paused_at": "<string>",
"scheduled_resume_at": "<string>",
"scheduled_change": {
"action": "cancel",
"effective_at": "<string>",
"resume_at": "<string>"
},
"canceled_at": "<string>",
"canceled_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"reason": "<string>",
"request_sid": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Body
application/json
Request body of create_billing_subscription_checkout.
Response
action success envelope.