Price

💡 To populate relational property, please use include query parameter in the API call.

Name	Type	Description
id	string	Price ID
productId	string	Product ID
tokenId	string	Token ID
amount	string	Price amount
interval	string	Time between charge cycles (in seconds)
chargeWindow	string	Time window for charging (in seconds)
endTime	string	End time of the price (Timestamp)
status	string	Current status of the price. Possible values: active, closed.
createdAt	number	Timestamp when the price was created
updatedAt	number	Timestamp when the price was updated
product	Product	Product object
token	Token	Token object

TypeScript

type Price = {
  id: string
  productId: string
  tokenId: string
  amount: string
  interval: string
  chargeWindow: string
  endTime: string
  status: string
  createdAt: number
  updatedAt: number
  // product: Product
  // token: Token
}

Example (JSON)

{
  "id": "price_3lg3x2cf0n4mo",
  "productId": "prod_3kcjqanqh4ove",
  "tokenId": "tok_0jevzg89tqeew",
  "amount": "12000000",
  "interval": "2592000",
  "chargeWindow": "604800",
  "endTime": "1099511627775",
  "status": "active",
  "createdAt": 1684436582,
  "updatedAt": 1684436582
}