API reference
A valid request URL is required to generate request examples{
"applyBestPriceOnContinuityOrder": true,
"applyLatestItemPriceOnContinuityOrder": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"continuityOrderDateOffset": 123,
"nextOrderDateOffset": 123,
"orderNowResetNextOrderDate": true,
"pauseSubscriptionOffset": 123,
"restrictOrderNowOffset": 123,
"skipSubscriptionOffset": 123,
"subscriptionOrderReminderOffset": 123,
"subscriptionPauseLimitReminderOffset": 123,
"subscriptionPausedReminderOffset": 123
}Create Subscription Settings
Creates new subscription settings for a site
A valid request URL is required to generate request examples{
"applyBestPriceOnContinuityOrder": true,
"applyLatestItemPriceOnContinuityOrder": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"continuityOrderDateOffset": 123,
"nextOrderDateOffset": 123,
"orderNowResetNextOrderDate": true,
"pauseSubscriptionOffset": 123,
"restrictOrderNowOffset": 123,
"skipSubscriptionOffset": 123,
"subscriptionOrderReminderOffset": 123,
"subscriptionPauseLimitReminderOffset": 123,
"subscriptionPausedReminderOffset": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Subscription settings defined or this site
If this setting is enabled, the item price on the continuity order will be updated to the current price upon creation.
Show child attributes
Show child attributes
Specifies the number of days before the next order date to create the continuity order.
Specifies the number of days to update the next order date from existing next order date.
Specifies if order now action resets next order date
Specifies the number of continuity orders should be placed before activating the subscription.
Specifies the number of days, order all items now or order partial items now actions cannot be repeated from the last action.
Specifies the number of times the subscription can be skipped
Specifies the number of days to send subscription order reminder email before the next continuity order.
Specifies the number of days prior to when we need to send a "subscription pause limit reached reminder" email before the pause limit is reached.
Specifies the number of days to send subscription paused reminder email.
Response
Success
Subscription settings defined or this site
If this setting is enabled, the item price on the continuity order will be updated to the current price upon creation.
Show child attributes
Show child attributes
Specifies the number of days before the next order date to create the continuity order.
Specifies the number of days to update the next order date from existing next order date.
Specifies if order now action resets next order date
Specifies the number of continuity orders should be placed before activating the subscription.
Specifies the number of days, order all items now or order partial items now actions cannot be repeated from the last action.
Specifies the number of times the subscription can be skipped
Specifies the number of days to send subscription order reminder email before the next continuity order.
Specifies the number of days prior to when we need to send a "subscription pause limit reached reminder" email before the pause limit is reached.
Specifies the number of days to send subscription paused reminder email.