API Reference

Product

💡 To populate relational property, please use include query parameter in the API call.
NameTypeDescription
idstringProduct ID
gatewaystringGateway address
controllerstringController address
controllerRefIdstringController reference ID
namestringProduct name
statusstringCurrent status of the product. Possible values: active, closed.
projectIdstringProject ID
createdAtnumberTimestamp when the product was created
updatedAtnumberTimestamp when the product was updated
pricesArray<Price>Array of price objects associated with the product
type Product = {
  id: string
  gateway: string
  controller: string
  controllerRefId: string
  name: string
  status: string
  projectId: string
  createdAt: number
  updatedAt: number
  // prices: Price[]
}
{
  "id": "prod_3kcjqanqh4ove",
  "gateway": "0xBFAbFfb480F262cF1Cd6D10C3420F92c2492ae5f",
  "controller": "0xF942abc91866aBE495B4FD2daf964419217a692b",
  "controllerRefId": "0x00000000d9674638be1096f8d6550b4d75b2861894c3ca4b0da3390207f23dab",
  "name": "Acme Pro",
  "status": "active",
  "projectId": "76qehgai7xayr87nurj",
  "createdAt": 1684436582,
  "updatedAt": 1684728670
}