Skip to main content

SubscriptionPlanGroup

A group of subscription plans offered for the same products. It sets the billing, delivery, inventory and pricing behaviour its plans share.

type SubscriptionPlanGroup {
  billingBehaviour: SubscriptionBillingBehaviour!
  channel: Channel!
  createdAt: Timestamp!
  deliveryBehaviour: SubscriptionDeliveryBehaviour!
  deliveryBehaviourType: SubscriptionDeliveryBehaviourType!
  externalId: String
  id: GlobalID!
  identifier: String!
  inventoryBehaviour: SubscriptionInventoryBehaviour!
  name: String!
  pricingBehaviour: SubscriptionPricingBehaviour!
  productGroup: SubscriptionProductGroup!
  reference: String!
  status: SubscriptionPlanGroupStatus!
  subscriptionPlans: [SubscriptionPlan!]!
  subscriptionPlansCount: Count!
  subscriptionsCount: Count!
  timezone: String!
  updatedAt: Timestamp!
}

Fields​

SubscriptionPlanGroup.billingBehaviour ● SubscriptionBillingBehaviour! non-null object types​

How far before delivery the group's orders are billed.

SubscriptionPlanGroup.channel ● Channel! non-null object types​

The sales channel the subscription plan group belongs to.

SubscriptionPlanGroup.createdAt ● Timestamp! non-null scalar types​

The date and time when the subscription plan group was created.

SubscriptionPlanGroup.deliveryBehaviour ● SubscriptionDeliveryBehaviour! non-null object types​

How delivery dates are chosen for the group's subscriptions.

SubscriptionPlanGroup.deliveryBehaviourType ● SubscriptionDeliveryBehaviourType! non-null enum types​

Whether the group's plans use fixed or flexible delivery dates.

SubscriptionPlanGroup.externalId ● String scalar types​

The subscription plan group's ID in the sales channel, such as a Shopify selling plan group ID.

SubscriptionPlanGroup.id ● GlobalID! non-null scalar types​

The subscription plan group's ID.

SubscriptionPlanGroup.identifier ● String! non-null scalar types​

The subscription plan group's readable identifier, such as #1001.

SubscriptionPlanGroup.inventoryBehaviour ● SubscriptionInventoryBehaviour! non-null object types​

How the group's orders handle inventory.

SubscriptionPlanGroup.name ● String! non-null scalar types​

The subscription plan group's name.

SubscriptionPlanGroup.pricingBehaviour ● SubscriptionPricingBehaviour! non-null object types​

How the group's orders are priced.

SubscriptionPlanGroup.productGroup ● SubscriptionProductGroup! non-null object types​

The products and variants the group's plans are offered for.

SubscriptionPlanGroup.reference ● String! non-null scalar types​

The merchant's reference for the subscription plan group.

SubscriptionPlanGroup.status ● SubscriptionPlanGroupStatus! non-null enum types​

The subscription plan group's status.

SubscriptionPlanGroup.subscriptionPlans ● [SubscriptionPlan!]! non-null object types​

The subscription plans in the group, excluding deleted plans.

SubscriptionPlanGroup.subscriptionPlansCount ● Count! non-null scalar types​

The number of subscription plans in the group.

SubscriptionPlanGroup.subscriptionsCount ● Count! non-null scalar types​

The number of subscriptions in the group.

SubscriptionPlanGroup.timezone ● String! non-null scalar types​

The time zone used to calculate delivery and billing dates for the group's subscriptions.

SubscriptionPlanGroup.updatedAt ● Timestamp! non-null scalar types​

The date and time when the subscription plan group was last updated.

Returned By​

subscriptionPlanGroup query

Member Of​

SubscriptionPlan object ● SubscriptionPlanGroupConnection object ● SubscriptionPlanGroupCreatePayload object ● SubscriptionPlanGroupEdge object ● SubscriptionPlanGroupUpdatePayload object