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>",
    "price_sid": "<string>",
    "quantity": 123,
    "addons": [
      {
        "product_sid": "<string>",
        "price_sid": "<string>",
        "paddle_item_id": "<string>",
        "quantity": 123
      }
    ],
    "currency": "<string>",
    "current_period_starts_at": "<string>",
    "current_period_ends_at": "<string>",
    "next_billed_at": "<string>",
    "trial_ends_at": "<string>",
    "paused_at": "<string>",
    "scheduled_resume_at": "<string>",
    "scheduled_change": {
      "effective_at": "<string>",
      "resume_at": "<string>"
    },
    "canceled_at": "<string>",
    "canceled_by": {
      "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,
    "debug_url": "<string>"
  },
  "credits": {
    "charged": 1,
    "balance_after": 1
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<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:

MCP tool create_billing_subscription_checkout, registry package mcp.id/billing_subscriptions, mount id.billing.
Operation action, response envelope action.
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>",
    "price_sid": "<string>",
    "quantity": 123,
    "addons": [
      {
        "product_sid": "<string>",
        "price_sid": "<string>",
        "paddle_item_id": "<string>",
        "quantity": 123
      }
    ],
    "currency": "<string>",
    "current_period_starts_at": "<string>",
    "current_period_ends_at": "<string>",
    "next_billed_at": "<string>",
    "trial_ends_at": "<string>",
    "paused_at": "<string>",
    "scheduled_resume_at": "<string>",
    "scheduled_change": {
      "effective_at": "<string>",
      "resume_at": "<string>"
    },
    "canceled_at": "<string>",
    "canceled_by": {
      "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,
    "debug_url": "<string>"
  },
  "credits": {
    "charged": 1,
    "balance_after": 1
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_billing_subscription_checkout.

price_sid

string

required

Billing price sid (bl_pc_…): a bracket / cadence price.

Required string length: 18

Pattern: ^bl_pc_

quantity

integer

required

Slots to buy on the base plan line; must fall inside the price bracket.

Required range: x >= 1

team_sid

string

Apply to this team on activation; omit / null to buy floating.

Required string length: 18

Pattern: ^ts_tm_

addons

object[]

Optional add-on items bought in the same checkout (one Paddle transaction).

Show child attributes

Response

action success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

action

action

string

required

kebab-case verb; matches the route segment.

item

object | null

required

Show child attributes

result

object

required

Show child attributes

Overview

LinkedIn API

ID and Teams API

Orchestration API

Create subscription checkout

Authorizations

Body

Response