Credit information

Credit info (/v3/spend/credit-info) retrieves your organization's total credit limit alongside the current balance, credit limit, and available credit limit for each active card network program. Use this to verify that sufficient credit is available before creating a new budget.

Note: Only Spend & Expense users with the ADMIN user role can access credit info.

Get credit info

Send a GET /v3/spend/credit-info request to retrieve the credit info for your organization.

Sample request

curl --request GET \
  --url 'https://gateway.stage.bill.com/connect/v3/spend/credit-info' \
  --header 'apiToken: {api_token}' \
  --header 'Accept: application/json'

Response

In the response, totalCreditLimit is the total credit limit allocated across your entire organization. The creditInfo array has one entry for each active card network program. All amounts are in USD.

Field	Type	Description
`totalCreditLimit`	Number	Total credit limit for the organization.
`creditInfo`	Array	Credit information for each active card network program. The `creditinfo` array will be empty (`[]`) if your organization has no active card network programs.
`network`	String	Card network of the program. Possible values: `VISA`, `MASTERCARD`, `UNDEFINED`.
`balance`	Number	Total spend on the program so far, including settled and pending transactions.
`creditLimit`	Number	Credit limit specific to the card network program.
`availableCreditLimit`	Number	Remaining credit limit available specific to the card network program (`creditLimit` − `balance`).

Example 1: Single card network program

In this example, if you have a single card network program like Mastercard, the creditInfo array contains only one entry. Here, the program's creditLimit is equal to the organization's totalCreditLimit.

{
    "totalCreditLimit": 1000,
    "creditInfo": [
        {
            "network": "MASTERCARD",
            "balance": 12.34,
            "creditLimit": 1000,
            "availableCreditLimit": 987.66
        }
    ]
}

Example 2: Multiple card network programs

In this example, if you have multiple card network programs like Visa and Mastercard, the creditInfo array contains an entry for each program. Here, the organization's totalCreditLimit is the sum of each program's creditLimit.

{
  "totalCreditLimit": 300000.00,
  "creditInfo": [
    {
      "network": "VISA",
      "balance": 11789.33,
      "creditLimit": 200000.00,
      "availableCreditLimit": 188210.67
    },
    {
      "network": "MASTERCARD",
      "balance": 20000.00,
      "creditLimit": 100000.00,
      "availableCreditLimit": 80000.00
    }
  ]
}

See the GET /v3/spend/credit-info API for more information.