Commerce Subscription Collection

Representation for the Commerce subscriptions collection.
JSON example
1{
2  "count": 2,
3  "currentPageToken": null,
4  "currentPageUrl": "/services/data/v66.0/commerce/webstores/0ZExx0000000001/subscriptions?effectiveAccountId=001xx000003GZ4l&pageSize=25&sortOrder=CreatedDateDesc",
5  "nextPageToken": null,
6  "nextPageUrl": null,
7  "previousPageToken": null,
8  "previousPageUrl": null,
9  "sortOrder": "CreatedDateDesc",
10  "subscriptions": [
11    {
12      "amendmentStatus": null,
13      "billing": {
14        "billingMethod": "OrderAmount",
15        "billingPeriodAmount": "38.0",
16        "billingTerm": 1,
17        "billingTermUnit": "Month",
18        "billingType": "Advance",
19        "cancellationDate": null,
20        "currencyIsoCode": "USD",
21        "nextBillingDate": null,
22        "savedPaymentMethod": null
23      },
24      "cancelStatus": null,
25      "endDate": "2025-10-25T23:59:59.000+0000",
26      "id": "02ixx0000004HxeAAE",
27      "lastAction": {
28        "details": {
29          "changes": [
30            {
31              "field": "quantity",
32              "previousValue": 2,
33              "newValue": 1
34            }
35          ],
36          "errors": null,
37          "status": "Success"
38        },
39        "effectiveDateTime": "2025-12-20",
40        "performedDateTime": "2025-11-20T09:39:59.000Z",
41        "type": "Amend"
42      },
43      "processExceptions": [],
44      "product": {
45        "canViewProduct": true,
46        "error": null,
47        "fields": {
48          "Description": {
49            "dataName": "Description",
50            "dataType": "STANDARD",
51            "label": "Description",
52            "text": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET",
53            "type": "TEXTAREA"
54          },
55          "StockKeepingUnit": {
56            "dataName": "StockKeepingUnit",
57            "dataType": "STANDARD",
58            "label": "StockKeepingUnit",
59            "text": "6010009",
60            "type": "STRING"
61          },
62          "Name": {
63            "dataName": "Name",
64            "dataType": "STANDARD",
65            "label": "Name",
66            "text": "Netflix subscription",
67            "type": "STRING"
68          }
69        },
70        "id": "01txx0000006i2SAAQ",
71        "image": {
72          "alternateText": "",
73          "contentVersionId": null,
74          "id": "2pmxx0000000003AAA",
75          "mediaType": "Image",
76          "sortOrder": 0,
77          "thumbnailUrl": null,
78          "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg",
79          "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg"
80        },
81        "name": "Netflix subscription",
82        "purchaseQuantityRule": {
83          "increment": "1.0",
84          "maximum": "8",
85          "minimum": "1.0"
86        },
87        "sku": "6010009",
88        "success": true,
89        "variationAttributes": []
90      },
91      "quantity": 2,
92      "renewalStatus": null,
93      "sellingModel": {
94        "id": "0jPxx0000000002EAA",
95        "name": "Term - Monthly",
96        "pricingTerm": 1,
97        "pricingTermUnit": "Months",
98        "sellingModelType": "TermDefined"
99      },
100      "startDate": "2025-09-26T00:00:00.000+0000",
101      "subscriptionTerm": 1
102    },
103    {
104      "amendmentStatus": null,
105      "billing": null,
106      "cancelStatus": null,
107      "endDate": "2026-01-24T23:59:59.000+0000",
108      "id": "02ixx0000004HKwAAM",
109      "lastAction": null,
110      "processExceptions": [],
111      "product": {
112        "canViewProduct": true,
113        "error": null,
114        "fields": {
115          "Description": {
116            "dataName": "Description",
117            "dataType": "STANDARD",
118            "label": "Description",
119            "text": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET",
120            "type": "TEXTAREA"
121          },
122          "StockKeepingUnit": {
123            "dataName": "StockKeepingUnit",
124            "dataType": "STANDARD",
125            "label": "StockKeepingUnit",
126            "text": "6010009",
127            "type": "STRING"
128          },
129          "Name": {
130            "dataName": "Name",
131            "dataType": "STANDARD",
132            "label": "Name",
133            "text": "Netflix subscription",
134            "type": "STRING"
135          }
136        },
137        "id": "01txx0000006i2SAAQ",
138        "image": {
139          "alternateText": "",
140          "contentVersionId": null,
141          "id": "2pmxx0000000003AAA",
142          "mediaType": "Image",
143          "sortOrder": 0,
144          "thumbnailUrl": null,
145          "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg",
146          "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg"
147        },
148        "name": "Netflix subscription",
149        "purchaseQuantityRule": {
150          "increment": "1.0",
151          "maximum": "8",
152          "minimum": "1.0"
153        },
154        "sku": "6010009",
155        "success": true,
156        "variationAttributes": []
157      },
158      "quantity": 2,
159      "renewalStatus": null,
160      "sellingModel": {
161        "id": "0jPxx0000000002EAA",
162        "name": "Term - Monthly",
163        "pricingTerm": 1,
164        "pricingTermUnit": "Months",
165        "sellingModelType": "TermDefined"
166      },
167      "startDate": "2025-09-25T00:00:00.000+0000",
168      "subscriptionTerm": 4
169    }
170  ]
171}
Property Name Type Description Filter Group and Version Available Version
count Integer Total number of subscriptions returned only on the current page. Small, 63.0 63.0
currentPage​Token String Token for the current page of subscriptions. Small, 63.0 63.0
currentPage​Url String URL to the current page of subscriptions. Small, 63.0 63.0
nextPageToken String Token for the next page of subscriptions. Small, 63.0 63.0
nextPageUrl String URL to the next page of subscriptions. Small, 63.0 63.0
previousPage​Token String Token for the previous page of subscriptions. Small, 63.0 63.0
previousPage​Url String URL to the previous page of subscriptions. Small, 63.0 63.0
sortOrder String Sort order of the subscription results returned in the page. Possible values are:
  • CreatedDateAsc—Sort in ascending order of created date.
  • CreatedDateDesc—Sort in descending order of created date.
Small, 63.0 63.0
subscriptions Commerce Subscription Detail[] Details of Commerce subscriptions. Small, 63.0 63.0