Skip to main content

Plan

Represents all the plans currently added to the groove account

Fetch all plans for the current account:

query PlansQuery {
  billing {
    plans {
      id
      createdAt
      expiresAt
      externalId
      quantity
      state
      updatedAt
      pricing {
        id
        annual
        externalAnnualPriceId
        externalMonthlyPriceId
        minimumQuantity
        monthly
        name
        pricingModel
        trialAvailable
        type
        usageFrom
        version
        addonPricingIds
        features {
          name
          value
        }
      }
    }
  }
}
type Plan {
  createdAt: DateTime!
  expiresAt: DateTime
  externalId: String!
  id: ID!
  pricing: Pricing!
  quantity: Int
  state: PlanState!
  updatedAt: DateTime
}

Fields​

Plan.createdAt ● DateTime! non-null scalar common​

The date and time when the plan was created.

Plan.expiresAt ● DateTime scalar common​

The date and time when the plan expires.

Plan.externalId ● String! non-null scalar common​

Unique identifier for this plan in 3rd party systems like stripe and shopify

Plan.id ● ID! non-null scalar common​

Plan.pricing ● Pricing! non-null object common​

The pricing connected to this plan

Plan.quantity ● Int scalar common​

The current billed quantity.

Plan.state ● PlanState! non-null enum common​

The state of this plan in the 3rd party system.

Plan.updatedAt ● DateTime scalar common​

The date and time when the plan was last updated.

Member of​

BillingType object