Skip to content
/Transactions

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

List all transactions

Request

Retrieves a list of transactions for the current account, based on the authentication that was used to make the request.

Query
searchstring(json)
Default ""
pagenumber>= 1
Default 1
takenumber[ 1 .. 50 ]
Default 10
Headers
cc-api-keystringrequired

Chaching API Key

curl -i -X GET \
  'https://chaching.redocly.app/_mock/developer-guide/api/transactions?page=1&take=10' \
  -H 'cc-api-key: string'

Responses

List of transactions

Bodyapplication/json
dataArray of arraysrequired
metaobject(PageMetaDto)required
meta.​pagenumberrequired
meta.​takenumberrequired
meta.​itemsTotalnumberrequired
meta.​pagesTotalnumberrequired
Response
application/json
{
  "data": [
    []
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "itemsTotal": 0,
    "pagesTotal": 0
  }
}

Retrieve a transaction

Request

Retrieves detailed information about a specific transaction for the current account, based on the authentication that was used to make the request.

Path
idstringrequired

Transaction ID

Headers
cc-api-keystringrequired

Chaching API Key

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

Responses

Transaction details

Bodyapplication/json
idstringrequired

Unique identifier for the object.

Example: "txn_1MiN3gLkdIwHu7ixxapQrznl"
objectstringrequired

String representing the object’s type.

Example: "balance_transaction"
amountnumberrequired

Gross amount of this transaction (in cents).

Example: -400
payment_methodstringrequired

ID of the payment method used in this transaction.

Example: "pm_1MiN3gLkdIwHu7ixxYzWqR2b"
balance_typestringrequired

The balance type of the transaction.

Example: "default"
available_onnumberrequired

The date that the transaction’s net funds become available in the Stripe balance.

Example: 1678043844
creatednumberrequired

The date the transaction was created.

Example: 1678043844
currencystringrequired

Three-letter ISO currency code.

Example: "usd"
descriptionstring

Description of the transaction.

Example: "Transfer to acct_1MiN3gLkdIwHu7ix"
exchange_ratenumber

The exchange rate applied to this transaction.

Example: null
feenumberrequired

The fee applied to this transaction (in cents).

Example: 0
fee_detailsArray of stringsrequired

Detailed breakdown of fees (in cents) paid for this transaction.

Example: []
netnumberrequired

The net amount of this transaction (in cents).

Example: -400
statusstringrequired

The status of the transaction.

Example: "available"
typestringrequired

The type of the transaction.

Example: "transfer"
Response
application/json
{
  "id": "txn_1MiN3gLkdIwHu7ixxapQrznl",
  "object": "balance_transaction",
  "amount": -400,
  "payment_method": "pm_1MiN3gLkdIwHu7ixxYzWqR2b",
  "balance_type": "default",
  "available_on": 1678043844,
  "created": 1678043844,
  "currency": "usd",
  "description": "Transfer to acct_1MiN3gLkdIwHu7ix",
  "exchange_rate": null,
  "fee": 0,
  "fee_details": [],
  "net": -400,
  "status": "available",
  "type": "transfer"
}

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

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