Account Information

Contracts History

Retrieves data for contracts within the account

get/contracts/history

Request

  • Base URL
    https://api.pitchbook.com
  • URL
    https://api.pitchbook.com/contracts/history
  • Auth
    API key in header Authorization

Query parameters

activeContractstring

Specify the type of contracts to be returned in a response. To get information only for the active contracts set this parameter as True, and only for the past contracts - as False. Do not set this parameter to receive data about all types of contracts

Response

OK

contractNumberstring
activeContractboolean
pricingModelstring
startDatestring date
endDatestring date
creditsUsedinteger
creditsChangedinteger
creditsExpiredinteger
creditsRemaininginteger
overageUsedinteger

Example response

[
  {
    "contractNumber": "NUMBER123",
    "activeContract": true,
    "pricingModel": "Subscription",
    "startDate": "2023-01-01",
    "endDate": "2025-01-01",
    "creditsUsed": 9888,
    "creditsChanged": -100,
    "creditsRemaining": 1222
  }
]

Changes

No recorded changes to this operation across all 9 revisions of this API.