Use Case: Create a Recurring Payment (Subscription)

Owned by Miles Graves
Feb 09, 2024
3 min read

You can set up a customized recurring subscription payment for your customers in the Portal. This tutorial walks you through the steps to create a new recurring payment with a new or saved payment method.

Partial view of the Plans page.

Objective

Create a new recurring subscription payment plan for one of your customers or cardholders.

Audience

  • Merchants

Environment

  • Portal (Sandbox)

  • Portal (Production)

Prerequisites

Prerequisites

You must have a fully boarded account to perform any of the actions described in this use case guide.

Warnings

Warnings will provide insight or advice to avoid risk, visibility, and overall product performance issues during this use case.

Warning: If you are creating a recurring payment using a token that you have already saved in the portal, you must copy and paste the token ID so that the number is accessible while you are following the guide. We suggest that you copy the token ID to a blank text or notepad file that can stay open while you fill in the forms to create the new recurring payment.

Create a Recurring Payment

1. Access the Plans Page

  • Step 1: Click RECURRING PAYMENTS under the Payments category in the left-hand navigation panel to open a drop-down menu in the panel.

  • Step 2: Click PLANS in the Recurring Payments drop-down menu to open the Plans page.

2. Create a New Plan

  • Step 1: Click the ADD PLAN button in the upper right-hand corner of the page to open the Add Plan lightbox on the page.

  • Step 2: Enter the plan name and the amount. Add a number value and interval for the payment schedule.

  • Step 3 (Optional): Enter a description and the maximum number of times the payment is attempted and fails before auto-canceling the plan.

  • Step 4: Click ADD to save the new plan.

Result: The new plan is now visible in the table on the Plans page.

3. Add a Subscription

  • Step 1: Locate the new plan in the table on the Plans page and click any information to open the Plan Details page.

  • Step 2: Click the ADD SUBSCRIPTION button in the upper right-hand corner of the page to open the Add Subscription lightbox on the page.

  • Step 3: Enter the start date and optional end date.

  • Step 4: Enter the email address of the customer or cardholder who pays the recurring payment.

  • Step 5 (Optional): Enter any tax amount, the maximum number of consecutive failures, and a description.

  • Step 6: Enter the payment information. You can enter a new credit or debit card, or use a token for an existing payment saved in your Payrix account. Note that if you use a token, you must have the token number ready to paste into the form (see the Warning above the instructions).

To use a new payment method, click ENTER CARD DETAILS to open the Card Details lightbox. Enter the credit or debit card information in the form, and click SAVE PAYMENT to return to the Add Subscription lightbox.

To use a token from an existing payment, click CREATE WITH TOKEN, and the Token field displays on the page. Copy and paste the token into the open field.

  • Step 7: Click ADD to save the subscription to the plan.

Result: The new plan charges the customer or cardholder at regular, recurring intervals.

Next Steps

Once the recurring payment is created, review the following guides for additional information on related topics:

  • Add a New Product (Item): Create a new product that you can include in your payment page by following the instructions in the Add a New Product (Item) guide.

  • Create a Static Payment Page: You can set up a payment page and share it with customers by following the instructions in the Create a Static Payment Page guide.

Conclusion

The recurring payment is now active.

References

Click the links or items below to access any of the following pages:

Â