Billing — TypeScript SDK

Use your deployed API Router Gateway for model requests. Check the deployed version and required permissions. Example addresses are placeholders.

Monthly billing queries broken down by GPU spec, AI service, or line-item detail.

Overview

The Billing resource exposes month-cycle billing data: a per-cycle summary, paginated breakdowns by GPU spec and AI service, and a detailed line-item list. All methods take a billingCycle in "YYYY-MM" format.

Accessed via client.billing.

Available Operations

Method	Description
queryAllAmount()	Monthly billing summary
queryBillByGpu()	Paginated bill rows aggregated by GPU spec
queryBillByService()	Paginated bill rows aggregated by AI service
queryBillList()	Detailed paginated bill list

queryAllAmount

Monthly billing summary for the given cycle.

Example Usage

import { WltClient } from 'wlt-platform';

const client = new WltClient({ apiKey: 'your-api-key', baseUrl: 'https://console.example.com' });

const bill = await client.billing.queryAllAmount({ billingCycle: '2026-04' });
console.log(`Total amount: ${bill.pretaxAmountSum}`);
console.log(`Currency: ${bill.currency}`);

Parameters

Parameter	Type	Required	Default	Description
billingCycle	string	Yes	—	Billing cycle, format "YYYY-MM" (e.g. "2026-04")

Response

Returns UserBillingMonthResponse:

Field	Type	Description
afterDiscountAmountSum	number	Amount after discount
deductedByCouponsSum	number	Coupon deduction amount
pretaxGrossAmountSum	number	Original amount (list price)
pretaxAmountSum	number	Payable amount
currency	string	Currency code (e.g. "USD")

Errors

Code	Error	When
1001	Validation error	billingCycle missing or not YYYY-MM
2000 / 2002	Authentication failure	API Key invalid
2007	Permission denied	Token lacks permission
3001	Token expired	Refresh failed

queryBillByGpu

Paginated bill rows aggregated by GPU spec.

Example Usage

const result = await client.billing.queryBillByGpu({
  billingCycle: '2026-04',
  pageNum: 1,
  pageSize: 10,
});
for (const item of result.list) {
  console.log(`GPU: ${item.gpuSpec}, Amount: ${item.pretaxAmountSum}`);
}

Parameters

Parameter	Type	Required	Default	Description
billingCycle	string	Yes	—	Billing cycle, format "YYYY-MM"
pageNum	number	No	1	Page number, starting from 1
pageSize	number	No	10	Items per page

Response

Returns PageInfo<UserBillingGpuServiceResponse>. UserBillingGpuServiceResponse:

Field	Type	Description
afterDiscountAmountSum	number	Amount after discount
deductedByCouponsSum	number	Coupon deduction amount
pretaxGrossAmountSum	number	Original amount
pretaxAmountSum	number	Payable amount
listPrice	number	List price (unit price)
currency	string	Currency code
gpuSpec	string	GPU spec (e.g. "A100-80G")
servicePeriodUnit	string	Service period unit (e.g. "Hour")
servicePeriodSum	string	Total service period
modelResource	string	Model resource identifier

Errors

Code	Error	When
1001	Validation error	billingCycle missing or not YYYY-MM
2000 / 2002	Authentication failure	API Key invalid
2007	Permission denied	Token lacks permission
3001	Token expired	Refresh failed

queryBillByService

Paginated bill rows aggregated by AI service.

Example Usage

const result = await client.billing.queryBillByService({
  billingCycle: '2026-04',
  pageNum: 1,
  pageSize: 10,
});
for (const item of result.list) {
  console.log(`Service: ${item.bizType}, Amount: ${item.pretaxAmountSum}`);
}

Parameters

Parameter	Type	Required	Default	Description
billingCycle	string	Yes	—	Billing cycle, format "YYYY-MM"
pageNum	number	No	1	Page number, starting from 1
pageSize	number	No	10	Items per page

Response

Returns PageInfo<UserBillingAiServiceResponse>. UserBillingAiServiceResponse:

Field	Type	Description
afterDiscountAmountSum	number	Amount after discount
deductedByCouponsSum	number	Coupon deduction amount
pretaxGrossAmountSum	number	Original amount
pretaxAmountSum	number	Payable amount
currency	string	Currency code
gpuSpec	string	GPU spec
modelResource	string	Model resource identifier
servicePeriodUnit	string	Service period unit
servicePeriodSum	string	Total service period
bizType	string	Business type (e.g. "Deploy", "Finetune")

Errors

Code	Error	When
1001	Validation error	billingCycle missing or not YYYY-MM
2000 / 2002	Authentication failure	API Key invalid
2007	Permission denied	Token lacks permission
3001	Token expired	Refresh failed

queryBillList

Detailed paginated bill list.

Example Usage

const result = await client.billing.queryBillList({
  billingCycle: '2026-04',
  pageNum: 1,
  pageSize: 20,
});
console.log(`Total records: ${result.total}`);
for (const item of result.list) {
  console.log(item);
}

Parameters

Parameter	Type	Required	Default	Description
billingCycle	string	Yes	—	Billing cycle, format "YYYY-MM"
pageNum	number	No	1	Page number, starting from 1
pageSize	number	No	10	Items per page

Response

Returns PageInfo<UserBillingResponse>. UserBillingResponse:

Field	Type	Description
afterDiscountAmount	number	Amount after discount
deductedByCoupons	number	Coupon deduction amount
pretaxGrossAmount	number	Original amount
pretaxAmount	number	Payable amount
instanceID	string	Instance ID
currency	string	Currency code
productCode	string	Product code
region	string	Region
gpuSpec	string	GPU spec
modelResource	string	Model resource identifier
servicePeriodUnit	string	Service period unit
servicePeriod	string	Service period
bizType	string	Business type (e.g. "Deploy", "Finetune")

Errors

Code	Error	When
1001	Validation error	billingCycle missing or not YYYY-MM
2000 / 2002	Authentication failure	API Key invalid
2007	Permission denied	Token lacks permission
3001	Token expired	Refresh failed