HIhivelocity
Credit

Return the client's total active credit amount

get/credit/total

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/credit/total
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

autoApplyboolean

Whether credits are automatically being applied to new orders

hasCreditPendingOrderboolean

If a client has an incomplete order that is using credit, the "total active" will remain at 0 until the order is completed.

totalActivenumber

The total active amount of credit available on the client account

Changes

No recorded changes to this operation across all 1 revision of this API.