Update topup
curl --request PUT \
--url https://api.getcargo.io/v1/billing/subscriptions/topup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"threshold": 123,
"creditsCount": 123
}
'import requests
url = "https://api.getcargo.io/v1/billing/subscriptions/topup"
payload = {
"enabled": True,
"threshold": 123,
"creditsCount": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, threshold: 123, creditsCount: 123})
};
fetch('https://api.getcargo.io/v1/billing/subscriptions/topup', 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://api.getcargo.io/v1/billing/subscriptions/topup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'threshold' => 123,
'creditsCount' => 123
]),
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://api.getcargo.io/v1/billing/subscriptions/topup"
payload := strings.NewReader("{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getcargo.io/v1/billing/subscriptions/topup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/billing/subscriptions/topup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"provider": "stripe",
"customerOrbId": "<string>",
"customerStripeId": "<string>",
"subscriptionStatus": "<string>",
"subscriptionStripeId": "<string>",
"subscriptionAvailableCreditsCount": 123,
"subscriptionCreditsUsedCount": 123,
"additionalAvailableCreditsCount": 123,
"hasCredits": true,
"creditsOverageBehaviors": [
{
"unit": "billing.credits",
"action": "deny"
}
],
"creditsConsumptionBehaviors": [
{
"unit": "billing.credits",
"action": "deny"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"plan": "self-serve",
"cadence": "monthly",
"fixedPrice": 123,
"conversionRate": 123,
"startAt": "<string>",
"resetAt": "<string>",
"endAt": "<string>",
"hasPendingChange": true,
"futureChange": {
"cadence": "monthly",
"fixedPrice": 123,
"creditsCount": 123,
"conversionRate": 123,
"startAt": "<string>",
"endAt": "<string>"
},
"topup": {
"creditsCount": 123,
"threshold": 123
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Billing - Subscription
Update topup
Update the automatic topup settings (PUT /billing/subscriptions/topup).
PUT
/
billing
/
subscriptions
/
topup
Update topup
curl --request PUT \
--url https://api.getcargo.io/v1/billing/subscriptions/topup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"threshold": 123,
"creditsCount": 123
}
'import requests
url = "https://api.getcargo.io/v1/billing/subscriptions/topup"
payload = {
"enabled": True,
"threshold": 123,
"creditsCount": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, threshold: 123, creditsCount: 123})
};
fetch('https://api.getcargo.io/v1/billing/subscriptions/topup', 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://api.getcargo.io/v1/billing/subscriptions/topup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'threshold' => 123,
'creditsCount' => 123
]),
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://api.getcargo.io/v1/billing/subscriptions/topup"
payload := strings.NewReader("{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getcargo.io/v1/billing/subscriptions/topup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/billing/subscriptions/topup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"threshold\": 123,\n \"creditsCount\": 123\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"provider": "stripe",
"customerOrbId": "<string>",
"customerStripeId": "<string>",
"subscriptionStatus": "<string>",
"subscriptionStripeId": "<string>",
"subscriptionAvailableCreditsCount": 123,
"subscriptionCreditsUsedCount": 123,
"additionalAvailableCreditsCount": 123,
"hasCredits": true,
"creditsOverageBehaviors": [
{
"unit": "billing.credits",
"action": "deny"
}
],
"creditsConsumptionBehaviors": [
{
"unit": "billing.credits",
"action": "deny"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"plan": "self-serve",
"cadence": "monthly",
"fixedPrice": 123,
"conversionRate": 123,
"startAt": "<string>",
"resetAt": "<string>",
"endAt": "<string>",
"hasPendingChange": true,
"futureChange": {
"cadence": "monthly",
"fixedPrice": 123,
"creditsCount": 123,
"conversionRate": 123,
"startAt": "<string>",
"endAt": "<string>"
},
"topup": {
"creditsCount": 123,
"threshold": 123
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
bearerAuthoauth2
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
Maximum string length:
255Example:
"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
application/json
Response
Update topup
Updated subscription details.
Show child attributes
Show child attributes
Was this page helpful?

