Recurring payments with plans and subscriptions
The Clover recurring payments feature is supported by the Plan and Subscriptions APIs. Merchants and developers can set up automated, recurring charges at various intervals, including monthly and weekly. This supports both:
- Fixed-term payments—Ideal for installment plans, such as a six-month payment schedule.
- Ongoing subscriptions—Designed for continuous services, like streaming platforms. The Clover system automatically generates and processes invoices on the scheduled billing dates.
Recurring payments configuration
Recurring payment configuration allows merchants to create plans and subscriptions.
- Plans—Use the Plans API to create multiple plans for merchants. You can define billing cycles and amounts for recurring payments.
- Subscriptions—Use the Subscriptions API to associate customers with specific plans, including billing details, start dates, and intervals.
Get started
Recurring payments API—Configure Plans
Facilitates the creation and management of recurring payment plans for merchants, enabling them to offer subscription-based services to their customers.
Recurring payments API—Configure Subscription
Allows merchants to create and manage subscriptions through their Clover Merchant Dashboard. You can use the Subscriptions API to create, retrieve, edit, and cancel and delete subscriptions.
How it works
Key features
- Set the payment date—Specify the date when a payment is sent.
- Change the payment interval—Adjust intervals after creating a plan. For example, a monthly payment starting on February 1 will continue on the 1st of each subsequent month.
- Deactivate plans and subscriptions—Cancel a plan or subscription without deleting it.
Save card-on-file for customers
- Save card-on-file—You can use Clover REST APIs to save customer card details for scheduled payments. Requires OAuth token, merchantId, customerId, and a card token. A card token is generated in two ways:
- Clover Ecommerce APIs—Generate an OAuth token for authorization and a PAKMS key to create a card token. You can use the card token as the
source
to save a card-on-file record for the customer. This method offers flexibility but requires adherence to stringent PCI DSS compliance standards. - Clover iframe—You can embed the customizable iframe in your app or ecommerce website to securely provide card data to the Clover servers. This has a low PCI burden for your merchants.
- Clover Ecommerce APIs—Generate an OAuth token for authorization and a PAKMS key to create a card token. You can use the card token as the
- Automated notifications—When a card-on-file is saved, the Clover automated notification system sends customizable email and SMS reminders about upcoming charges, failed payments, and subscription renewals, ensuring transparency and minimizing disruptions.
- Card-on-file removal on request—Customers can request the removal of their card-on-file from Clover systems.
- Alternative to automated flows—If you prefer not to use Clover's automated flows, you can create multi-pay tokens for multiple payments after an initial transaction. You'll need to manage their storage and usage, including customer profiles, stored credentials, and payment details within your platform. For more information, see Create a multi-pay token.
Quick steps to create recurring plans and subscriptions for the plans
Step | Action | Endpoint/Dashboard | REST API used | Description |
---|---|---|---|---|
1. | Generate test merchant API token or OAuth access token | Merchant Dashboard | Platform | Get an OAuth token for authorization. |
2. | Create a plan | /recurring/v1/plans | Platform | Define a plan with a billing cycle and amount for a merchant. |
3. | Generate a public and private token | Merchant Dashboard | Ecommerce | - Use the private token as the Bearer token in the Authorization header to use the Ecommerce APIs. - Use the public token as the Ecommerce API key or apiAccessKey for cards, gift cards, or ACH tokenization. |
4. | Generate an Ecommerce API key (PAKMS key) | /getapikey | Ecommerce | Use the Ecommerce API token to generate a PAKMS key to identify the merchant during card tokenization. |
5. | Create a card token | /v1/tokens | Ecommerce | Generate a card token using customer card details to use as the source to create a card-on-file (COF). |
4. | Save a card-on-file (COF) for a customer. | /v1/customers | Ecommerce | Save the card token to the customer's profile. This is used as the source to charge the subscription. |
6. | Create a subscription | /recurring/v1/plans/ {planId}/subscriptions | Platform | Create a subscription associating the customer with the plan. |
Restrictions
Recurring payment configurations and related APIs are not available for Health Insurance Portability and Accountability Act (HIPAA) merchants.
Watch video: Recurring payments
Watch | Learn |
---|---|
|
In this video, learn:
|
Updated 8 days ago