Skip to content
/Balance

Chaching API (1.0)

Chaching is a modern subscription-billing platform designed to simplify product management, customer lifecycle workflows, and recurring payments. It combines a clean dashboard for business users with a powerful API built for developers who need full automation and control.

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://chaching.redocly.app/_mock/developer-guide/api

Customers

This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

Operations

Products

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.

Operations

Transactions

Transactions represent the payments and charges made by your customers.

Operations

Invoices

Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

Operations

TaxRates

TaxRates allow you to calculate the tax to collect from your customer.

Operations

Prices

This object represents a price in your Chaching account. Use it to define the cost of your products, configure one-time or recurring billing intervals, specify tax behavior, and manage pricing updates or deactivations for your offerings.

Operations

Subscriptions

Subscriptions are a way to charge your customers on a recurring basis. They can be used for products or services that are delivered over time, such as memberships or software licenses.

Operations

Balance

Balances represent the amount of money in your account. You can use balances to track your income and expenses, and to make payments to your customers or vendors.

Operations

Retrieve balance

Request

Retrieves the current account balance, based on the authentication that was used to make the request.

Headers
cc-api-keystringrequired

Chaching API Key

curl -i -X GET \
  https://chaching.redocly.app/_mock/developer-guide/api/balance \
  -H 'cc-api-key: string'

Responses

Balance

Bodyapplication/json
objectstringrequired

Type of object returned by Stripe.

Example: "balance"
availableArray of objects(BalanceItemDto)required

List of balances available for payout.

Example: [{"amount":4097256,"currency":"usd","source_types":{"card":4097256}}]
available[].​amountnumberrequired

Amount of funds available or pending in this currency.

Example: 358511
available[].​currencystringrequired

Three-letter ISO currency code.

Example: "usd"
available[].​source_typesobjectrequired

Breakdown of the balance by payment source type.

Example: {"card":4097256}
available[].​source_types.​cardnumberrequired

Total amount coming from card payments.

Example: 4097256
available[].​source_types.​bank_accountnumber

Total amount coming from legacy US ACH payments.

Example: 0
available[].​source_types.​fpxnumber

Total amount coming from FPX payments.

Example: 0
pendingArray of objects(BalanceItemDto)required

List of pending (not yet available) balance amounts.

Example: [{"amount":5169,"currency":"usd","source_types":{"card":5169}}]
pending[].​amountnumberrequired

Amount of funds available or pending in this currency.

Example: 358511
pending[].​currencystringrequired

Three-letter ISO currency code.

Example: "usd"
pending[].​source_typesobjectrequired

Breakdown of the balance by payment source type.

Example: {"card":4097256}
pending[].​source_types.​cardnumberrequired

Total amount coming from card payments.

Example: 4097256
pending[].​source_types.​bank_accountnumber

Total amount coming from legacy US ACH payments.

Example: 0
pending[].​source_types.​fpxnumber

Total amount coming from FPX payments.

Example: 0
livemodebooleanrequired

Indicates whether the balance belongs to a live (production) account.

Example: false
refund_and_dispute_prefundingobjectrequired

Details about prefunded amounts for refunds and disputes.

Example: {"available":[{"amount":0,"currency":"usd"}],"pending":[{"amount":0,"currency":"usd"}]}
refund_and_dispute_prefunding.​availableArray of objects(PrefundingItemDto)required

List of available prefunded balances for refunds and disputes.

Example: [{"amount":0,"currency":"usd"}]
refund_and_dispute_prefunding.​available[].​amountnumberrequired

Amount of prefunding for this currency.

Example: 0
refund_and_dispute_prefunding.​available[].​currencystringrequired

Currency of the prefunded amount.

Example: "pln"
refund_and_dispute_prefunding.​pendingArray of objects(PrefundingItemDto)required

List of pending prefunded balances for refunds and disputes.

Example: [{"amount":0,"currency":"usd"}]
refund_and_dispute_prefunding.​pending[].​amountnumberrequired

Amount of prefunding for this currency.

Example: 0
refund_and_dispute_prefunding.​pending[].​currencystringrequired

Currency of the prefunded amount.

Example: "pln"
Response
application/json
{
  "object": "balance",
  "available": [
    { … }
  ],
  "pending": [
    { … }
  ],
  "livemode": false,
  "refund_and_dispute_prefunding": {
    "available": [ … ],
    "pending": [ … ]
  }
}

Payment Methods

Payment Methods represent a way to collect payment from your customers. They can be attached to customers to make charging easier and more efficient.

Operations