Skip to main content
PUT
/
billing
/
subscription
/
plan
Update plan
curl --request PUT \
  --url https://api.getcargo.io/v1/billing/subscription/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditsCount": 123
}
'
{
  "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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Successful response

​
subscription
Subscription · object
required

Updated subscription details.