Commerce Subscription Detail

Representation for the Commerce subscription details.

JSON examples

Here’s a sample response for the Commerce Subscription Detail in the Saved Payment Method PATCH request:

The PATCH API populates only the billing, endDate, id, and startDate field values in the response. Other fields are ignored by the PATCH API.

Note

1{
2  "billing": {
3    "billingMethod": "OrderAmount",
4    "billingPeriodAmount": null,
5    "billingTerm": 1,
6    "billingTermUnit": "Month",
7    "billingType": "Arrears",
8    "cancellationDate": null,
9    "currencyIsoCode": "USD",
10    "nextBillingDate": "2024-10-10",
11    "savedPaymentMethod": {
12      "gatewayResponse": {},
13      "id": "12qxx000002pmmSAAQ",
14      "merchantAccountId": "8zbxx00000000ODAAY",
15      "name": "Ra*****"
16    }
17  },
18  "cancelStatus": null,
19  "endDate": "2025-09-10T23:59:59.000Z",
20  "id": "02ixx0000004HJKAA2",
21  "product": null,
22  "quantity": null,
23  "sellingModel": null,
24  "startDate": "2024-09-10T00:00:00.000Z",
25  "subscriptionTerm": null
26}

Here’s a sample response for the Commerce Subscription Detail in the Commerce Subscriptions GET request:

1{
2  "billing": {
3    "currencyIsoCode": "USD",
4    "billingMethod": "OrderAmount",
5    "billingTerm": 1,
6    "billingTermUnit": "Month",
7    "billingType": "Advance",
8    "billingPeriodAmount": "500",
9    "nextBillingDate": "2023-08-01",
10    "cancellationDate": null,
11    "savedPaymentMethod": {
12      "id": "12q000000Mn1234",
13      "gatewayRefId": null,
14      "referenceOwnerId": null,
15      "paymentGatewayId": null,
16      "merchantAccountId": null,
17      "gatewayCustomerReference": null,
18      "error": null,
19      "name": "Visa....1234",
20      "usageType": null,
21      "accountHolderName": null,
22      "accountHolderEmail": null,
23      "isDefault": null,
24      "status": null,
25      "type": null,
26      "network": "Visa",
27      "issuer": null,
28      "last4": null,
29      "expiryMonth": null,
30      "bankName": null,
31      "bankCode": null,
32      "bankAccountType": null,
33      "savedByMerchant": null
34    }
35  },
36  "cancelStatus": "Success",
37  "endDate": "2024-07-31T23:59:59.000Z",
38  "id": "02i000000Xy1234",
39  "product": {
40    "id": "01txx00000034cv",
41    "name": "Alpine Creative Suite",
42    "sku": "#421234",
43    "fields": null,
44    "image": {
45      "alternateText": null,
46      "contentVersionId": null,
47      "id": "2pmRO00000000x2YAA",
48      "mediaType": null,
49      "sortOrder": null,
50      "thumbnailUrl": null,
51      "title": "tshirt 5",
52      "url": "/cms/delivery/media/MC2KSOOFJGRZDDJGQG4QJHLKHTZQ?recordId=01tRO000000FVNB&buyerId=001RO000001npBo"
53    },
54    "variationAttributes": null,
55    "canViewProduct": true,
56    "success": true,
57    "error": null
58  },
59  "quantity": 5,
60  "sellingModel": {
61    "id": "0jP000000Pq1234",
62    "name": "Term Defined",
63    "sellingModelType": "TermDefined",
64    "pricingTerm": "1",
65    "pricingTermUnit": "Month"
66  },
67  "startDate": "2023-08-01T00:00:00.000Z",
68  "subscriptionTerm": 12
69}

Property Name	Type	Description	Filter Group and Version	Available Version
`billing`	Commerce Subscription Billing Summary	Billing info associated with the Commerce subscription.	Small, 63.0	63.0
`cancelStatus`	String	Cancel status of the Commerce subscription. Possible values are: `Failed`—The operation status is failed. `InProgress`—The operation status is in progress. `Success`—The operation status is successful.	Small, 63.0	63.0
`endDate`	String	End date associated with the Commerce subscription.	Small, 63.0	63.0
`id`	String	ID of the Commerce subscription record.	Small, 63.0	63.0
`product`	Buyer Product Summary	Product associated with the Commerce subscription.	Small, 63.0	63.0
`quantity`	Double	Quantity associated with the Commerce subscription.	Small, 63.0	63.0
`sellingModel`	Product Selling Model	Selling model associated with the Commerce subscription.	Small, 63.0	63.0
`startDate`	String	Start date associated with the Commerce subscription.	Small, 63.0	63.0
`subscriptionTerm`	Integer	Subscription term associated with the Commerce subscription.	Small, 63.0	63.0

Connect REST API Developer Guide

Commerce Subscription Detail