Update plan

Update the subscription plan

PUT /billing/subscriptions/plan

Update plan

cURL

curl --request PUT \
  --url https://api.getcargo.io/v1/billing/subscriptions/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditsCount": 123
}
'

import requests

url = "https://api.getcargo.io/v1/billing/subscriptions/plan"

payload = { "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({creditsCount: 123})
};

fetch('https://api.getcargo.io/v1/billing/subscriptions/plan', 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/plan",
  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([
    '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/plan"

	payload := strings.NewReader("{\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/plan")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditsCount\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/billing/subscriptions/plan")

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  \"creditsCount\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "subscription": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "customerOrbId": "<string>",
    "customerStripeId": "<string>",
    "subscriptionStatus": "<string>",
    "subscriptionStripeId": "<string>",
    "subscriptionAvailableCreditsCount": 123,
    "subscriptionCreditsUsedCount": 123,
    "additionalAvailableCreditsCount": 123,
    "hasCredits": true,
    "creditsOverageBehaviors": [
      {}
    ],
    "creditsConsumptionBehaviors": [
      {}
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "fixedPrice": 123,
    "conversionRate": 123,
    "startAt": "<string>",
    "resetAt": "<string>",
    "endAt": "<string>",
    "hasPendingChange": true,
    "futureChange": {
      "fixedPrice": 123,
      "creditsCount": 123,
      "conversionRate": 123,
      "startAt": "<string>",
      "endAt": "<string>"
    },
    "topup": {
      "creditsCount": 123,
      "threshold": 123
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

creditsCount · number · required

Number of credits in the plan.

cadence · enum<string> · required

Billing cadence for the plan.

Available options: monthly, annual, one_time, quarterly, semi_annual, custom

Response

200

application/json

Successful response

subscription · Subscription · object · required

Updated subscription details.

Show child attributes