Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Billing

Subtract balance from billing account

Subtracts the given balance from the billing account.

post/billing_accounts/{id}/balance_subtract_force

Path parameters

idstring required

The ID of the billing account.

Request body

balancenumber float

Response

Successfully subtracted balance from the billing account

idstring uuid

The unique identifier of the account.

customer_idstring uuid

The unique identifier of the associated customer. Returned from the GET /customers response.

namestring

The display name of the billing account.

detailstring

A human-readable note describing the purpose of this account.

plan_type'free' | 'basic' | 'professional' | 'unlimited'

The plan tier of the billing account. Determines resource creation limits.

plan_status'active' | 'canceling'

The subscription plan status of the billing account. Indicates whether the plan is actively running or scheduled for cancellation.

balance_creditinteger

The credit balance of the account in micros (1 USD = 1,000,000).

balance_tokeninteger

The token balance of the account.

payment_type'' | 'prepaid'

The type of payment associated with the account.

payment_method'' | 'credit card'

The method of payment used for the account.

paddle_subscription_idstring

The Paddle subscription identifier for this billing account. Populated automatically when a Paddle subscription is created via Paddle webhook processing. Read-only — not settable via API. Present only when the account has an active Paddle subscription.

paddle_customer_idstring

The Paddle customer identifier for this billing account. Populated automatically when a Paddle customer record is created via Paddle webhook processing. Read-only — not settable via API. Present only when the account has a linked Paddle customer.

tm_last_topupstring date-time

The timestamp of the last token top-up.

tm_next_topupstring date-time

The timestamp of the next scheduled token top-up.

tm_createstring date-time

The timestamp when the account was created.

tm_updatestring date-time

The timestamp when the account was last updated.

tm_deletestring date-time

The timestamp when the account was deleted, if applicable.

Example response

{
  "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Production Account",
  "detail": "Main billing account for production services",
  "plan_type": "basic",
  "plan_status": "active",
  "balance_credit": 1500000,
  "balance_token": 500,
  "payment_type": "prepaid",
  "payment_method": "credit card",
  "paddle_subscription_id": "sub_01h8bxq9f3e4t5a6g7h8j9k0",
  "paddle_customer_id": "ctm_01h8bxq9f3e4t5a6g7h8j9k0",
  "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}