Anchor to section titled 'undefined'subscription
subscription
mutation
2024-07
Requires write access scope. Also: The user must have manage_orders_information permission.
Creates a Subscription Contract Draft. You can submit all the desired information for the draft using Subscription Draft Input object. You can also update the draft using the Subscription Contract Update mutation. The draft is not saved until you call the Subscription Draft Commit mutation.
Anchor to section titled 'Arguments'
Arguments
The properties of the new Subscription Contract.
Was this section helpful?
Anchor to section titled 'SubscriptionContractCreatePayload returns'
SubscriptionContractCreatePayload returns
The Subscription Contract object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: subscriptionContractCreate
Query Reference for MUTATION: subscriptionContractCreate
"mutation subscriptionContractCreate($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n # SubscriptionDraft fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: subscriptionContractCreate
"{\n \"input\": {\n \"contract\": {\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 \"countryCode\": \"AC\",\n \"firstName\": \"<your-firstName>\",\n \"lastName\": \"<your-lastName>\",\n \"phone\": \"<your-phone>\",\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 \"countryCode\": \"AC\",\n \"firstName\": \"<your-firstName>\",\n \"lastName\": \"<your-lastName>\",\n \"phone\": \"<your-phone>\",\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 \"currencyCode\": \"AED\",\n \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n \"nextBillingDate\": \"2019-09-07T15:50:00Z\"\n }\n}"Schema Reference for MUTATION: subscriptionContractCreate
"input SubscriptionContractCreateInput {\n contract: SubscriptionDraftInput!\n currencyCode: CurrencyCode!\n customerId: ID!\n nextBillingDate: DateTime!\n}\n\ninput 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"Display Examples for MUTATION: subscriptionContractCreate
[
{
"example": {
"type_name": "subscriptioncontractcreate",
"title": "Create a subscription contract with draft input",
"query_string": "mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input"
},
"variables": {
"input": {
"customerId": "gid://shopify/Customer/544365967",
"currencyCode": "USD",
"nextBillingDate": "2024-10-11T21:11:01-04:00",
"contract": {
"status": "ACTIVE",
"note": "Note of a thing.",
"customAttributes": [
{
"key": "Test",
"value": "Test value"
}
],
"paymentMethodId": "gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff",
"billingPolicy": {
"minCycles": 3,
"maxCycles": 12,
"intervalCount": 1,
"interval": "MONTH",
"anchors": [
{
"type": "MONTHDAY",
"day": 12
}
]
},
"deliveryPolicy": {
"intervalCount": 1,
"interval": "MONTH",
"anchors": [
{
"type": "MONTHDAY",
"day": 13
}
]
},
"deliveryPrice": 2.99,
"deliveryMethod": {
"shipping": {
"address": {
"firstName": "Mont",
"lastName": "Réal",
"address1": "490 Rue De La Gauchetière O",
"country": "Canada",
"province": "Québec",
"phone": "+16135551212",
"zip": "H2Z 0B3",
"city": "Montréal"
},
"shippingOption": {
"title": "Subscription shipping",
"presentmentTitle": "Translated shipping for subscription",
"description": "5-7 Days",
"code": "GROUND",
"carrierServiceId": null
}
}
}
}
}
},
"response": {
"data": {
"subscriptionContractCreate": {
"draft": {
"id": "gid://shopify/SubscriptionDraft/1055577422"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/sales/subscriptions/test/unit/graph_api/admin/mutations/subscription_contract_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) { subscriptionContractCreate(input: $input) { draft { id } userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"customerId\": \"gid://shopify/Customer/544365967\",\n \"currencyCode\": \"USD\",\n \"nextBillingDate\": \"2024-10-11T21:11:01-04:00\",\n \"contract\": {\n \"status\": \"ACTIVE\",\n \"note\": \"Note of a thing.\",\n \"customAttributes\": [\n {\n \"key\": \"Test\",\n \"value\": \"Test value\"\n }\n ],\n \"paymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n \"billingPolicy\": {\n \"minCycles\": 3,\n \"maxCycles\": 12,\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 12\n }\n ]\n },\n \"deliveryPolicy\": {\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 13\n }\n ]\n },\n \"deliveryPrice\": 2.99,\n \"deliveryMethod\": {\n \"shipping\": {\n \"address\": {\n \"firstName\": \"Mont\",\n \"lastName\": \"Réal\",\n \"address1\": \"490 Rue De La Gauchetière O\",\n \"country\": \"Canada\",\n \"province\": \"Québec\",\n \"phone\": \"+16135551212\",\n \"zip\": \"H2Z 0B3\",\n \"city\": \"Montréal\"\n },\n \"shippingOption\": {\n \"title\": \"Subscription shipping\",\n \"presentmentTitle\": \"Translated shipping for subscription\",\n \"description\": \"5-7 Days\",\n \"code\": \"GROUND\",\n \"carrierServiceId\": null\n }\n }\n }\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"customerId\": \"gid://shopify/Customer/544365967\",\n \"currencyCode\": \"USD\",\n \"nextBillingDate\": \"2024-10-11T21:11:01-04:00\",\n \"contract\": {\n \"status\": \"ACTIVE\",\n \"note\": \"Note of a thing.\",\n \"customAttributes\": [\n {\n \"key\": \"Test\",\n \"value\": \"Test value\"\n }\n ],\n \"paymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n \"billingPolicy\": {\n \"minCycles\": 3,\n \"maxCycles\": 12,\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 12\n }\n ]\n },\n \"deliveryPolicy\": {\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 13\n }\n ]\n },\n \"deliveryPrice\": 2.99,\n \"deliveryMethod\": {\n \"shipping\": {\n \"address\": {\n \"firstName\": \"Mont\",\n \"lastName\": \"Réal\",\n \"address1\": \"490 Rue De La Gauchetière O\",\n \"country\": \"Canada\",\n \"province\": \"Québec\",\n \"phone\": \"+16135551212\",\n \"zip\": \"H2Z 0B3\",\n \"city\": \"Montréal\"\n },\n \"shippingOption\": {\n \"title\": \"Subscription shipping\",\n \"presentmentTitle\": \"Translated shipping for subscription\",\n \"description\": \"5-7 Days\",\n \"code\": \"GROUND\",\n \"carrierServiceId\": null\n }\n }\n }\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"customerId\": \"gid://shopify/Customer/544365967\",\n \"currencyCode\": \"USD\",\n \"nextBillingDate\": \"2024-10-11T21:11:01-04:00\",\n \"contract\": {\n \"status\": \"ACTIVE\",\n \"note\": \"Note of a thing.\",\n \"customAttributes\": [{\"key\"=>\"Test\", \"value\"=>\"Test value\"}],\n \"paymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n \"billingPolicy\": {\n \"minCycles\": 3,\n \"maxCycles\": 12,\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [{\"type\"=>\"MONTHDAY\", \"day\"=>12}]\n },\n \"deliveryPolicy\": {\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [{\"type\"=>\"MONTHDAY\", \"day\"=>13}]\n },\n \"deliveryPrice\": 2.99,\n \"deliveryMethod\": {\n \"shipping\": {\n \"address\": {\n \"firstName\": \"Mont\",\n \"lastName\": \"Réal\",\n \"address1\": \"490 Rue De La Gauchetière O\",\n \"country\": \"Canada\",\n \"province\": \"Québec\",\n \"phone\": \"+16135551212\",\n \"zip\": \"H2Z 0B3\",\n \"city\": \"Montréal\"\n },\n \"shippingOption\": {\n \"title\": \"Subscription shipping\",\n \"presentmentTitle\": \"Translated shipping for subscription\",\n \"description\": \"5-7 Days\",\n \"code\": \"GROUND\",\n \"carrierServiceId\": null\n }\n }\n }\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"customerId\": \"gid://shopify/Customer/544365967\",\n \"currencyCode\": \"USD\",\n \"nextBillingDate\": \"2024-10-11T21:11:01-04:00\",\n \"contract\": {\n \"status\": \"ACTIVE\",\n \"note\": \"Note of a thing.\",\n \"customAttributes\": [\n {\n \"key\": \"Test\",\n \"value\": \"Test value\"\n }\n ],\n \"paymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n \"billingPolicy\": {\n \"minCycles\": 3,\n \"maxCycles\": 12,\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 12\n }\n ]\n },\n \"deliveryPolicy\": {\n \"intervalCount\": 1,\n \"interval\": \"MONTH\",\n \"anchors\": [\n {\n \"type\": \"MONTHDAY\",\n \"day\": 13\n }\n ]\n },\n \"deliveryPrice\": 2.99,\n \"deliveryMethod\": {\n \"shipping\": {\n \"address\": {\n \"firstName\": \"Mont\",\n \"lastName\": \"Réal\",\n \"address1\": \"490 Rue De La Gauchetière O\",\n \"country\": \"Canada\",\n \"province\": \"Québec\",\n \"phone\": \"+16135551212\",\n \"zip\": \"H2Z 0B3\",\n \"city\": \"Montréal\"\n },\n \"shippingOption\": {\n \"title\": \"Subscription shipping\",\n \"presentmentTitle\": \"Translated shipping for subscription\",\n \"description\": \"5-7 Days\",\n \"code\": \"GROUND\",\n \"carrierServiceId\": null\n }\n }\n }\n }\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createSubscriptionContract($input: SubscriptionContractCreateInput!) {\n subscriptionContractCreate(input: $input) {\n draft {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"customerId\" => \"gid://shopify/Customer/544365967\",\n \"currencyCode\" => \"USD\",\n \"nextBillingDate\" => \"2024-10-11T21:11:01-04:00\",\n \"contract\" => [\n \"status\" => \"ACTIVE\",\n \"note\" => \"Note of a thing.\",\n \"customAttributes\" => [{\"key\"=>\"Test\", \"value\"=>\"Test value\"}],\n \"paymentMethodId\" => \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n \"billingPolicy\" => [\n \"minCycles\" => 3,\n \"maxCycles\" => 12,\n \"intervalCount\" => 1,\n \"interval\" => \"MONTH\",\n \"anchors\" => [{\"type\"=>\"MONTHDAY\", \"day\"=>12}],\n ],\n \"deliveryPolicy\" => [\n \"intervalCount\" => 1,\n \"interval\" => \"MONTH\",\n \"anchors\" => [{\"type\"=>\"MONTHDAY\", \"day\"=>13}],\n ],\n \"deliveryPrice\" => 2.99,\n \"deliveryMethod\" => [\n \"shipping\" => [\n \"address\" => [\n \"firstName\" => \"Mont\",\n \"lastName\" => \"Réal\",\n \"address1\" => \"490 Rue De La Gauchetière O\",\n \"country\" => \"Canada\",\n \"province\" => \"Québec\",\n \"phone\" => \"+16135551212\",\n \"zip\" => \"H2Z 0B3\",\n \"city\" => \"Montréal\",\n ],\n \"shippingOption\" => [\n \"title\" => \"Subscription shipping\",\n \"presentmentTitle\" => \"Translated shipping for subscription\",\n \"description\" => \"5-7 Days\",\n \"code\" => \"GROUND\",\n \"carrierServiceId\" => null,\n ],\n ],\n ],\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties of the new Subscription Contract.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SubscriptionContractCreateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "SubscriptionContractCreateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"customerId\":\"gid://shopify/Customer/544365967\",\"currencyCode\":\"USD\",\"nextBillingDate\":\"2024-10-11T21:11:01-04:00\",\"contract\":{\"status\":\"ACTIVE\",\"note\":\"Note of a thing.\",\"customAttributes\":[{\"key\":\"Test\",\"value\":\"Test value\"}],\"paymentMethodId\":\"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\"billingPolicy\":{\"minCycles\":3,\"maxCycles\":12,\"intervalCount\":1,\"interval\":\"MONTH\",\"anchors\":[{\"type\":\"MONTHDAY\",\"day\":12}]},\"deliveryPolicy\":{\"intervalCount\":1,\"interval\":\"MONTH\",\"anchors\":[{\"type\":\"MONTHDAY\",\"day\":13}]},\"deliveryPrice\":2.99,\"deliveryMethod\":{\"shipping\":{\"address\":{\"firstName\":\"Mont\",\"lastName\":\"Réal\",\"address1\":\"490 Rue De La Gauchetière O\",\"country\":\"Canada\",\"province\":\"Québec\",\"phone\":\"+16135551212\",\"zip\":\"H2Z 0B3\",\"city\":\"Montréal\"},\"shippingOption\":{\"title\":\"Subscription shipping\",\"presentmentTitle\":\"Translated shipping for subscription\",\"description\":\"5-7 Days\",\"code\":\"GROUND\",\"carrierServiceId\":null}}}}}",
"typeKind": "MUTATION"
}
]
}
]