Get a contract (v2)
Contracts
Get a contract (v2)
Gets the details for a specific contract, including contract term, rate card information, credits and commits, and more.
Use this endpoint to:
- Check the duration of a customer’s current contract
- Get details on contract terms, including access schedule amounts for commitments and credits
- Understand the state of a contract at a past time. As you can evolve the terms of a contract over time through editing, use the
as_of_dateparameter to view the full contract configuration as of that point in time.
Usage guidelines:
- Optionally, use the
include_balanceandinclude_ledgerfields to include balances and ledgers in the credit and commit responses. Using these fields will cause the query to be slower.
POST
Get a contract (v2)
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Contract and customer IDs
Include commit/credit ledgers in the response. Setting this flag may cause the query to be slower. Cannot be used with as_of_date parameter.
Optional RFC 3339 timestamp. Return the contract as of this date. Cannot be used with include_ledgers parameter.
Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower.
Response
Success