Commerce Recurring Services

Component ID

2799405

Component name

Commerce Recurring Services

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Component created

Component changed

Component body

This module provides Services resources for Commerce Recurring Framework entities. Currently this module provides an index of all recurring entities and a cancel action to cancel a recurring entity.

The index resource accepts the same query arguments as the node resource from the Services module with an additional argument to filter by the status of the recurring entity. For example:

https://example.com/path/to/endpoint/commerce_recurring?status=1

To cancel a recurring entity just add the recurring entity ID as an argument. For example:

https://example.com/path/to/endpoint/commerce_recurring/3

Where "3" is the ID of the entity to cancel.

Patch Required

This module requires the patch to Commerce Recurring from #2794535: Add event for subscription cancellation to add the cancellation rules event. This was needed for the project I wrote this module for as well.

Roadmap

More actions may be added at some point, patches welcome!