> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PitchBook: Get Credits Balance State By Period

> Show your PitchBook API usage balance over a time window of up to the last 90 days. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves data about credit usage within the specific timeframe (for up to the last 90 days).",
    "properties": {
      "sinceDate": {
        "type": "string",
        "description": "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"
      },
      "trailingRange": {
        "type": "integer",
        "description": "Add this parameter to extract information for the last N days"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "contractNumber": {
              "type": "string"
            },
            "activeContract": {
              "type": "boolean"
            },
            "pricingModel": {
              "type": "string"
            },
            "creditsChanged": {
              "type": "integer",
              "format": "int32"
            },
            "creditsExpired": {
              "type": "integer",
              "format": "int32"
            },
            "overageUsed": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [PitchBook provider guide](https://deepline.com/docs/providers/pitchbook/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.