Skip to main content

platformProducts

The platform catalog: plan tiers and a la carte add-ons, told apart by productType, each with the entitlements one unit of it grants. Use it to build a plan picker or comparison table before a company has bought anything.

Business Rules​

  • Products are returned in name order, and each product's entitlements in card order.
  • price and availableForSelfSignup come from the product's billing mapping, so a product with no mapping reports a null price and cannot be self-purchased.
  • Entitlement counts are per unit. A line bought with quantity 2 grants twice these.

Error Scenarios​

  • Login required - No authenticated party on the request.

Permissions Required​

Any authenticated user, so a customer signing up can choose a plan and its add-ons before they belong to a company. The catalog exposes no company or payment detail.

platformProducts(
  productType: PlatformProductTypeEnum
): [PlatformProduct!]!

Arguments​

platformProducts.productType ● PlatformProductTypeEnum enum entitlements​

Return only products of this type. Omit for the whole catalog.

Type​

PlatformProduct object entitlements​

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.