Skip to main content

SubscriptionAnchorCreateInput

The input fields for creating a subscription anchor.

input SubscriptionAnchorCreateInput {
  day: Day
  description: String
  externalId: String
  id: GlobalID
  month: Month
  name: String
  time: TimeOfDay
  type: SubscriptionAnchorType!
}

Fields​

SubscriptionAnchorCreateInput.day ● Day scalar types​

The anchor's delivery day. Use 1 to 7 from Monday for weekday anchors, 1 to 31 for monthday and yearday anchors, and nothing for flexible ones.

SubscriptionAnchorCreateInput.description ● String scalar types​

The anchor's description.

SubscriptionAnchorCreateInput.externalId ● String scalar types​

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

SubscriptionAnchorCreateInput.id ● GlobalID scalar types​

An ID for the new anchor. Leave empty to generate one.

SubscriptionAnchorCreateInput.month ● Month scalar types​

The anchor's delivery month, from 1 to 12. Required for yearday anchors and not allowed for others.

SubscriptionAnchorCreateInput.name ● String scalar types​

The anchor's name, unique within the subscription plan group. Leave empty to generate one from the plan's anchor name template.

SubscriptionAnchorCreateInput.time ● TimeOfDay scalar types​

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

SubscriptionAnchorCreateInput.type ● SubscriptionAnchorType! non-null enum types​

The anchor's type.

Member Of​

SubscriptionPlanCreateInput input