Skip to main content

SubscriptionPlan

A plan within a subscription plan group, such as monthly delivery. It sets how often its subscriptions generate orders.

type SubscriptionPlan {
  anchors: [SubscriptionAnchor!]!
  billingBehaviour: SubscriptionBillingBehaviour!
  createdAt: Timestamp!
  deliveryBehaviour: SubscriptionDeliveryBehaviour!
  deliveryBehaviourType: SubscriptionDeliveryBehaviourType!
  frequency: SubscriptionFrequency!
  id: GlobalID!
  inventoryBehaviour: SubscriptionInventoryBehaviour!
  name: String!
  pricingBehaviour: SubscriptionPricingBehaviour!
  status: SubscriptionPlanStatus!
  subscriptionPlanGroup: SubscriptionPlanGroup!
  subscriptionsCount: Count!
  updatedAt: Timestamp!
}

Fields​

SubscriptionPlan.anchors ● [SubscriptionAnchor!]! non-null object types​

The plan's delivery anchors.

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

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

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

The date and time when the subscription plan was created.

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

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

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

Whether the plan uses fixed or flexible delivery dates.

SubscriptionPlan.frequency ● SubscriptionFrequency! non-null object types​

How often the plan's subscriptions generate orders.

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

The subscription plan's ID.

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

How the plan's orders handle inventory.

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

The subscription plan's name.

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

How the plan's orders are priced.

SubscriptionPlan.status ● SubscriptionPlanStatus! non-null enum types​

The subscription plan's status.

SubscriptionPlan.subscriptionPlanGroup ● SubscriptionPlanGroup! non-null object types​

The subscription plan group the plan belongs to.

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

The number of subscriptions on the plan.

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

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

Returned By​

subscriptionPlan query

Member Of​

Subscription object ● SubscriptionPlanConnection object ● SubscriptionPlanEdge object ● SubscriptionPlanGroup object