Hypermedia

The Riverty Recurring Payments API exposes some hypermedia controls, making it easier for your integration to leverage the capabilities and functionalities of the product. Responses can have different link collections, depending on objects and actions available for this object.

Subscription

Subscription Discount

Consumption

Example

For example, a call to [Get] Subscription - returns responses including list of _links, which can be used to determine available actions for current Subscription items. Example below shows links returned by calling [Get] Subscription. The following actions can be performed with this subscription.

• "self" - get this subscription
• "subscription-product" - get product associated with this subscription
• "cancellation" - cancel subscription. (This link is provided if this action is available for this subscription)
• "termination" - terminate subscription. (This link is provided if this action is available for this subscription)
• "timeline" - history of actions performed for this subscription