---
title: create or remove print subscription
slug: api-documentation/create-or-remove-print-subscription
docTags:
createdAt: 2026-08-27T17:02:13.658Z
---
{
"id": "mjVqiFYcEipRN8lmDmcIP",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription",
"servers": [
{
"url": "https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription"
}
],
"name": "create or remove print subscription",
"description": "This endpoint allows customers to create or remove print subscription.
\nAuthorized roles:
\n\n- customer.default
\n- customer.anonymous
\n
",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "listId",
"type": "string",
"description": "Unique identifier for the print subscription list.",
"format": "uuid"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "x-upstart-tenant",
"type": "string",
"description": "Tenant identifier associated with the site this call is for."
},
{
"kind": "optional",
"name": "x-upstart-site",
"type": "string",
"description": "Unique identifier for the site."
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "The request body should contain the details of print subscription.",
"customType": "CreateOrRemovePrintSubscriptionRequest",
"schema": [
{
"name": "intent",
"kind": "required",
"type": "string",
"description": "Intent of the action - create or remove print subscription.
",
"enum": [
"Create",
"Remove"
]
},
{
"name": "details",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PrintSubscriptionDetails",
"customType": "PrintSubscriptionDetails",
"schema": [
{
"name": "firstName",
"kind": "required",
"type": "string",
"description": "First name of the customer.",
"example": "John"
},
{
"name": "lastName",
"kind": "required",
"type": "string",
"description": "Last name of the customer.",
"example": "Doe"
},
{
"name": "businessName",
"kind": "optional",
"type": "string",
"description": "Business name of the customer.",
"example": "Company Corporation"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "E-mail address associated with the customer.
",
"example": "example@example.com",
"format": "email"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "Phone number associated with the customer.",
"example": "8668675309"
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PrintAddress",
"customType": "PrintAddress",
"schema": [
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "Address used for print catalog delivery.",
"example": "My Street 1"
},
{
"name": "addressLine2",
"kind": "optional",
"type": "string",
"description": "Additional address line used for print catalog delivery."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "City used for print catalog delivery.",
"example": "New York"
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "State used for print catalog delivery.",
"example": "New York"
},
{
"name": "zip",
"kind": "required",
"type": "string",
"description": "ZIP code used for print catalog delivery.",
"example": "10001"
}
]
}
]
}
],
"modelRef": "#/components/schemas/CreateOrRemovePrintSubscriptionRequest",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "AnonymousAuth",
"name": "AnonymousAuth",
"kind": "optional",
"type": "http",
"description": "This is the most basic authentication. The minimum requirement for access is a token representing the user as an anonymous client.",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "201",
"description": "Success - print subscription created or removed.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "PrintSubscription",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "The ID of the print subscription.",
"example": "ced8ef74-c968-47f6-98e0-d780d3da85fb"
},
{
"name": "details",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PrintSubscriptionDetails",
"customType": "PrintSubscriptionDetails",
"schema": [
{
"name": "firstName",
"kind": "required",
"type": "string",
"description": "First name of the customer.",
"example": "John"
},
{
"name": "lastName",
"kind": "required",
"type": "string",
"description": "Last name of the customer.",
"example": "Doe"
},
{
"name": "businessName",
"kind": "optional",
"type": "string",
"description": "Business name of the customer.",
"example": "Company Corporation"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "E-mail address associated with the customer.
",
"example": "example@example.com",
"format": "email"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "Phone number associated with the customer.",
"example": "8668675309"
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PrintAddress",
"customType": "PrintAddress",
"schema": [
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "Address used for print catalog delivery.",
"example": "My Street 1"
},
{
"name": "addressLine2",
"kind": "optional",
"type": "string",
"description": "Additional address line used for print catalog delivery."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "City used for print catalog delivery.",
"example": "New York"
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "State used for print catalog delivery.",
"example": "New York"
},
{
"name": "zip",
"kind": "required",
"type": "string",
"description": "ZIP code used for print catalog delivery.",
"example": "10001"
}
]
}
]
},
{
"name": "intent",
"kind": "required",
"type": "string",
"description": "Intent of the action - create or remove print subscription.
",
"example": "Create",
"enum": [
"Create",
"Remove"
]
},
{
"name": "dateModified",
"kind": "required",
"type": "string",
"description": "Date of the last modification of print subscription.",
"example": "2017-07-21T17:32:28Z",
"format": "date-time"
}
],
"modelRef": "#/components/schemas/PrintSubscription",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ValidationErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ValidationErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "The requested resource was not found in the NoChannel system.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "nlDFfd3cTY6VmZKq30-2n",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"intent\": \"\",\n \"details\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"addressLine1\": \"My Street 1\",\n \"city\": \"New York\",\n \"state\": \"New York\",\n \"zip\": \"10001\"\n }\n }\n }'"
},
{
"id": "ihSRYUPs1lnuu7Ku6MjMw",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"intent\": \"\",\n \"details\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"addressLine1\": \"My Street 1\",\n \"city\": \"New York\",\n \"state\": \"New York\",\n \"zip\": \"10001\"\n }\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "uR_ri1G_6oCd1hY1UUYiZ",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"intent\": \"\",\n \"details\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"addressLine1\": \"My Street 1\",\n \"city\": \"New York\",\n \"state\": \"New York\",\n \"zip\": \"10001\"\n }\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "L4iTV9OdEia_CdHPS85-8",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/customer/subscriptions/print/{listId}/subscription\"\n\npayload = json.dumps({\n \"intent\": \"\",\n \"details\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"addressLine1\": \"My Street 1\",\n \"city\": \"New York\",\n \"state\": \"New York\",\n \"zip\": \"10001\"\n }\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "nlDFfd3cTY6VmZKq30-2n"
},
"results": {
"languages": [
{
"id": "4cGWUAie1REykAwLyKILr",
"language": "201",
"code": "// Success - print subscription created or removed.\n{\n \"id\": \"ced8ef74-c968-47f6-98e0-d780d3da85fb\",\n \"details\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"businessName\": \"Company Corporation\",\n \"email\": \"example@example.com\",\n \"phone\": \"8668675309\",\n \"address\": {\n \"addressLine1\": \"My Street 1\",\n \"addressLine2\": \"\",\n \"city\": \"New York\",\n \"state\": \"New York\",\n \"zip\": \"10001\"\n }\n },\n \"intent\": \"Create\",\n \"dateModified\": \"2017-07-21T17:32:28Z\"\n}"
},
{
"id": "vFVgWIWkiN_ivrOvm2j7T",
"language": "400",
"code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}"
},
{
"id": "a2cHMG0_e7kNV5NxfUpyi",
"language": "401",
"code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
},
{
"id": "9vqtz9AkTqnS_VTx9nM25",
"language": "404",
"code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
}
],
"selectedLanguageId": "4cGWUAie1REykAwLyKILr"
}
},
"children": [
{
"text": ""
}
]
}