Skip to main content
GET
/
v1
/
usage
curl https://api.v2.dealmachine.com/v1/usage \
  -H "Authorization: Bearer dm_sk_live_xxx"
{
  "plan": {
    "name": "Pro",
    "is_paid": true
  },
  "billing_cycle": {
    "start": "2025-06-01T00:00:00.000Z",
    "end": "2025-07-01T00:00:00.000Z"
  },
  "credits": {
    "included": 20000,
    "used": 1523,
    "remaining": 18477,
    "overage": 0,
    "breakdown": {
      "properties": 847,
      "people": 676,
      "companies": 0
    }
  }
}
Get your current billing cycle credit usage at a glance — plan info, credits used, credits remaining, and a breakdown by entity type.
curl https://api.v2.dealmachine.com/v1/usage \
  -H "Authorization: Bearer dm_sk_live_xxx"
{
  "plan": {
    "name": "Pro",
    "is_paid": true
  },
  "billing_cycle": {
    "start": "2025-06-01T00:00:00.000Z",
    "end": "2025-07-01T00:00:00.000Z"
  },
  "credits": {
    "included": 20000,
    "used": 1523,
    "remaining": 18477,
    "overage": 0,
    "breakdown": {
      "properties": 847,
      "people": 676,
      "companies": 0
    }
  }
}

Response Fields

plan

FieldTypeDescription
namestringPlan name (e.g. No plan, Starter, Pro)
is_paidbooleanWhether this is a paid plan

billing_cycle

FieldTypeDescription
startstringISO 8601 start of the current billing cycle
endstringISO 8601 end of the current billing cycle (credits reset at this time)

credits

FieldTypeDescription
includednumberTotal credits included in your plan for this billing cycle
usednumberCredits consumed so far this billing cycle
remainingnumberCredits remaining before overages begin
overagenumberCredits used beyond your included allowance (billed separately)

credits.breakdown

FieldTypeDescription
propertiesnumberUnique properties accessed this billing cycle
peoplenumberUnique people accessed this billing cycle
companiesnumberUnique companies accessed this billing cycle
Credits are deduplicated within your billing period. Accessing the same property or contact multiple times in one billing cycle only counts once.
Call this endpoint before large batch operations to check your remaining credits and avoid unexpected overages.