Upsert a subscription
curl --request POST \
--url https://crm.example.com/public-api/v1/subscriptions/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"payingPerMonth": 50000000,
"currency": "<string>",
"externalId": "sub_8812",
"startedAt": "<string>",
"endedAt": "<string>",
"trialEndsAt": "<string>"
}
'import requests
url = "https://crm.example.com/public-api/v1/subscriptions/upsert"
payload = {
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"payingPerMonth": 50000000,
"currency": "<string>",
"externalId": "sub_8812",
"startedAt": "<string>",
"endedAt": "<string>",
"trialEndsAt": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
payingPerMonth: 50000000,
currency: '<string>',
externalId: 'sub_8812',
startedAt: '<string>',
endedAt: '<string>',
trialEndsAt: '<string>'
})
};
fetch('https://crm.example.com/public-api/v1/subscriptions/upsert', 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://crm.example.com/public-api/v1/subscriptions/upsert",
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([
'partyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'payingPerMonth' => 50000000,
'currency' => '<string>',
'externalId' => 'sub_8812',
'startedAt' => '<string>',
'endedAt' => '<string>',
'trialEndsAt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://crm.example.com/public-api/v1/subscriptions/upsert"
payload := strings.NewReader("{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://crm.example.com/public-api/v1/subscriptions/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm.example.com/public-api/v1/subscriptions/upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Subscription upserted",
"metaData": {
"warnings": [
"<string>"
]
},
"data": {
"id": "<string>",
"partyId": "<string>",
"externalId": "<string>",
"description": "<string>",
"payingPerMonth": 123,
"currency": "<string>",
"startedAt": "2026-11-20T09:00:00.000Z",
"endedAt": "2026-11-20T09:00:00.000Z",
"trialEndsAt": "2026-11-20T09:00:00.000Z"
}
}{
"type": "bad_request",
"message": "partyId: Invalid uuid"
}{
"type": "unauthorized",
"message": "Send a valid API key as Authorization: Bearer gd_key_…"
}{
"type": "not_found",
"message": "contact not found"
}{
"type": "rate_limited",
"message": "Rate limit reached. Retry in 30s."
}Revenue
Upsert a subscription
What the contact pays from a billing system that is not connected, such as Paddle or your own. Amounts are minor units a month. It moves the contact’s lifecycle the same way a Stripe subscription does.
POST
/
v1
/
subscriptions
/
upsert
Upsert a subscription
curl --request POST \
--url https://crm.example.com/public-api/v1/subscriptions/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"payingPerMonth": 50000000,
"currency": "<string>",
"externalId": "sub_8812",
"startedAt": "<string>",
"endedAt": "<string>",
"trialEndsAt": "<string>"
}
'import requests
url = "https://crm.example.com/public-api/v1/subscriptions/upsert"
payload = {
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"payingPerMonth": 50000000,
"currency": "<string>",
"externalId": "sub_8812",
"startedAt": "<string>",
"endedAt": "<string>",
"trialEndsAt": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
payingPerMonth: 50000000,
currency: '<string>',
externalId: 'sub_8812',
startedAt: '<string>',
endedAt: '<string>',
trialEndsAt: '<string>'
})
};
fetch('https://crm.example.com/public-api/v1/subscriptions/upsert', 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://crm.example.com/public-api/v1/subscriptions/upsert",
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([
'partyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'payingPerMonth' => 50000000,
'currency' => '<string>',
'externalId' => 'sub_8812',
'startedAt' => '<string>',
'endedAt' => '<string>',
'trialEndsAt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://crm.example.com/public-api/v1/subscriptions/upsert"
payload := strings.NewReader("{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://crm.example.com/public-api/v1/subscriptions/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm.example.com/public-api/v1/subscriptions/upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"payingPerMonth\": 50000000,\n \"currency\": \"<string>\",\n \"externalId\": \"sub_8812\",\n \"startedAt\": \"<string>\",\n \"endedAt\": \"<string>\",\n \"trialEndsAt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Subscription upserted",
"metaData": {
"warnings": [
"<string>"
]
},
"data": {
"id": "<string>",
"partyId": "<string>",
"externalId": "<string>",
"description": "<string>",
"payingPerMonth": 123,
"currency": "<string>",
"startedAt": "2026-11-20T09:00:00.000Z",
"endedAt": "2026-11-20T09:00:00.000Z",
"trialEndsAt": "2026-11-20T09:00:00.000Z"
}
}{
"type": "bad_request",
"message": "partyId: Invalid uuid"
}{
"type": "unauthorized",
"message": "Send a valid API key as Authorization: Bearer gd_key_…"
}{
"type": "not_found",
"message": "contact not found"
}{
"type": "rate_limited",
"message": "Rate limit reached. Retry in 30s."
}Authorizations
Body
application/json