Search billing subscriptions
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/billing-subscriptions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"team_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"paddle_subscription_id": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"status": {
"in": [],
"nin": []
},
"collection_mode": {
"in": []
},
"price_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"current_period_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"next_billed_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"trial_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"canceled_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/billing-subscriptions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"team_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"paddle_subscription_id": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"status": {
"in": [],
"nin": []
},
"collection_mode": { "in": [] },
"price_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"current_period_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"next_billed_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"trial_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"canceled_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
owner_user_sid: {eq: '<string>', in: ['<string>']},
team_sid: {eq: '<string>', in: ['<string>'], is_null: true},
paddle_subscription_id: {eq: '<string>', in: ['<string>'], is_null: true},
status: {in: [], nin: []},
collection_mode: {in: []},
price_sid: {eq: '<string>', in: ['<string>']},
current_period_ends_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
next_billed_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
trial_ends_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
canceled_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
updated_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
},
include: [],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/id/v4/api/billing-subscriptions/search', 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/search",
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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'paddle_subscription_id' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'status' => [
'in' => [
],
'nin' => [
]
],
'collection_mode' => [
'in' => [
]
],
'price_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'current_period_ends_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'next_billed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'trial_ends_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'canceled_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'updated_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
]
],
'include' => [
],
'page_size' => 250,
'cursor' => '<string>'
]),
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/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\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/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/billing-subscriptions/search")
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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"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>"
},
"included": {}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"counts": {}
}{
"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
Search billing subscriptions
List the caller's billing subscriptions: the ones they bought (owner = caller, including floating subscriptions applied to no team) plus the one applied to a team they can read. Filter by status, team_sid:{is_null:true} for floating, paddle_subscription_id:{is_null:true} for the trial, or trial_ends_at / current_period_ends_at for expiry windows. include price / product / team / latest_transactions to hydrate context. page_size:0 returns counts only.
Contract:
- MCP tool `search_billing_subscriptions`, registry package `mcp.id/billing_subscriptions`, mount `id.billing`.
- Operation `search`, response envelope `search`.
- Flags: read only.
POST
/
api
/
billing-subscriptions
/
search
Search billing subscriptions
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/billing-subscriptions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"team_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"paddle_subscription_id": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"status": {
"in": [],
"nin": []
},
"collection_mode": {
"in": []
},
"price_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"current_period_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"next_billed_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"trial_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"canceled_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/billing-subscriptions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"team_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"paddle_subscription_id": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"status": {
"in": [],
"nin": []
},
"collection_mode": { "in": [] },
"price_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"current_period_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"next_billed_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"trial_ends_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"canceled_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
owner_user_sid: {eq: '<string>', in: ['<string>']},
team_sid: {eq: '<string>', in: ['<string>'], is_null: true},
paddle_subscription_id: {eq: '<string>', in: ['<string>'], is_null: true},
status: {in: [], nin: []},
collection_mode: {in: []},
price_sid: {eq: '<string>', in: ['<string>']},
current_period_ends_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
next_billed_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
trial_ends_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
canceled_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
updated_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
},
include: [],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/id/v4/api/billing-subscriptions/search', 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/search",
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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'paddle_subscription_id' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'status' => [
'in' => [
],
'nin' => [
]
],
'collection_mode' => [
'in' => [
]
],
'price_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'current_period_ends_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'next_billed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'trial_ends_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'canceled_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'updated_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
]
],
'include' => [
],
'page_size' => 250,
'cursor' => '<string>'
]),
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/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\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/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/billing-subscriptions/search")
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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"paddle_subscription_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"collection_mode\": {\n \"in\": []\n },\n \"price_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"current_period_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"next_billed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"trial_ends_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canceled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"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>"
},
"included": {}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"counts": {}
}{
"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
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 scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of search_billing_subscriptions.
Show child attributes
Show child attributes
Relations to eager-load (see entity Includes).
Available options:
price, product, team, latest_transactions Show child attributes
Show child attributes
0..500, default 50. page_size=0 = count-only, page_size=1 = getFirst.
Required range:
0 <= x <= 500Opaque forward cursor from a previous response pagination.next_cursor.
Response
search success envelope.
Available options:
true Available options:
search Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I