diff --git a/PostmanCollections/VTEX - Subscriptions API v3.json b/PostmanCollections/VTEX - Subscriptions API v3.json index 7b671a067..94f932f7e 100644 --- a/PostmanCollections/VTEX - Subscriptions API v3.json +++ b/PostmanCollections/VTEX - Subscriptions API v3.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "a8395e9a-46a5-4d15-bbbe-e2825202293c" + "postman_id": "d7fc6267-6f9a-4e9d-a13f-6e2faeb59542" }, "item": [ { - "id": "1fab418d-d6ff-4eab-868a-7b700f71fdc6", + "id": "e885e5fb-0d68-49f2-ab6f-165d9762b8f8", "name": "Cycles", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "4c7d575e-42f0-47b6-8948-336982629502", + "id": "f98160c6-3b57-4f7e-b1ce-25ec4db0dd5b", "name": "Get cycle details", "request": { "name": "Get cycle details", "description": { - "content": "Retrieve a specific cycle by its ID.", + "content": "Retrieve a specific cycle by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -77,7 +77,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "51ebd6b9-e453-4717-8180-a0a5e35d1e90", + "id": "421e7dce-6f69-4ec0-8b18-d490bf025998", "name": "OK", "originalRequest": { "url": { @@ -145,7 +145,7 @@ { "listen": "test", "script": { - "id": "56922aa0-791f-4767-b797-939ea9d51d0a", + "id": "bde1b0b2-5f9b-473f-92dd-5e2a65fc9766", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/cycles/:cycleId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -161,12 +161,12 @@ } }, { - "id": "add57c51-0754-4f67-98f0-57c0bb1560e5", + "id": "7e487d59-953b-45b4-9f83-841964a9b5fc", "name": "List cycles", "request": { "name": "List cycles", "description": { - "content": "List cycles filtering by some arguments.", + "content": "List cycles filtering by some arguments.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -187,7 +187,7 @@ "type": "text/plain" }, "key": "beginDate", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -196,7 +196,7 @@ "type": "text/plain" }, "key": "endDate", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -205,7 +205,7 @@ "type": "text/plain" }, "key": "subscriptionId", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -214,7 +214,7 @@ "type": "text/plain" }, "key": "customerEmail", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -223,7 +223,7 @@ "type": "text/plain" }, "key": "status", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -278,7 +278,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "040a05a7-68c1-4bd4-89ae-59050ec9d9aa", + "id": "b1f3c235-d7c1-4086-ac94-c8390cba4709", "name": "OK", "originalRequest": { "url": { @@ -299,7 +299,7 @@ "type": "text/plain" }, "key": "beginDate", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -308,7 +308,7 @@ "type": "text/plain" }, "key": "endDate", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -317,7 +317,7 @@ "type": "text/plain" }, "key": "subscriptionId", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -326,7 +326,7 @@ "type": "text/plain" }, "key": "customerEmail", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -335,7 +335,7 @@ "type": "text/plain" }, "key": "status", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -409,7 +409,7 @@ { "listen": "test", "script": { - "id": "57875526-cc4f-49cc-9ccb-d8c71bb39f10", + "id": "9c054c4a-6350-44de-8ec3-0bc04d651f70", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/cycles - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -425,12 +425,12 @@ } }, { - "id": "06122775-b9a7-4527-97f6-c8d32992ac03", + "id": "89a95e05-8b9b-4a38-b552-c164b085607f", "name": "Retry cycle", "request": { "name": "Retry cycle", "description": { - "content": "Every subscription order has an execution count called cycle, which determines the position of an order counting from when the shopper subscribed. This endpoint reruns a cycle that is currently in error state.", + "content": "Every subscription order has an execution count called cycle, which determines the position of an order counting from when the shopper subscribed. This endpoint reruns a cycle that is currently in error state.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -454,7 +454,7 @@ "type": "text/plain" }, "type": "any", - "value": "ad laboris", + "value": "nisi", "key": "cycleId" } ] @@ -487,7 +487,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "805f9f4f-14a9-4af9-927d-ad327fa8dbfd", + "id": "a0edaa6e-ff3c-4128-990e-a13dd93ff68f", "name": "OK", "originalRequest": { "url": { @@ -546,7 +546,7 @@ { "listen": "test", "script": { - "id": "647dcc67-3045-4f12-9f80-b30886b49b4c", + "id": "150e97a2-30ec-4053-a249-186d6910b876", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/cycles/:cycleId/retry - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -562,7 +562,7 @@ "event": [] }, { - "id": "f891715d-b1fb-48f6-b5ab-f4fa6b9353ab", + "id": "42ba4e59-d52e-414c-b8f1-1ad84d5468ed", "name": "Plans", "description": { "content": "", @@ -570,12 +570,12 @@ }, "item": [ { - "id": "110a6c7f-2650-4ce3-b386-36f2f39e6d7f", + "id": "81ab4f58-beab-4d21-b20b-60faef5e8115", "name": "List plans", "request": { "name": "List plans", "description": { - "content": "List plans filtering by some arguments.", + "content": "List plans filtering by some arguments.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -596,7 +596,7 @@ "type": "text/plain" }, "key": "periodicity", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -605,7 +605,7 @@ "type": "text/plain" }, "key": "interval", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -660,7 +660,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a79b5768-3b23-41f1-9b43-2c22bef20f86", + "id": "ef8ab1d3-b273-4b1a-ad90-8ab20b448321", "name": "OK", "originalRequest": { "url": { @@ -681,7 +681,7 @@ "type": "text/plain" }, "key": "periodicity", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -690,7 +690,7 @@ "type": "text/plain" }, "key": "interval", - "value": "ad laboris" + "value": "nisi" }, { "disabled": true, @@ -764,7 +764,7 @@ { "listen": "test", "script": { - "id": "ada1c9a1-0e56-4a90-a7bb-fc7b0abebeb0", + "id": "079d680a-cd01-4e63-bc8a-f191f5b321cd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/plans - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -780,12 +780,12 @@ } }, { - "id": "b520765c-a594-412f-8655-98596468bb15", + "id": "ad6b284b-200a-43a6-bdbf-044697b680a7", "name": "Get plan details", "request": { "name": "Get plan details", "description": { - "content": "This endpoint retrieves a specific plan by its ID.", + "content": "This endpoint retrieves a specific plan by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -845,7 +845,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4b687225-75d9-4e9b-882e-3a62f0d97eb1", + "id": "30241b78-88ce-4d8b-be34-fee3dab8283c", "name": "OK", "originalRequest": { "url": { @@ -913,7 +913,7 @@ { "listen": "test", "script": { - "id": "5b4a2b0b-cb48-455b-ac92-b6fac468c8fc", + "id": "5a485acc-cfe9-4a39-bff5-b4f5c3a1744a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/plans/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -932,7 +932,7 @@ "event": [] }, { - "id": "a1072b39-7941-476a-a79e-7e5366e3a3c0", + "id": "499b9c6b-c02e-42ae-bc67-01b85e5c5cce", "name": "Reports", "description": { "content": "", @@ -940,12 +940,12 @@ }, "item": [ { - "id": "59eb95ee-cc76-476b-9052-e4b2d8201f2e", + "id": "31b99db6-72ce-43ea-9337-355dc8184fa4", "name": "List report templates", "request": { "name": "List report templates", "description": { - "content": "List all report templates available.\r\n\r\n>ℹ️ After choosing the desired template, use the [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pvt/reports/-reportName-/documents) endpoint to create the report for your store.", + "content": "List all report templates available.\r\n\r\n>ℹ️ After choosing the desired template, use the [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pvt/reports/-reportName-/documents) endpoint to create the report for your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription admin** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n| Subscriptions | ApplicationAccess | **Subscription metrics and reports** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -993,7 +993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "02ac0a6b-236e-45dd-81fd-4490106c9f50", + "id": "94e9a9d5-1e34-462c-ad03-629e5c117652", "name": "OK", "originalRequest": { "url": { @@ -1060,7 +1060,7 @@ { "listen": "test", "script": { - "id": "1605f321-82f7-4afe-b8c5-93c2aeb7b776", + "id": "ac816b78-e2d0-4d6c-8259-7feafa0a556c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/reports - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1076,12 +1076,12 @@ } }, { - "id": "6f473b67-279c-412d-87eb-4fd1e2338478", + "id": "e5d16feb-7491-4d53-bdb0-98c68b4520ef", "name": "Get report document details", "request": { "name": "Get report document details", "description": { - "content": "Retrieve information about a report document, searching by document ID. In the status code `200 OK` response, you get a link to download the report.\r\n\r\n>❗ Before using this endpoint, you must create a report with the [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pvt/reports/-reportName-/documents) endpoint and get the document ID.", + "content": "Retrieve information about a report document, searching by document ID. In the status code `200 OK` response, you get a link to download the report.\r\n\r\n>❗ Before using this endpoint, you must create a report with the [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pvt/reports/-reportName-/documents) endpoint and get the document ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription metrics and reports** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1153,7 +1153,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "62f3ac4b-fb8a-4950-b15c-a2aae8e1507f", + "id": "a00ebd4c-9f71-4040-b4e2-53174bfef62d", "name": "OK", "originalRequest": { "url": { @@ -1223,7 +1223,7 @@ { "listen": "test", "script": { - "id": "9ee27163-d6dd-4b4e-ab6c-ce2913d945a5", + "id": "05eaf992-dfc5-4777-8306-20bc787cb36d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/reports/:reportName/documents/:documentId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1239,12 +1239,12 @@ } }, { - "id": "86b3fa91-3aa6-4bcd-af62-46ad4141f4a6", + "id": "5ad8cc2a-106a-4704-a1ea-4bd94a3b5eb1", "name": "Generate report", "request": { "name": "Generate report", "description": { - "content": "Create a report in the format of a `csv` file and send it via email to a given user.\r\n\r\n>ℹ️ In the response body of the current endpoint, you get the document ID required for the [Get report document details](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports/-reportName-/documents/-documentId-) endpoint.\r\n\r\nYou can generate the following types of report:\r\n\r\n- `subscriptionsWithStatus`: Get subscriptions based on subscription cycle execution status.\r\n - **Query param required:** `status`.\r\n\r\n- `subscriptionsScheduledBetweenDate`: Get active subscriptions scheduled between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `subscriptionsUpdatedBetweenDate`: Get subscriptions updated between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `subscriptionsCreatedBetweenDate`: Get subscriptions created between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `executionsBetweenDate`: Get executions between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n>ℹ️ You can also use the [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports) endpoint to discover the types of reports you can generate.", + "content": "Create a report in the format of a `csv` file and send it via email to a given user.\r\n\r\n>ℹ️ In the response body of the current endpoint, you get the document ID required for the [Get report document details](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports/-reportName-/documents/-documentId-) endpoint.\r\n\r\nYou can generate the following types of report:\r\n\r\n- `subscriptionsWithStatus`: Get subscriptions based on subscription cycle execution status.\r\n - **Query param required:** `status`.\r\n\r\n- `subscriptionsScheduledBetweenDate`: Get active subscriptions scheduled between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `subscriptionsUpdatedBetweenDate`: Get subscriptions updated between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `subscriptionsCreatedBetweenDate`: Get subscriptions created between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n- `executionsBetweenDate`: Get executions between dates.\r\n - **Query params required:** `beginDate` and `endDate`.\r\n\r\n>ℹ️ You can also use the [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports) endpoint to discover the types of reports you can generate.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription metrics and reports** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1342,7 +1342,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9ee32ec5-ca6c-4b43-a5c1-46c814aff128", + "id": "e5d9f7b5-1d2c-45b3-8131-4a91247debca", "name": "OK", "originalRequest": { "url": { @@ -1448,7 +1448,7 @@ { "listen": "test", "script": { - "id": "c5d62ebe-64ca-4c5c-be1f-ba7dcfedbddf", + "id": "8366ccd2-4596-4e41-845a-f3a1455dd63b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pvt/reports/:reportName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1467,7 +1467,7 @@ "event": [] }, { - "id": "72499e27-5f9c-4ac0-b43d-5c6529d52e3f", + "id": "6339c75a-9ee1-4518-b5fe-acfb730fee4d", "name": "Subscriptions", "description": { "content": "", @@ -1475,12 +1475,12 @@ }, "item": [ { - "id": "db9ff808-57dc-49f2-86c0-15aaf1bd2dd6", + "id": "9ae3f1ec-e962-4e0f-979f-2c96463d6a77", "name": "Get subscription details by ID", "request": { "name": "Get subscription details by ID", "description": { - "content": "Retrieves information about a subscription, searching by subscription ID.", + "content": "Retrieves information about a subscription, searching by subscription ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1540,7 +1540,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9a3150ce-4e62-451f-8eca-f34a79d02f8b", + "id": "7637dbdb-9a4c-4985-8041-ca6550a637ca", "name": "OK", "originalRequest": { "url": { @@ -1608,7 +1608,7 @@ { "listen": "test", "script": { - "id": "8e5bce0c-b226-468e-8801-9425debbb086", + "id": "78355b75-2d27-4959-8dd9-d3e3f3725482", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1624,12 +1624,12 @@ } }, { - "id": "661f5399-8bdd-4751-86eb-676a54f249e3", + "id": "075dce89-9da0-4c7c-b8e0-7d68b20571ce", "name": "Update subscription by ID", "request": { "name": "Update subscription by ID", "description": { - "content": "Updates a subscription, searching by subscription ID.", + "content": "Updates a subscription, searching by subscription ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1702,7 +1702,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d9d79f78-2c44-4480-b2f5-a235d4b4f09c", + "id": "31d5fbe1-aa9c-43dd-8f01-55044173b374", "name": "OK", "originalRequest": { "url": { @@ -1783,7 +1783,7 @@ { "listen": "test", "script": { - "id": "c61adcd3-4d50-4499-a70f-4c889bc72398", + "id": "012e89ef-b44d-49a2-b377-83302d517f64", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/rns/pub/subscriptions/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1799,12 +1799,12 @@ } }, { - "id": "479bd654-86f0-46c0-8d34-c0f09c9db36a", + "id": "69ba00d3-af2a-48eb-b8b4-a4b10e892691", "name": "List subscriptions", "request": { "name": "List subscriptions", "description": { - "content": "Lists subscriptions from your store. If you wish, you can use query parameters. By default, this request returns the query parameter `page` value `1`, and `size` value `15`.\r\n\r\n>⚠️ The status code response `200 OK` is limited to 15 results. You can get different values by combining pagination query parameters.", + "content": "Lists subscriptions from your store. If you wish, you can use query parameters. By default, this request returns the query parameter `page` value `1`, and `size` value `15`.\r\n\r\n>⚠️ The status code response `200 OK` is limited to 15 results. You can get different values by combining pagination query parameters.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1934,7 +1934,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8d4b7fc9-795b-44ce-8970-704bf67c4717", + "id": "1733e47c-5f36-4a05-bc2b-1acb902ec991", "name": "OK", "originalRequest": { "url": { @@ -2083,7 +2083,7 @@ { "listen": "test", "script": { - "id": "ce98ce54-ccb4-4dae-a96b-0e96e904c612", + "id": "75a03996-6862-4f21-998e-6cab10e0e1f5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2099,12 +2099,12 @@ } }, { - "id": "fa49fbfe-a4ce-4f35-8dee-5256189c0606", + "id": "e7176cf5-e1df-4a54-b492-6e9a579630c4", "name": "Create subscription", "request": { "name": "Create subscription", "description": { - "content": "Creates a new subscription.", + "content": "Creates a new subscription.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2165,7 +2165,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6ce21e97-c17f-4065-8e34-c45f5fbd08dc", + "id": "c95f67ae-4f1c-4601-ba81-864f18378461", "name": "Created", "originalRequest": { "url": { @@ -2245,7 +2245,7 @@ { "listen": "test", "script": { - "id": "d517c4b4-52bb-4d02-a16f-64572ca9b5f8", + "id": "f3d76c65-a4fd-4c76-9f4f-4b2ecd543c5f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2261,12 +2261,12 @@ } }, { - "id": "206a0490-3cd1-45e8-8af0-e4c5533bac34", + "id": "16cb94c6-3a05-4cc5-9ece-3b95397148c2", "name": "Remove item from subscription", "request": { "name": "Remove item from subscription", "description": { - "content": "Removes an item from a given subscription.", + "content": "Removes an item from a given subscription.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2334,7 +2334,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7ef7bd03-a5ea-4697-8206-ca5a689ba985", + "id": "a9ad8dab-3f35-4ace-818c-db15f55d14cd", "name": "No Content", "originalRequest": { "url": { @@ -2394,7 +2394,7 @@ { "listen": "test", "script": { - "id": "ebb2e524-77b5-4b90-a8c6-3fe83caadf34", + "id": "8641b1b4-2cce-4e07-ada8-11a36dbb59ea", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/rns/pub/subscriptions/:id/items/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2408,12 +2408,12 @@ } }, { - "id": "02c63861-7cb6-41f5-aa5c-f1e38ebbef64", + "id": "d2afce2b-fbcf-47d8-9c0f-02a30faa3286", "name": "Edit item from subscription", "request": { "name": "Edit item from subscription", "description": { - "content": "Edits an item from a given subscription.", + "content": "Edits an item from a given subscription.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2498,7 +2498,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1916bdf5-f48c-499c-9e9e-537d29c2cb40", + "id": "3d61f831-12f0-4999-a006-27830d35b1b7", "name": "OK", "originalRequest": { "url": { @@ -2581,7 +2581,7 @@ { "listen": "test", "script": { - "id": "6cb3f580-4d32-4976-8686-9ef5048922e2", + "id": "3c4e02d1-5be5-47af-9120-01117ee73777", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/rns/pub/subscriptions/:id/items/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2597,12 +2597,12 @@ } }, { - "id": "84ff0028-7757-4f15-80cc-e0fb0b6c1e37", + "id": "e93e50ac-69fe-4dbe-b9d0-78a111abf6b7", "name": "Add item to subscription", "request": { "name": "Add item to subscription", "description": { - "content": "Adds a new item to a given subscription.", + "content": "Adds a new item to a given subscription.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2676,7 +2676,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "89edf7ce-64ef-421c-8547-708dae7ed6fc", + "id": "1ee7a832-0fa7-4a89-ba29-d78137294647", "name": "OK", "originalRequest": { "url": { @@ -2758,7 +2758,7 @@ { "listen": "test", "script": { - "id": "92b620fc-c795-4ecc-8a92-e46eaa2fd420", + "id": "c5ffeda5-954b-40e7-bda6-1f1058d8c9b2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/:id/items - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2774,12 +2774,12 @@ } }, { - "id": "4301b491-9b85-4281-9d2e-4ecea3a5f6e3", + "id": "85ca6679-a86e-4f47-b99b-c464933922ab", "name": "Calculate the current prices for a subscription", "request": { "name": "Calculate the current prices for a subscription", "description": { - "content": "Simulates an order made by the specific subscription on checkout and retrieves the current price for items and shipping.", + "content": "Simulates an order made by the specific subscription on checkout and retrieves the current price for items and shipping.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2840,7 +2840,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4e2b21f6-966c-4630-bc56-30609e993cac", + "id": "8cadba20-492c-47a8-a387-0bc73593dc6c", "name": "OK", "originalRequest": { "url": { @@ -2909,7 +2909,7 @@ { "listen": "test", "script": { - "id": "4617c74d-263b-494f-b1cb-946acce3f684", + "id": "2fb4a585-1d71-4392-9cdf-b83d31781941", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/:id/simulate - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2925,12 +2925,12 @@ } }, { - "id": "28c1f9d0-e17c-4edd-9c16-a2d1cee1169d", + "id": "9527d210-301d-4584-9bac-0c691bb937a6", "name": "Calculate the current prices for the provided subscription template", "request": { "name": "Calculate the current prices for the provided subscription template", "description": { - "content": "Simulates an order made by subscriptions on checkout and retrieves the current price for items and shipping.", + "content": "Simulates an order made by subscriptions on checkout and retrieves the current price for items and shipping.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2992,7 +2992,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e8556694-a575-4265-9a41-65d125289dea", + "id": "5298bd36-4208-47bd-88f2-5ac8e4305830", "name": "OK", "originalRequest": { "url": { @@ -3073,7 +3073,7 @@ { "listen": "test", "script": { - "id": "ff007028-49a3-4f52-bde2-4e47fca51c30", + "id": "837e110c-840f-448f-9e70-960715cd9ed6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/simulate - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3089,12 +3089,12 @@ } }, { - "id": "89975fb7-2ab2-4b90-afc1-fd139f8d9ff3", + "id": "a5bdf426-fc31-4d2b-b07d-27ef6268c0b2", "name": "Get conversation messages", "request": { "name": "Get conversation messages", "description": { - "content": "Retrieve all conversation messages sent to a customer regarding a subscription.", + "content": "Retrieve all conversation messages sent to a customer regarding a subscription.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription view only** |\r\n| Subscriptions | ApplicationAccess | **Subscription view and edit** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3155,7 +3155,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "006b51da-0864-4d81-b47b-0b8b05e8a02e", + "id": "786f6dba-eefd-49de-9b81-40054f2641aa", "name": "OK", "originalRequest": { "url": { @@ -3224,7 +3224,7 @@ { "listen": "test", "script": { - "id": "4e93dca1-1938-4010-96a7-b0f4f6b95942", + "id": "bec580c2-742c-4aa1-944c-d7b6fcdd0700", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions/:subscriptionId/conversation-message - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3243,7 +3243,7 @@ "event": [] }, { - "id": "a4629b34-6a3e-419b-b14a-ed9adb933ebd", + "id": "295ca476-00f6-4bbd-adaa-d3ef3318d4a9", "name": "Settings", "description": { "content": "", @@ -3251,12 +3251,12 @@ }, "item": [ { - "id": "7b6eba63-ca87-4165-967a-29eef7f8cb9b", + "id": "47d1c8a3-54ca-4525-a3a2-456d8d81177d", "name": "Get subscriptions settings", "request": { "name": "Get subscriptions settings", "description": { - "content": "Retrieves information about the subscriptions settings of your store.", + "content": "Retrieves information about the subscriptions settings of your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3303,7 +3303,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3d5afe3a-61c4-426e-b7e0-be802e3cc1ef", + "id": "35df617c-7ee8-4353-81d5-f7860c50cd24", "name": "OK", "originalRequest": { "url": { @@ -3369,7 +3369,7 @@ { "listen": "test", "script": { - "id": "21b8f3fc-21e6-4a44-ad84-9d629d62279a", + "id": "cc6e47ab-b58f-4cf8-b5e1-3ef228e674f4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3385,12 +3385,12 @@ } }, { - "id": "d3575c0c-b562-46c1-90a8-b9148f702c21", + "id": "a55b2122-8890-45f8-91f6-1877cd5e3a66", "name": "Edit subscriptions settings", "request": { "name": "Edit subscriptions settings", "description": { - "content": "Edits the subscriptions settings of your store. This configurations apply to all subscriptions.", + "content": "Edits the subscriptions settings of your store. This configurations apply to all subscriptions.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Subscriptions | ApplicationAccess | **Subscription admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3450,7 +3450,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "dd730b71-4e1e-474f-b1a9-323d3809020f", + "id": "e3f7f240-69ad-4cee-8729-1f1c7df2b382", "name": "OK", "originalRequest": { "url": { @@ -3529,7 +3529,7 @@ { "listen": "test", "script": { - "id": "58b1bd11-41f4-4e11-b440-549cde6a59b9", + "id": "19543db1-daaa-4765-a109-c39652e713ad", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3587,7 +3587,7 @@ } ], "info": { - "_postman_id": "a8395e9a-46a5-4d15-bbbe-e2825202293c", + "_postman_id": "d7fc6267-6f9a-4e9d-a13f-6e2faeb59542", "name": "Subscriptions API (v3)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {