Docs menu
Get started
API reference
Classification
Landed cost
Products
Compliance
Reference
Origin
Shipping documents
Bulk
Catalogue
- GETList products
- POSTCreate a product
- GETGet a product
- PATCHUpdate a product
- POSTArchive a product
- GETA product’s history
- GETA product’s codes
- POSTAdd a code
- POSTSuggest codes
- POSTApprove a code
- POSTReject a code
- POSTClassify many products
- GETYour imports
- POSTImport a CSV file
- GETAn import
- GETExport as CSV
- POSTSync records from a source
- GETApproved codes to write back
- GETCatalogue vocabularies
- GETSource kinds
- GETDefault target markets
- POSTSet default target markets
API reference
Credit balance
GET https://staging-api.border.bot/v1/credits
Requires an API key (Authorization: Bearer bb_live_…).
Current balance, lifetime totals and the 20 most recent ledger entries (purchases, usage, refunds).
API key scope: account.
Responses#
200: Balance and recent ledger. (CreditsResponse)401: Missing, invalid, revoked or expired API key (unauthorized). (Error)403: The API key doesn’t have theaccountscope (forbidden,details.reason: "missing_scope"). (Error)429: Rate limited (rate_limited). Retry afterRetry-Afterseconds;RateLimitsays which limit was hit (r=0,tseconds until its window ends) andRateLimit-Policyits quota. (Error)500: Unexpected error (internal). (Error)
Example#
curl -X GET 'https://staging-api.border.bot/v1/credits' \
-H 'Authorization: Bearer bb_live_...'