Skip to main content
POST
Get a contract (v2)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Contract and customer IDs

customer_id
string<uuid>
required
contract_id
string<uuid>
required
include_ledgers
boolean

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.

as_of_date
string<date-time>

Optional RFC 3339 timestamp. Return the contract as of this date. Cannot be used with include_ledgers parameter.

include_balance
boolean

Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower.

Response

Success

data
object
required