Configure subscriptions
Learn how to configure the Digital River app for subscriptions.
Configuring the Digital River app for subscriptions requires you to perform a few additional steps. You must identify for each Cart Item object whether the product is a subscription with additional relevant information as described below. You should create a trigger, flow, or other mechanism to automate the population of this data as Cart Items are added to the Cart.
The Digital River app will identify whether a product is a subscription by the value in the Recurring Line Item field (API name: digitalriverv3__Recurring_Line_Item__c) which is on Cart Item object.
When the Recurring Line Item field value istrue
, it indicates the product is a subscription. If the Recurring Line Item field value isfalse
, it indicates the product is not a subscription.
You will need to populate the Recurring Line Item field accordingly so that the app can identify whether a product is a subscription. If the field is not populated, the application will treat the product as a non-subscription.
The application will optionally allow you to specify the subscription's startTime
and endTime
. The following information is included in the subscriptionInfo
field and sent across to Digital River during the create checkout API call:
If the
startTime
andendTime
are specified, then this information will be included in thesubscriptionInfo
block.If only the
endTime
is specified but not thestartTime
, then the app will default thestartTime
to the current date/time.If the
endTime
is not specified, then both thestartTime
andendTime
are not included in thesubscriptionInfo
block.
Finally, the following optional fields are available to be populated on the Cart Item. If specified, the values will be sent to Digital River.
Field
Description
freeTrial
This field has a true
or false
value that indicates whether a free trial period is being offered.
subscriptionId
This field can be used to supply the client's subscription identifier (if applicable).
Last updated