Balance

Use the Balance resource to retrieve the prepaid balance and available credit for your DIDWW account.

A Balance record provides the prepaid account balance, the available credit, and the total balance. The total balance is the sum of the prepaid balance and available credit.

Use this resource to check the funds available on the account before creating orders or performing other inventory operations that may incur charges.

Endpoints

Action	Method	Endpoint
Retrieve account balance	GET	/v3/balance

Retrieve account balance

Retrieves the prepaid balance, available credit, and total balance for the account.

Use this endpoint to determine the total funds available before continuing an inventory or ordering workflow.

See Retrieve Account Balance.

GET /v3/balance

Common balance use cases

Use case	Description
Check the prepaid balance	Retrieve the prepaid funds currently available on the account.
View available credit	Retrieve the credit currently available to the account.
Determine the total balance	Use total_balance to view the combined prepaid balance and available credit.
Prepare an ordering workflow	Check the total funds available before creating a DID order.
Monitor account funds	Retrieve the balance periodically as part of account and inventory management.

Related resources

Use the account balance together with inventory and coverage resources when preparing DID orders.

Resource	Description
Orders	Orders that may use the funds available on the account.
DIDs	Purchased DID phone numbers associated with the account.
Coverage Resources	Resources used to find DID inventory before creating an order.
DID Groups	DID inventory groups with related pricing and Stock Keeping Unit data.
Available DIDs	Specific DID phone numbers available for selection before ordering.