Skip to main content

PlatformProduct

A sellable thing Endless offers: a plan tier, or an a la carte add-on bought alongside one. Platform products are engineer-managed reference data that own the entitlements a customer gets, independent of any billing provider.

type PlatformProduct {
  availableForSelfSignup: Boolean!
  createdAt: ISO8601DateTime!
  description: String
  entitlements: [ProductEntitlement!]!
  id: ID!
  name: String!
  prettyName: String!
  price: MonetaryValue
  productType: PlatformProductTypeEnum!
  updatedAt: ISO8601DateTime!
}

Fields

`PlatformProduct.availableForSelfSignup` ● `Boolean!` non-null scalar common

Whether a customer can buy this product themselves during signup. False for quote-only products and products not yet linked to a provider product.

`PlatformProduct.createdAt` ● `ISO8601DateTime!` non-null scalar common

When the product was created.

`PlatformProduct.description` ● `String` scalar common

A short description of the product.

`PlatformProduct.entitlements` ● `[ProductEntitlement!]!` non-null object entitlements

What one unit of this product grants, in the order a plan lists them.

`PlatformProduct.id` ● `ID!` non-null scalar common

Unique identifier for the product.

`PlatformProduct.name` ● `String!` non-null scalar common

Stable internal identifier for the product (e.g. "grow", "edi").

`PlatformProduct.prettyName` ● `String!` non-null scalar common

Human-facing display name for the product (e.g. "Grow").

`PlatformProduct.price` ● `MonetaryValue` object common

The recurring monthly price per unit, from the product's billing mapping. Null for quote-only products such as the enterprise plan.

`PlatformProduct.productType` ● `PlatformProductTypeEnum!` non-null enum entitlements

Whether this is a plan tier or an a la carte add-on.

`PlatformProduct.updatedAt` ● `ISO8601DateTime!` non-null scalar common

When the product was last updated.

Returned By

platformProducts query

Fields
Returned By