This API enables you to perform the following actions on a subscription:

  • Inactivate: Suspends the subscription.

  • Activate: Restarts the subscription.

  • Change frequency type: Changes the frequency of the subscription; for example, from monthly to biweekly.

  • Change next order date: Changes the date of the next delivery.

URI Summary

Operation

Action

URI Template

URI Example

Transaction Type

Unique RequestID Needed for Duplicate Detection?

Non-URI Request Payload

Response

Manage

PUT

/order-subscription/sellers/{sellerId}/subscriptions/{subscriptionId}

/order-subscription/sellers/TMSUS /subscriptions/2171

Update subscriptions that match the update criteria.

No

JSON

200 + JSON

response

URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:

https://apg.radial.com/v1.0/proxyname/storecode/function

You should have received the applicable information for proxyname, storecode, and function from your Radial representative.

Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.

Examples

Deactivate Subscription

Request URL

Copy
http://.../order-subscription/sellers/TMSUS/subscriptions/2171?actionName=DEACTIVATE

Activate Subscription

Request URL

Copy
http://.../order-subscription/sellers/TMSUS/subscriptions/2171?actionName=ACTIVATE

Change Frequency Type

Request URL

Copy
http://.../order-subscription/sellers/TMSUS/subscriptions/2171?frequencyType=MONTH&frequencyValue=30

Change Next Order Date

Request URL

Copy
http://.../order-subscription/sellers/TMSUS/subscriptions/2171?nextOrderDate=2022-06-01&actionName=UPDATENEXTORDERDATE