Skip to main content

SubscriptionAnchor

A delivery anchor for a subscription plan. It sets the day and time that the plan's deliveries fall on.

type SubscriptionAnchor {
  day: Day
  description: String!
  externalId: String
  id: GlobalID!
  month: Month
  name: String!
  position: Count!
  schedule(first: NonZeroCount!, strict: Boolean): [DeliverySlot!]!
  time: TimeOfDay
  type: SubscriptionAnchorType!
}

Fields

`SubscriptionAnchor.day` ● `Day` scalar types

The anchor's delivery day. Weekday anchors use 1 to 7 from Monday, and monthday and yearday anchors use a day of the month.

`SubscriptionAnchor.description` ● `String!` non-null scalar types

A short description of when the anchor delivers, such as On the 1st.

`SubscriptionAnchor.externalId` ● `String` scalar types

The anchor's ID in the channel, such as a Shopify selling plan ID.

`SubscriptionAnchor.id` ● `GlobalID!` non-null scalar types

The subscription anchor's ID.

`SubscriptionAnchor.month` ● `Month` scalar types

The anchor's delivery month, from 1 to 12. Only set for yearday anchors.

`SubscriptionAnchor.name` ● `String!` non-null scalar types

The anchor's name. It's unique within its subscription plan group.

`SubscriptionAnchor.position` ● `Count!` non-null scalar types

The anchor's position in its subscription plan group, starting at 1.

`SubscriptionAnchor.schedule` ● `[DeliverySlot!]!` non-null object types

The anchor's upcoming delivery slots, starting from the next eligible delivery date.

`SubscriptionAnchor.schedule.first` ● `NonZeroCount!` non-null scalar types

The number of delivery slots to return.

`SubscriptionAnchor.schedule.strict` ● `Boolean` scalar types

Whether slots follow the plan's full frequency. When false or omitted, weekly and monthly plans list a slot for every week or month.

`SubscriptionAnchor.time` ● `TimeOfDay` scalar types

The time of day the anchor delivers at, in the subscription plan group's timezone.

`SubscriptionAnchor.type` ● `SubscriptionAnchorType!` non-null enum types

The anchor's type.

Member Of

Subscription object ● SubscriptionPlan object

Fields
Member Of