Product

Something a merchant sells. Its prices (prices) say how much it costs and how often it bills. A subscription created from a price keeps the price's productId.

type Product {
  id: ID!
  name: String!
  description: String
  images: [String!]
  slug: String
  shippable: Boolean
  unitLabel: String
  descriptor: String
  defaultPriceId: ID
  active: Boolean!
  metadata: [KeyValueItem!]
  createdAt: AWSTimestamp!
  updatedAt: AWSTimestamp
}

Fields

Product.id ● ID! non-null scalar

Product ID.

Product.name ● String! non-null scalar

Product name, up to 100 characters.

Product.description ● String scalar

Product description, up to 1000 characters.

Product.images ● [String!] list scalar

Image URLs of the product (https only), up to 8.

Product.slug ● String scalar

Short name of the product, unique in the account: lowercase letters and digits joined by single hyphens (for example gold-plan), up to 100 characters.

Product.shippable ● Boolean scalar

Whether the product is shipped to the buyer.

Product.unitLabel ● String scalar

Name of one unit of the product (for example seat), up to 12 characters.

Product.descriptor ● String scalar

Statement descriptor stored on the product, up to 25 characters. Not applied to payments or subscriptions yet: set descriptor on the subscription.

Product.defaultPriceId ● ID scalar

ID of the default price of the product. It is always a price of this product.

Product.active ● Boolean! non-null scalar

Whether the product is active. A product is archived with active: false; products are never deleted.

Product.metadata ● [KeyValueItem!] list object

Key/value metadata that the merchant set.

Product.createdAt ● AWSTimestamp! non-null scalar

Creation time. Measured in seconds since the Unix epoch.

Product.updatedAt ● AWSTimestamp scalar

Last update time. Measured in seconds since the Unix epoch.

Returned By

createProduct mutation ● product query ● updateProduct mutation

Member Of

ProductsConnection object