Mark a Subscription’s Status as Pending Return

This process can be automated via our customer API. This is the PUT request you can use https://api-docs.circuly.io/docs/customers-api-docs/916cb4d9c8142-set-real-subscription-end-date that you can use to mark the subscription status as pending return.


Marking the subscription status as “pending return” can be either done manually or it can be automatically triggered.

The subscription status is automatically set to pending return when the subscription end date has been reached. In practice every subscription comes with an end date and will receive the "pending return" status automatically when the subscription end date has arrived. Doing so ensures that no manual action is needed for tracking returns or sending transaction communication to the customer in the normal process of a subscription.

A manual intervention is only needed when you want to set the subscription status as pending return prior to the end date of the subscription.

You can mark the subscription status as pending return manually when you get a cancellation request from the customer. To process the cancellation request, you need to mark the subscription status as pending return so that the return process can be trigged.

IMPORTANT: Read more about the difference between Cancelling an order and setting the subscription status as pending return.

Follow these steps to mark a subscription as pending return:

  • Login to your circuly operations backend.
  • Go to Subscriptions > Select the subscription from the Subscription List that you want to mark the status as "pending return".
  • In the subscription detail window click on the three dots in the right corner > Click on Set status as pending return.

Screenshot of the subscriptions tab to show the set as pending return option


  • In the Set subscription to pending return window add a reason (if you want to) for setting the status as pending return (such as cancellation request made by the customer).

Screenshot of the  set as pending return window



  • OPTIONAL: Check the box for Delete future recurring payments.

Check the box if: You want to avoid charging the customer for the upcoming month while the customer is on the process of returning the product then you can check the box for Delete future recurring payments.

Keep the box unchecked if: You want to encourage the customer to return the product in time or else they might be charged for the next month.

  • Click on the CONFIRM button.

What happens now?

When the subscription status is set as "pending return" the return process is triggered.

The customer receives the "Subscription pending return" email from the Email Templates.

missing the answer to your question?

Fields marked with an asterisk (*) are required.
Thank you! Your submission has been received!

We are now hitting the keys to produce the content you are looking for. We will inform you once we are finished.  
Oops! Something went wrong while submitting the form.