---
title: "Update topup"
method: PUT
path: "/billing/subscriptions/topup"
tags: ["Billing - Subscription"]
---

# Update topup

`PUT /billing/subscriptions/topup`

Update the automatic topup settings

## Request body

- object — Request body schema.
  - `enabled` boolean, required — Whether top-ups are enabled.
  - `threshold` number, required — Credit threshold that triggers a top-up.
  - `creditsCount` number, required — Number of credits to top up.

## Response `200`

Successful response

- object
  - `subscription` object, required — Updated subscription details.
    - `uuid` string, required
    - `workspaceUuid` string, required
    - `provider` 'stripe' | 'orb', required
    - `customerOrbId` string, required
    - `customerStripeId` string, required
    - `subscriptionStatus` string, nullable, required
    - `subscriptionStripeId` string, nullable, required
    - `subscriptionAvailableCreditsCount` number, required
    - `subscriptionCreditsUsedCount` number, required
    - `additionalAvailableCreditsCount` number, required
    - `hasCredits` boolean, required
    - `creditsOverageBehaviors` object[], required
      - `unit` 'billing.credits' | 'storage.records' | 'orchestration.executions', required
      - `action` 'deny' | 'allow', required
    - `creditsConsumptionBehaviors` object[], required
      - `unit` 'billing.credits' | 'storage.records' | 'orchestration.executions', required
      - `action` 'deny' | 'allow', required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `plan` 'self-serve' | 'enterprise', required
    - `cadence` 'monthly' | 'annual' | 'one_time' | 'quarterly' | 'semi_annual' | 'custom', required
    - `fixedPrice` number, required
    - `conversionRate` number, required
    - `startAt` string, required
    - `resetAt` string, required
    - `endAt` string, nullable, required
    - `hasPendingChange` boolean, required
    - `futureChange` object, nullable, required
      - `cadence` 'monthly' | 'annual' | 'one_time' | 'quarterly' | 'semi_annual' | 'custom', required
      - `fixedPrice` number, required
      - `creditsCount` number, required
      - `conversionRate` number, required
      - `startAt` string, required
      - `endAt` string, nullable, required
    - `topup` object, nullable, required
      - `creditsCount` number, required
      - `threshold` number, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/versions/1d5a19e01d83/schema)