{
"info": {
"_postman_id": "99284d03-c86e-48b1-a7de-602fae8218cb",
"name": "API Reference subpackage_advertisement_opportunities subpackage_subscriptions API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"createdAt": "2026-07-28T01:13:11.000Z",
"updatedAt": "2026-07-28T01:13:11.000Z",
"lastUpdatedBy": "35240",
"uid": "35240-99284d03-c86e-48b1-a7de-602fae8218cb"
},
"item": [
{
"name": "publications",
"item": [
{
"name": "{publicationId}",
"item": [
{
"name": "subscriptions",
"item": [
{
"name": "by_email",
"item": [
{
"name": "{email}",
"item": [
{
"name": "Get subscription by email OAuth Scope: subscriptions:read",
"id": "351eddbf-242e-4afe-85e1-35cae90eefcf",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"id": "7187b815-1f94-43f9-ae90-005e502b0b1c",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
},
{
"id": "0e1520fa-701b-470e-9f8b-afd4cf745ba8",
"key": "email",
"value": "",
"description": "(Required) The ID of the subscriber object"
}
]
},
"description": "Please note that this endpoint requires the email to be URL encoded. Please reference your language's documentation for the correct method of encoding. Retrieve a single subscription belonging to a specific email address in a specific publication."
},
"response": [
{
"id": "c792c1ea-eaba-4419-9ffd-7af68488fd63",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"invalid\",\n \"created\": \"\",\n \"subscription_tier\": \"premium\",\n \"subscription_premium_tier_names\": [\n \"\",\n \"\"\n ],\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_channel\": \"recommendation\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"referring_site\": \"\",\n \"referral_code\": \"\",\n \"subscription_premium_tiers\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"archived\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"kind\": \"datetime\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"string\",\n \"value\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"stats\": {\n \"emails_received\": \"\",\n \"open_rate\": \"\",\n \"click_through_rate\": \"\"\n },\n \"newsletter_list_ids\": [\n \"\",\n \"\"\n ]\n }\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-c792c1ea-eaba-4419-9ffd-7af68488fd63"
},
{
"id": "b1e6cdaa-ed0b-4968-9a2b-9b34e0258ce5",
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-b1e6cdaa-ed0b-4968-9a2b-9b34e0258ce5"
},
{
"id": "c7cfad25-abce-4fc5-8ea0-6927fd5679ea",
"name": "Resource Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-c7cfad25-abce-4fc5-8ea0-6927fd5679ea"
},
{
"id": "4b2369d3-1fba-4a21-91f5-5a6f346af0d7",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-4b2369d3-1fba-4a21-91f5-5a6f346af0d7"
},
{
"id": "e52209c2-d685-4f89-8b2c-69e341aab6f7",
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-e52209c2-d685-4f89-8b2c-69e341aab6f7"
}
],
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-351eddbf-242e-4afe-85e1-35cae90eefcf"
},
{
"name": "Update subscription by email OAuth Scope: subscriptions:write",
"id": "83de2e9b-fc3b-4fc9-8fff-937c5c37661e",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"id": "86556486-2d21-41dc-a3fb-8c116ab6e782",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
},
{
"id": "2ac01e82-430b-4156-b8a6-b2566a2b205d",
"key": "email",
"value": "",
"description": "(Required) The email of the subscription object"
}
]
},
"description": "Update a single subscription by email."
},
"response": [
{
"id": "e09d354a-7fe7-4de0-9a72-c67cda35ad34",
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"invalid\",\n \"created\": \"\",\n \"subscription_tier\": \"premium\",\n \"subscription_premium_tier_names\": [\n \"\",\n \"\"\n ],\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_channel\": \"recommendation\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"referring_site\": \"\",\n \"referral_code\": \"\",\n \"subscription_premium_tiers\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"archived\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"kind\": \"datetime\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"string\",\n \"value\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"stats\": {\n \"emails_received\": \"\",\n \"open_rate\": \"\",\n \"click_through_rate\": \"\"\n },\n \"newsletter_list_ids\": [\n \"\",\n \"\"\n ]\n }\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-e09d354a-7fe7-4de0-9a72-c67cda35ad34"
},
{
"id": "b628e473-1341-47d5-b2a0-0f3f880f2c6b",
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-b628e473-1341-47d5-b2a0-0f3f880f2c6b"
},
{
"id": "74af0bce-e089-4577-9c79-91710a1cec2c",
"name": "Resource Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-74af0bce-e089-4577-9c79-91710a1cec2c"
},
{
"id": "69ab314c-d3d2-447e-acb7-355618568eba",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-69ab314c-d3d2-447e-acb7-355618568eba"
},
{
"id": "c946e9de-3db1-4234-8bfd-36117cb2509e",
"name": "Internal Server Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"\",\n \"tier\": \"free\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/by_email/:email",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
"by_email",
":email"
],
"variable": [
{
"key": "publicationId"
},
{
"key": "email"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-c946e9de-3db1-4234-8bfd-36117cb2509e"
}
],
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-83de2e9b-fc3b-4fc9-8fff-937c5c37661e"
}
],
"id": "e928e14f-838e-4b51-97c4-1dd59c47c5c9",
"createdAt": "2026-07-28T01:13:11.000Z",
"updatedAt": "2026-07-28T01:13:11.000Z",
"uid": "35240-e928e14f-838e-4b51-97c4-1dd59c47c5c9"
}
],
"id": "72e871c5-6747-42f0-ab41-6e0405d0aafd",
"createdAt": "2026-07-28T01:13:11.000Z",
"updatedAt": "2026-07-28T01:13:11.000Z",
"uid": "35240-72e871c5-6747-42f0-ab41-6e0405d0aafd"
},
{
"name": "{subscriptionId}",
"item": [
{
"name": "Get subscription by ID OAuth Scope: subscriptions:read",
"id": "2c1944d2-11be-42e5-b69d-196d4aa2273e",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"id": "d429790c-4435-4397-a79b-858d8cdd13c5",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
},
{
"id": "e0c4a827-590a-41c9-9bd1-26f1093ceda3",
"key": "subscriptionId",
"value": "",
"description": "(Required) The prefixed ID of the subscription object"
}
]
},
"description": "In previous versions of the API, another endpoint existed to retrieve a subscription by the subscriber ID. This endpoint is now deprecated and will be removed in a future version of the API. Please use this endpoint instead. The subscription ID can be found by exporting a list of subscriptions either via the `Settings > Publications > Export Data` or by exporting a CSV in a segment. Retrieve a single subscription belonging to a specific publication."
},
"response": [
{
"id": "80047668-7af1-4e50-9b1c-480f9c1b9019",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"invalid\",\n \"created\": \"\",\n \"subscription_tier\": \"premium\",\n \"subscription_premium_tier_names\": [\n \"\",\n \"\"\n ],\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_channel\": \"recommendation\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"referring_site\": \"\",\n \"referral_code\": \"\",\n \"subscription_premium_tiers\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"archived\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n ],\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"kind\": \"datetime\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"string\",\n \"value\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"stats\": {\n \"emails_received\": \"\",\n \"open_rate\": \"\",\n \"click_through_rate\": \"\"\n },\n \"newsletter_list_ids\": [\n \"\",\n \"\"\n ]\n }\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-80047668-7af1-4e50-9b1c-480f9c1b9019"
},
{
"id": "a8b8f190-1e7a-4064-805d-208864c1c9fc",
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-a8b8f190-1e7a-4064-805d-208864c1c9fc"
},
{
"id": "f3308685-033f-4df1-b0e1-27deb747a5f7",
"name": "Resource Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-f3308685-033f-4df1-b0e1-27deb747a5f7"
},
{
"id": "3906bce2-367a-4ef6-b376-74988f801d1f",
"name": "Rate Limit Exceeded",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-3906bce2-367a-4ef6-b376-74988f801d1f"
},
{
"id": "12c70bba-9f6d-47aa-b83d-ace82b38794f",
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId?expand[]=referrals",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"query": [
{
"description": "Optional list of expandable objects.
`subscription_premium_tiers` - Returns an array of tiers the subscription is associated with.
`referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription.
`stats` - Returns statistics about the subscription(s).
`custom_fields` - Returns an array of custom field values that have been set on the subscription.
`tags` - Returns an array of tags that have been set on the subscription.
`newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.",
"key": "expand[]",
"value": "referrals"
}
],
"variable": [
{
"key": "publicationId"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"status\": \"\",\n \"statusText\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ]\n}",
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-12c70bba-9f6d-47aa-b83d-ace82b38794f"
}
],
"createdAt": "2026-07-28T01:13:12.000Z",
"updatedAt": "2026-07-28T01:13:12.000Z",
"uid": "35240-2c1944d2-11be-42e5-b69d-196d4aa2273e"
},
{
"name": "Update subscription by ID OAuth Scope: subscriptions:write",
"id": "32d88bcf-d636-4bb3-9c96-f97c7d386d28",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tier\": \"premium\",\n \"premium_tier_ids\": [\n \"\",\n \"\"\n ],\n \"premium_tiers\": [\n \"\",\n \"\"\n ],\n \"email\": \"\",\n \"stripe_customer_id\": \"\",\n \"unsubscribe\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"delete\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publications/:publicationId/subscriptions/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"publications",
":publicationId",
"subscriptions",
":subscriptionId"
],
"variable": [
{
"id": "d6d853b5-b39c-4ef7-b893-bc11ce76c5f5",
"key": "publicationId",
"value": "",
"description": "(Required) The prefixed ID of the publication object"
},
{
"id": "130b64e6-2705-461b-b750-765ed9df8742",
"key": "subscriptionId",
"value": "",
"description": "(Required) The prefixed ID of the subscription object"
}
]
},
"description": "Update a single subscription."
},
"response": [
{
"id": "84dc1ec8-eb46-433d-a32c-01ffd67d81d3",
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tier\": \"premium\",\n \"premium_tier_ids\": [\n \"\",\n \"