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

{
  "billing": {
    "billingMethod": "OrderAmount",
    "billingPeriodAmount": null,
    "billingTerm": 1,
    "billingTermUnit": "Month",
    "billingType": "Arrears",
    "cancellationDate": null,
    "currencyIsoCode": "USD",
    "nextBillingDate": "2024-10-10",
    "savedPaymentMethod": {
      "gatewayResponse": {},
      "id": "12qxx000002pmmSAAQ",
      "merchantAccountId": "8zbxx00000000ODAAY",
      "name": "Ra*****"
    }
  },
  "cancelStatus": null,
  "endDate": "2025-09-10T23:59:59.000Z",
  "id": "02ixx0000004HJKAA2",
  "product": null,
  "quantity": null,
  "sellingModel": null,
  "startDate": "2024-09-10T00:00:00.000Z",
  "subscriptionTerm": null
}

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

{
  "billing": {
    "currencyIsoCode": "USD",
    "billingMethod": "OrderAmount",
    "billingTerm": 1,
    "billingTermUnit": "Month",
    "billingType": "Advance",
    "billingPeriodAmount": "500",
    "nextBillingDate": "2023-08-01",
    "cancellationDate": null,
    "savedPaymentMethod": {
      "id": "12q000000Mn1234",
      "gatewayRefId": null,
      "referenceOwnerId": null,
      "paymentGatewayId": null,
      "merchantAccountId": null,
      "gatewayCustomerReference": null,
      "error": null,
      "name": "Visa....1234",
      "usageType": null,
      "accountHolderName": null,
      "accountHolderEmail": null,
      "isDefault": null,
      "status": null,
      "type": null,
      "network": "Visa",
      "issuer": null,
      "last4": null,
      "expiryMonth": null,
      "bankName": null,
      "bankCode": null,
      "bankAccountType": null,
      "savedByMerchant": null
    }
  },
  "cancelStatus": "Success",
  "endDate": "2024-07-31T23:59:59.000Z",
  "id": "02i000000Xy1234",
  "product": {
    "id": "01txx00000034cv",
    "name": "Alpine Creative Suite",
    "sku": "#421234",
    "fields": null,
    "image": {
      "alternateText": null,
      "contentVersionId": null,
      "id": "2pmRO00000000x2YAA",
      "mediaType": null,
      "sortOrder": null,
      "thumbnailUrl": null,
      "title": "tshirt 5",
      "url": "/cms/delivery/media/MC2KSOOFJGRZDDJGQG4QJHLKHTZQ?recordId=01tRO000000FVNB&buyerId=001RO000001npBo"
    },
    "variationAttributes": null,
    "canViewProduct": true,
    "success": true,
    "error": null
  },
  "quantity": 5,
  "sellingModel": {
    "id": "0jP000000Pq1234",
    "name": "Term Defined",
    "sellingModelType": "TermDefined",
    "pricingTerm": "1",
    "pricingTermUnit": "Month"
  },
  "startDate": "2023-08-01T00:00:00.000Z",
  "subscriptionTerm": 12
}

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

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

Connect REST API Developer Guide

No Results

Commerce Subscription Detail