# Subscriptions

The subscriptions API allows you to automatically have Ryft schedule and charge recurring payments for a specific day and time. This API is not required to process recurring payments. After additional configuration, you can use our payment-sessions API to create and charge the recurring payments yourself.


## Creates a new subscription

 - [POST /subscriptions](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptioncreate.md): Use to create a Subscription (whereby Ryft manage the automatic scheduling and billing of a recurring payment series)

## List subscriptions

 - [GET /subscriptions](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptionslist.md): Used to fetch a paginated list of subscriptions

## Retrieve a subscription by Id

 - [GET /subscriptions/{subscriptionId}](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptiongetbyid.md): This is used to fetch a subscription by its unique Id

## Updates a subscription by Id

 - [PATCH /subscriptions/{subscriptionId}](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptionupdatebyid.md): Use to update a Subscription. Cannot be used if the Subscription is Cancelled or Ended.

## Pause a subscription by Id

 - [PATCH /subscriptions/{subscriptionId}/pause](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptionpausebyid.md): Used to schedule a pause for a Subscription. Only 'Active' subscriptions can be paused, though the details for already 'Paused' subscriptions can also be edited. The subscription will remain in 'Active' and will be moved to 'Paused' when it was next due to be billed. The reason or duration of the pause can be edited by calling this endpoint again, even after it has moved to 'Paused'. After a pause is scheduled but whilst still in 'Active', the pause can be unscheduled via the 'unschedule' flag.

## Resume a subscription by Id

 - [PATCH /subscriptions/{subscriptionId}/resume](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptionresumebyid.md): Use to resume a paused Subscription.

## Cancel a subscription by Id

 - [DELETE /subscriptions/{subscriptionId}/cancel](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptioncancelbyid.md): Cancel a subscription by its unique Id. This will immediately move the subscription to Cancelled and stop billing the customer. This state is terminal and cannot be reversed.

## Retrieve a list of the payments specific to a subscription

 - [GET /subscriptions/{subscriptionId}/payment-sessions](https://developer.ryftpay.com/documentation/api/reference/openapi/subscriptions/subscriptionslistpaymentsessions.md): Used to fetch a paginated list of the payment sessions making up the subscription