Anchor to section titled 'undefined'subscription
subscription
mutation
2024-07
Requires write access scope. Also: The user must have manage_orders_information permission.
Updates a Subscription Draft.
Anchor to section titled 'Arguments'
Arguments
The gid of the Subscription Draft to update.
The properties of the new Subscription Contract.
Was this section helpful?
Anchor to section titled 'SubscriptionDraftUpdatePayload returns'
SubscriptionDraftUpdatePayload returns
The Subscription Draft object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: subscriptionDraftUpdate
Query Reference for MUTATION: subscriptionDraftUpdate
"mutation subscriptionDraftUpdate($draftId: ID!, $input: SubscriptionDraftInput!) {\n subscriptionDraftUpdate(draftId: $draftId, input: $input) {\n draft {\n # SubscriptionDraft fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: subscriptionDraftUpdate
"{\n \"draftId\": \"gid://shopify/<objectName>/10079785100\",\n \"input\": {\n \"billingPolicy\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"interval\": \"DAY\",\n \"intervalCount\": 1,\n \"maxCycles\": 1,\n \"minCycles\": 1\n },\n \"customAttributes\": [\n {\n \"key\": \"<your-key>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"deliveryMethod\": {\n \"localDelivery\": {\n \"address\": {\n \"address1\": \"<your-address1>\",\n \"address2\": \"<your-address2>\",\n \"city\": \"<your-city>\",\n \"company\": \"<your-company>\",\n \"country\": \"<your-country>\",\n \"countryCode\": \"AC\",\n \"firstName\": \"<your-firstName>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"lastName\": \"<your-lastName>\",\n \"phone\": \"<your-phone>\",\n \"province\": \"<your-province>\",\n \"provinceCode\": \"<your-provinceCode>\",\n \"zip\": \"<your-zip>\"\n },\n \"localDeliveryOption\": {\n \"code\": \"<your-code>\",\n \"description\": \"<your-description>\",\n \"instructions\": \"<your-instructions>\",\n \"phone\": \"<your-phone>\",\n \"presentmentTitle\": \"<your-presentmentTitle>\",\n \"title\": \"<your-title>\"\n }\n },\n \"pickup\": {\n \"pickupOption\": {\n \"code\": \"<your-code>\",\n \"description\": \"<your-description>\",\n \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n \"presentmentTitle\": \"<your-presentmentTitle>\",\n \"title\": \"<your-title>\"\n }\n },\n \"shipping\": {\n \"address\": {\n \"address1\": \"<your-address1>\",\n \"address2\": \"<your-address2>\",\n \"city\": \"<your-city>\",\n \"company\": \"<your-company>\",\n \"country\": \"<your-country>\",\n \"countryCode\": \"AC\",\n \"firstName\": \"<your-firstName>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"lastName\": \"<your-lastName>\",\n \"phone\": \"<your-phone>\",\n \"province\": \"<your-province>\",\n \"provinceCode\": \"<your-provinceCode>\",\n \"zip\": \"<your-zip>\"\n },\n \"shippingOption\": {\n \"carrierServiceId\": \"gid://shopify/<objectName>/10079785100\",\n \"code\": \"<your-code>\",\n \"description\": \"<your-description>\",\n \"presentmentTitle\": \"<your-presentmentTitle>\",\n \"title\": \"<your-title>\"\n }\n }\n },\n \"deliveryPolicy\": {\n \"anchors\": [\n {\n \"cutoffDay\": 1,\n \"day\": 1,\n \"month\": 1,\n \"type\": \"MONTHDAY\"\n }\n ],\n \"interval\": \"DAY\",\n \"intervalCount\": 1\n },\n \"deliveryPrice\": \"29.99\",\n \"nextBillingDate\": \"2019-09-07T15:50:00Z\",\n \"note\": \"<your-note>\",\n \"paymentMethodId\": \"gid://shopify/<objectName>/10079785100\",\n \"status\": \"ACTIVE\"\n }\n}"Schema Reference for MUTATION: subscriptionDraftUpdate
"input SubscriptionDraftInput {\n billingPolicy: SubscriptionBillingPolicyInput\n customAttributes: [AttributeInput!]\n deliveryMethod: SubscriptionDeliveryMethodInput\n deliveryPolicy: SubscriptionDeliveryPolicyInput\n deliveryPrice: Decimal\n nextBillingDate: DateTime\n note: String\n paymentMethodId: ID\n status: SubscriptionContractSubscriptionStatus\n}\n\ninput SubscriptionBillingPolicyInput {\n anchors: [SellingPlanAnchorInput!]\n interval: SellingPlanInterval!\n intervalCount: Int!\n maxCycles: Int\n minCycles: Int\n}\n\ninput AttributeInput {\n key: String!\n value: String!\n}\n\ninput SubscriptionDeliveryMethodInput {\n localDelivery: SubscriptionDeliveryMethodLocalDeliveryInput\n pickup: SubscriptionDeliveryMethodPickupInput\n shipping: SubscriptionDeliveryMethodShippingInput\n}\n\ninput SubscriptionDeliveryPolicyInput {\n anchors: [SellingPlanAnchorInput!]\n interval: SellingPlanInterval!\n intervalCount: Int!\n}\n"Display Examples for MUTATION: subscriptionDraftUpdate
[]