Plan Object

Description

Represents a subscription plan with pricing, features, and trial information.

Declaration

type Plan {
    _id: ID!
    id: String
    expires: Date
    active: Boolean!
    features: PlanFeatures!
    trial: PlanTrial!
    title: String!
    currency: String!
    recurrence: String!
    description: String!
    price: PlanPrice!
    nextPaymentDate: Date
    prices: [PlanPrice!]!
    yearlyDiscount: Float
    seats: Int!
}

Fields

Name	Type	Description
_id	ID!	Internal database identifier.
id ⚠️	String	Plan identifier. This field is deprecated. ⚠️ Deprecated: No longer supported
expires	Date	Date when the plan expires (if applicable).
active	Boolean!	Whether the plan is currently active.
features	PlanFeatures!	Feature set configuration for the plan.
trial	PlanTrial!	Trial period information.
title	String!	Plan title (e.g., "Essentials", "Standard", "Extended").
currency	String!	Currency code for the plan (e.g., "EUR", "USD").
recurrence	String!	Billing recurrence ("monthly" or "yearly").
description	String!	Plan description.
price	PlanPrice!	Primary price for the plan.
nextPaymentDate	Date	Date of the next payment (for active subscriptions).
prices	[PlanPrice!]!	List of prices in different currencies.
yearlyDiscount ⚠️	Float	Yearly discount percentage. This field is deprecated. ⚠️ Deprecated: No longer supported
seats	Int!	Number of user seats included in the plan.