Create Subscription Records Action
Creates subscription records for orders containing subscription products. It accepts either the order summary ID or the order item summary IDs as input, filters the subscription products, and creates records to manage them effectively.
This action is available in API version 63.0 and later for users with system administrator access or the Assetize Order permission set assigned, along with any of the following licenses enabled:
- B2B Commerce, or D2C Commerce and Revenue Cloud Subscription Management. When this license is enabled in your org, both
orderSummaryIdandorderItemSummaryIdsare supported. - B2B Commerce, or D2C Commerce and Revenue Lifecycle Management. When this license is enabled in your org, only
orderSummaryIdis supported.
URI: /services/data/vXX.X/actions/standard/createSubscriptionRecords
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
| Input | Type | Description |
|---|---|---|
webStoreId | String | Required. The ID of the web store associated with the order. |
orderSummaryId | String | The ID of the order summary record. Optional if orderItemSummaryIds is specified. |
orderItemSummaryIds | String | The list of the order item summary IDs. Optional if orderSummaryId is specified. |
| Output | Type | Description |
|---|---|---|
SubscriptionProcessedItems | STRING | An array of order item summary IDs that are processed and have an associated subscription record created. |
Sample Request
Here’s a sample request with orderSummaryID and webStoreID:
Here’s a sample request with orderItemSummaryIDs and webStoreID:
Sample Response