Cut.ProDocs
Account: credits

Get credit history

Returns the credit transaction ledger for this workspace, newest first. Each row shows the delta (amount, negative for debits), the resulting balance, and what caused it (reference_type + reference_id) so you can reconcile against submissions, renewals, refunds, and bonuses.

Authorization

apiKey
X-Api-Key<token>

In: header

Query Parameters

page?number

Page number (default: 1)

Range1 <= value
limit?number

Items per page (default: 50, max: 100)

Range1 <= value <= 100
type?string

Value in

  • "credit"
  • "debit"
  • "refund"
  • "bonus"
  • "subscription_renewal"
  • "subscription_activation"
reference_type?string

Value in

  • "subscription"
  • "refund"
  • "bonus"
  • "usage"
  • "adjustment"
  • "championship"
  • "championship_prize"
  • "championship_refund"
  • "championship_period_prize"
  • "championship_per_thousand_views"
  • "championship_per_post"
  • "credit_bundle"
  • "workspace_transfer"
  • "referral"

Response Body

application/json

GET
/balance/history
curl -X GET "https://example.com/balance/history"
{  "transactions": [    {      "id": "string",      "type": "credit",      "amount": 0,      "balance_after": 0,      "reference_type": "subscription",      "reference_id": "string",      "description": "string",      "waived": true,      "expires_at": "string",      "created_at": "string"    }  ],  "pagination": {    "current_page": 0,    "total_pages": 0,    "total_count": 0,    "has_next_page": true,    "has_previous_page": true,    "limit": 0  }}

Get balance GET

Returns your current credit balance. Credits are consumed each time you submit a video for clipping. When `unlimited` is true this workspace is on a courtesy plan: usage still shows up in the history with what it would have cost, but the balance does not move and jobs are never blocked for lack of credits.

List plans and credit packs GET

Free. The plans and credit packs this workspace can buy, at the price cut.pro charges this user, each with a checkout link: a cut.pro page that opens the payment with that plan or pack already chosen, in this workspace. The user pays there; nothing is charged by this call. Offer it when a job needs more credits than the balance (`INSUFFICIENT_CREDITS`) or the user asks about plans, prices or more credits: a pack covers a one-off job (suggest the smallest one with at least the missing credits), and a plan suits someone who creates every month (`credits_per_month` renews monthly, and `highlights` says what else it includes). When `can_buy` is `false` only the workspace owner can buy, so tell the user to ask them. `SOLD_ON_SITE` means the app this key belongs to does not allow purchases: send the user to cut.pro.