Skip to main content
GET
/
api
/
teams
/
{teamId}
/
credit
curl -X GET "https://deelrxcrm.app/api/teams/team_123/credit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "creditLimit": 500000,
  "currentBalance": 125000,
  "availableCredit": 375000,
  "status": "active",
  "paymentTerms": "net30",
  "recentTransactions": [
    {
      "id": "txn_abc123",
      "type": "charge",
      "amount": 75000,
      "description": "Order #ORD-001",
      "createdAt": "2024-01-15T10:30:00Z",
      "status": "completed",
      "dueDate": "2024-02-14T23:59:59Z"
    },
    {
      "id": "txn_def456", 
      "type": "payment",
      "amount": -50000,
      "description": "Payment received - Check #1234",
      "createdAt": "2024-01-10T14:22:00Z",
      "status": "completed"
    }
  ]
}
Retrieves the current credit status for a team, including credit limit, available credit, recent transactions, and payment history.

​
Path Parameters

​
teamId
string
required
The unique identifier for the team

​
Response

​
creditLimit
number
Total credit limit in cents
​
currentBalance
number
Current outstanding balance in cents (positive = owed to you)
​
availableCredit
number
Available credit remaining in cents
​
status
string
Credit account status: active, suspended, closed, or defaulted
​
paymentTerms
string
Payment terms (e.g., “net30”, “net15”, “due_on_receipt”)
​
recentTransactions
array
Array of recent credit transactions
curl -X GET "https://deelrxcrm.app/api/teams/team_123/credit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "creditLimit": 500000,
  "currentBalance": 125000,
  "availableCredit": 375000,
  "status": "active",
  "paymentTerms": "net30",
  "recentTransactions": [
    {
      "id": "txn_abc123",
      "type": "charge",
      "amount": 75000,
      "description": "Order #ORD-001",
      "createdAt": "2024-01-15T10:30:00Z",
      "status": "completed",
      "dueDate": "2024-02-14T23:59:59Z"
    },
    {
      "id": "txn_def456", 
      "type": "payment",
      "amount": -50000,
      "description": "Payment received - Check #1234",
      "createdAt": "2024-01-10T14:22:00Z",
      "status": "completed"
    }
  ]
}

​
Usage Notes

  • Credit limits and balances are returned in cents (e.g., 500000 = $5,000.00)
  • The currentBalance represents money owed to you (positive) or credit balance (negative)
  • availableCredit is calculated as creditLimit - currentBalance (capped at 0 if over limit)
  • Recent transactions are limited to the last 10 transactions; use the transactions endpoint for full history

​
Rate Limits

This endpoint is subject to standard rate limits:
  • 100 requests per minute per API key
  • 1000 requests per hour per API key
Use this endpoint to display credit information in your application UI or to perform credit checks before processing orders.