PitchBook: Get Credits Balance State By Period

Show your PitchBook API usage balance over a time window of up to the last 90 days.

Tool ID: pitchbook_get_credits_balance_state_by_period

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_credits_balance_state_by_period',
  {
    "sinceDate": "2026-01-15T12:00:00Z",
    "trailingRange": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pitchbook_get_credits_balance_state_by_period --input '{
  "sinceDate": "2026-01-15T12:00:00Z",
  "trailingRange": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": [
    {
      "contractNumber": "example",
      "activeContract": true,
      "pricingModel": "example"
    }
  ]
}

Use deepline describe pitchbook_get_credits_balance_state_by_period --json for the latest machine-readable contract.

Input reference

Retrieves data about credit usage within the specific timeframe (for up to the last 90 days).

Name	Type	Required	Default	Details
`payload.sinceDate`	`string`	No	—	Add this parameter to extract information for a certain date with the > operator, before a certain date with the < operator and between 2 dates with the ^ operator Format: YYYY-MM-DD
`payload.trailingRange`	`integer`	No	—	Add this parameter to extract information for the last N days

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`array`	Yes	—	Provider response payload.
`result.data[].contractNumber`	`string`	No	—	—
`result.data[].activeContract`	`boolean`	No	—	—
`result.data[].pricingModel`	`string`	No	—	—
`result.data[].creditsChanged`	`integer`	No	—	Format: `int32`.
`result.data[].creditsExpired`	`integer`	No	—	Format: `int32`.
`result.data[].overageUsed`	`integer`	No	—	Format: `int32`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation