# Subscriptions

The Subscriptions API provides a powerful solution for managing recurring billing and subscription-based business models.

## Key Features[​](#key-features "Direct link to Key Features")

### Flexible Billing Options[​](#flexible-billing-options "Direct link to Flexible Billing Options")

* **Multiple billing intervals**: Daily, weekly, monthly, or yearly billing cycles
* **Custom intervals**: Configure non-standard periods using intervalCount (e.g., every 3 months)
* **Trial periods**: Offer free trials before the first billing cycle begins
* **Variable amounts**: Update subscription amounts for pricing changes or upgrades

### Complete Lifecycle Management[​](#complete-lifecycle-management "Direct link to Complete Lifecycle Management")

* **Create subscriptions**: Set up recurring billing plans with customizable parameters
* **Activate subscriptions**: Begin billing cycles with customer payment information
* **Pause/Resume**: Temporarily halt billing without cancellation
* **Update subscriptions**: Modify pricing, billing details, or subscription parameters
* **Cancel subscriptions**: End recurring billing permanently or at period end

### Customer-Friendly Features[​](#customer-friendly-features "Direct link to Customer-Friendly Features")

* **Automated recurring payments**: No manual action required for subsequent billing
* **Consistent billing dates**: Predictable billing on the same day of each period
* **Payment retry mechanism**: Automatic retries for failed payments
* **Customer control**: Enable customers to manage their own subscriptions

### Integration Benefits[​](#integration-benefits "Direct link to Integration Benefits")

* **Webhook notifications**: Get real-time updates on subscription status changes
* **Detailed reporting**: Track subscription metrics and performance
* **Simplified compliance**: Handle recurring billing requirements automatically
* **Reduced churn**: Automatic billing helps prevent missed payments

## Testing[​](#testing "Direct link to Testing")

### Test Mode Limitations[​](#test-mode-limitations "Direct link to Test Mode Limitations")

* **Active subscription limit**: In test mode, you can have only three active subscriptions at any time
* **Automatic cancellation**: All subscriptions are automatically canceled after twelve payments (except when using the 5565 test card)

### Test Mode Intervals[​](#test-mode-intervals "Direct link to Test Mode Intervals")

* **Minute and hour intervals**: Only available in test mode for rapid testing of subscription cycles

### Testing Failed Payments[​](#testing-failed-payments "Direct link to Testing Failed Payments")

For testing subscription payment failures, use a test card with the following characteristics:

* **Test card ending in 5565**: Use test card that ending in 5565 (see [Test card numbers](https://docs.monei.com/testing/#test-card-numbers))

* **Payment behavior**:

  <!-- -->

  * The first payment for the subscription will be successful
  * All subsequent payments will fail
  * After the first failed payment, the subscription status changes to `Past due`
  * After three consecutive failed payments, the subscription will be automatically cancelled

<!-- -->

## [📄️Create Subscription](https://docs.monei.com/apis/rest/subscriptions-create/.md)

[Creates a new subscription with the specified parameters.](https://docs.monei.com/apis/rest/subscriptions-create/.md)

## [📄️Get Subscription](https://docs.monei.com/apis/rest/subscriptions-get/.md)

[Retrieves the complete details of an existing subscription by its unique ID.](https://docs.monei.com/apis/rest/subscriptions-get/.md)

## [📄️Update Subscription](https://docs.monei.com/apis/rest/subscriptions-update/.md)

[Updates the configuration of an existing subscription.](https://docs.monei.com/apis/rest/subscriptions-update/.md)

## [📄️Activate Subscription](https://docs.monei.com/apis/rest/subscriptions-activate/.md)

[Activates a subscription by attaching a payment method and initiating the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-activate/.md)

## [📄️Cancel Subscription](https://docs.monei.com/apis/rest/subscriptions-cancel/.md)

[Cancels an active subscription, permanently stopping the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-cancel/.md)

## [📄️Pause Subscription](https://docs.monei.com/apis/rest/subscriptions-pause/.md)

[Pauses an active subscription, temporarily halting the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-pause/.md)

## [📄️Resume Subscription](https://docs.monei.com/apis/rest/subscriptions-resume/.md)

[Resumes a previously paused subscription, reactivating the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-resume/.md)

## [📄️Send Subscription Link](https://docs.monei.com/apis/rest/subscriptions-send-link/.md)

[Sends a subscription activation link to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/subscriptions-send-link/.md)

## [📄️Send Subscription Status](https://docs.monei.com/apis/rest/subscriptions-send-status/.md)

[Sends subscription status information to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/subscriptions-send-status/.md)
