Skip to main content
POST
/
getBalance
Get Balance API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/getBalance \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "getBalance": {
      "status": 1,
      "data": {
        "value": 5000,
        "currency": "USD"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Response Schema

PathTypeDescription
dataobjectRoot response object.
data.getBalanceobjectContainer for balance details.
data.getBalance.statusnumberAPI execution status (1 = success).
data.getBalance.dataobjectBalance information object.
data.getBalance.data.valuenumberAvailable balance value.
data.getBalance.data.currencystringCurrency code of the balance (e.g., USD).
Note
Rather than fetching the balance before every order, you can use the Low Balance Notification option in the Admin Dashboard to receive alerts when the balance reaches the set threshold. Click here to know more.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Query Parameters

​
query
enum<string>
default:plumProAPI.query.getBalance
required

Always use plumProAPI.query.getBalance.

Available options:
plumProAPI.query.getBalance
​
tag
enum<string>
default:plumProAPI
required

Always use plumProAPI.

Available options:
plumProAPI
​
variables
string
default:{"data":{}}
required

URL-encoded JSON. Pass {"data":{}}.

Response

Balance fetched successfully.

​
data
object