Skip to content
Developer Guide
/
/
List all tax rates

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

List all tax rates

Request

Retrieves a paginated list of all tax rates for the authenticated account. Supports pagination and filtering.

Query
searchstring

{"active":true, "inclusive":false, "created[gt|gte|lt|lte]":1766066322}

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/taxRates?page=1&take=10' \
  -H 'cc-api-key: string'

Responses

Successfully retrieved paginated list of tax rates

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
  }
}

Create a tax rate

Request

Creates a new tax rate for the authenticated account. Tax rates define the percentage of tax to be applied to transactions.

Headers
cc-api-keystringrequired

Chaching API Key

Bodyapplication/jsonrequired

Tax rate data to create

tax_typestringrequired

Type of tax rate

Enum"Sales tax""VAT""GST""Custom"
Example: "Custom"
display_namestring

Display name for the tax rate. Required when tax_type is Custom

Example: "Custom Tax Rate"
descriptionstring

Description of the tax rate

Example: "Tax rate for custom purposes"
countrystringrequired

Country code (only US is supported)

Value"US"
Example: "US"
percentagenumber[ 0 .. 100 ]required

The tax percentage rate, e.g., 7.25 for 7.25%.

Example: 8.5
inclusivebooleanrequired

Whether this tax rate is inclusive or exclusive

Default false
Example: false
curl -i -X POST \
  https://chaching.redocly.app/_mock/developer-guide/api/taxRates \
  -H 'Content-Type: application/json' \
  -H 'cc-api-key: string' \
  -d '{
    "display_name": "Sales Tax",
    "percentage": 8.5,
    "inclusive": false,
    "active": true
  }'

Responses

Tax rate successfully created

Bodyapplication/json
idstring(string)required

Unique identifier for the object.

Example: "txr_inQ4hbLZPyljDXFRCEnjtEqK"
objectstringrequired

String representing the object’s type.

Default "tax_rate"
Value"tax_rate"
Example: "tax_rate"
activebooleanrequired

Indicates whether the object is active.

Example: true
countrystring or null

Two-letter ISO country code representing the country for the tax rate (only US is supported)

Value"US"
Example: "US"
creatednumber>= 0required

Timestamp (in seconds since Unix epoch) of when the object was created.

Example: 1678833149
descriptionstring or null

An arbitrary string attached to the object. Often useful for displaying to users.

Example: "State sales tax"
display_namestringrequired

The display name of the tax rate, e.g., "Sales Tax".

Example: "Sales Tax"
inclusivebooleanrequired

Specifies if the tax is inclusive (included in price) or exclusive (added on top).

Example: true
percentagenumber[ 0 .. 100 ]required

The tax percentage rate, e.g., 7.25 for 7.25%.

Example: 7.25
tax_typestringrequired

Type of the tax rate

Enum"Sales tax""VAT""GST""Custom"
Example: "Custom"
Response
application/json
{
  "id": "txr_inQ4hbLZPyljDXFRCEnjtEqK",
  "object": "tax_rate",
  "active": true,
  "country": "US",
  "created": 1678833149,
  "description": "State sales tax",
  "display_name": "Sales Tax",
  "inclusive": true,
  "percentage": 7.25,
  "tax_type": "Custom"
}

Retrieve a tax rate

Request

Retrieves a specific tax rate by its unique identifier.

Path
idstringrequired

Unique identifier of the tax rate

Example: txr_inQ4hbLZPyljDXFRCEnjtEqK
Headers
cc-api-keystringrequired

Chaching API Key

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

Responses

Successfully retrieved the tax rate

Bodyapplication/json
idstring(string)required

Unique identifier for the object.

Example: "txr_inQ4hbLZPyljDXFRCEnjtEqK"
objectstringrequired

String representing the object’s type.

Default "tax_rate"
Value"tax_rate"
Example: "tax_rate"
activebooleanrequired

Indicates whether the object is active.

Example: true
countrystring or null

Two-letter ISO country code representing the country for the tax rate (only US is supported)

Value"US"
Example: "US"
creatednumber>= 0required

Timestamp (in seconds since Unix epoch) of when the object was created.

Example: 1678833149
descriptionstring or null

An arbitrary string attached to the object. Often useful for displaying to users.

Example: "State sales tax"
display_namestringrequired

The display name of the tax rate, e.g., "Sales Tax".

Example: "Sales Tax"
inclusivebooleanrequired

Specifies if the tax is inclusive (included in price) or exclusive (added on top).

Example: true
percentagenumber[ 0 .. 100 ]required

The tax percentage rate, e.g., 7.25 for 7.25%.

Example: 7.25
tax_typestringrequired

Type of the tax rate

Enum"Sales tax""VAT""GST""Custom"
Example: "Custom"
Response
application/json
{
  "id": "txr_inQ4hbLZPyljDXFRCEnjtEqK",
  "object": "tax_rate",
  "active": true,
  "country": "US",
  "created": 1678833149,
  "description": "State sales tax",
  "display_name": "Sales Tax",
  "inclusive": true,
  "percentage": 7.25,
  "tax_type": "Custom"
}

Update a tax rate

Request

Updates an existing tax rate by its unique identifier. Only the provided fields will be updated.

Path
idstringrequired

Unique identifier of the tax rate to update

Example: txr_inQ4hbLZPyljDXFRCEnjtEqK
Headers
cc-api-keystringrequired

Chaching API Key

Bodyapplication/jsonrequired
tax_typestringrequired

Type of tax rate

Enum"Sales tax""VAT""GST""Custom"
Example: "Custom"
display_namestring

Display name for the tax rate. Required when tax_type is Custom

Example: "Custom Tax Rate"
descriptionstring

Description of the tax rate

Example: "Tax rate for custom purposes"
curl -i -X PATCH \
  https://chaching.redocly.app/_mock/developer-guide/api/taxRates/txr_inQ4hbLZPyljDXFRCEnjtEqK \
  -H 'Content-Type: application/json' \
  -H 'cc-api-key: string' \
  -d '{
    "tax_type": "Custom",
    "display_name": "Custom Tax Rate",
    "description": "Tax rate for custom purposes"
  }'

Responses

Tax rate successfully updated

Bodyapplication/json
idstring(string)required

Unique identifier for the object.

Example: "txr_inQ4hbLZPyljDXFRCEnjtEqK"
objectstringrequired

String representing the object’s type.

Default "tax_rate"
Value"tax_rate"
Example: "tax_rate"
activebooleanrequired

Indicates whether the object is active.

Example: true
countrystring or null

Two-letter ISO country code representing the country for the tax rate (only US is supported)

Value"US"
Example: "US"
creatednumber>= 0required

Timestamp (in seconds since Unix epoch) of when the object was created.

Example: 1678833149
descriptionstring or null

An arbitrary string attached to the object. Often useful for displaying to users.

Example: "State sales tax"
display_namestringrequired

The display name of the tax rate, e.g., "Sales Tax".

Example: "Sales Tax"
inclusivebooleanrequired

Specifies if the tax is inclusive (included in price) or exclusive (added on top).

Example: true
percentagenumber[ 0 .. 100 ]required

The tax percentage rate, e.g., 7.25 for 7.25%.

Example: 7.25
tax_typestringrequired

Type of the tax rate

Enum"Sales tax""VAT""GST""Custom"
Example: "Custom"
Response
application/json
{
  "id": "txr_inQ4hbLZPyljDXFRCEnjtEqK",
  "object": "tax_rate",
  "active": true,
  "country": "US",
  "created": 1678833149,
  "description": "State sales tax",
  "display_name": "Sales Tax",
  "inclusive": true,
  "percentage": 7.25,
  "tax_type": "Custom"
}

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