Skip to main content
POST
Add an unbilled (ad-hoc) charge

Path Parameters

Request Body

Unbilled charges are held in a pending state and automatically rolled into the next invoice generated for the subscription. Each charge receives an identifier with a chrg_ prefix.

Example Request

Response

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
amount
integer<int64>
required

Amount in the lowest currency unit (e.g. cents/paise).

currency
string
required
description
string
required
hsn_code
string

Optional HSN/SAC code the charge is taxed at on the invoice. Empty falls back to the tenant SAC.

Response

Charge recorded.

id
string<uuid>
subscription_id
string<uuid>
amount
integer<int64>

Amount in the lowest currency unit.

currency
string
description
string
hsn_code
string

HSN/SAC code the charge is taxed at on the invoice.

status
enum<string>
Available options:
pending,
invoiced,
canceled
period_start
string<date-time>
period_end
string<date-time>
created_at
string<date-time>