be.feelio.mollie.handler

Class SubscriptionHandler

java.lang.Object

be.feelio.mollie.handler.AbstractHandler

be.feelio.mollie.handler.SubscriptionHandler

public class SubscriptionHandler
extends AbstractHandler

Handles the Subscriptions API Mollie docs

Author:

Wout Schoovaerts

Constructor Summary

Constructors

Constructor and Description
SubscriptionHandler(String baseUrl)

Method Summary

Modifier and Type	Method and Description
SubscriptionResponse	cancelSubscription(String customerId, String subscriptionId) Cancel a subscription
SubscriptionResponse	cancelSubscription(String customerId, String subscriptionId, QueryParams params) Cancel a subscription
SubscriptionResponse	createSubscription(String customerId, SubscriptionRequest body) With subscriptions, you can schedule recurring payments to take place at regular intervals.
SubscriptionResponse	createSubscription(String customerId, SubscriptionRequest body, QueryParams params) With subscriptions, you can schedule recurring payments to take place at regular intervals.
SubscriptionResponse	getSubscription(String customerId, String subscriptionId) Retrieve a subscription by its ID and its customer’s ID.
SubscriptionResponse	getSubscription(String customerId, String subscriptionId, QueryParams params) Retrieve a subscription by its ID and its customer’s ID.
Pagination<PaymentListResponse>	listSubscriptionPayments(String customerId, String subscriptionId) Retrieve all payments of a specific subscriptions of a customer.
Pagination<PaymentListResponse>	listSubscriptionPayments(String customerId, String subscriptionId, QueryParams params) Retrieve all payments of a specific subscriptions of a customer.
Pagination<SubscriptionListResponse>	listSubscriptions(String customerId) Retrieve all subscriptions of a customer.
Pagination<SubscriptionListResponse>	listSubscriptions(String customerId, QueryParams params) Retrieve all subscriptions of a customer.
SubscriptionResponse	updateSubscription(String customerId, String subscriptionId, UpdateSubscriptionRequest body) Update a subscription.
SubscriptionResponse	updateSubscription(String customerId, String subscriptionId, UpdateSubscriptionRequest body, QueryParams params) Update a subscription.

Methods inherited from class be.feelio.mollie.handler.AbstractHandler

delete, delete, delete, get, get, patch, patch, post, post, postWithoutBody, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionHandler

public SubscriptionHandler(String baseUrl)

Method Detail

createSubscription

public SubscriptionResponse createSubscription(String customerId,
                                               SubscriptionRequest body)
                                        throws MollieException

With subscriptions, you can schedule recurring payments to take place at regular intervals.

Parameters:

customerId - a customer id

body - SubscriptionRequest object

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

createSubscription

public SubscriptionResponse createSubscription(String customerId,
                                               SubscriptionRequest body,
                                               QueryParams params)
                                        throws MollieException

With subscriptions, you can schedule recurring payments to take place at regular intervals.

Parameters:

customerId - a customer id

body - SubscriptionRequest object

params - A map of query parameters

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

getSubscription

public SubscriptionResponse getSubscription(String customerId,
                                            String subscriptionId)
                                     throws MollieException

Retrieve a subscription by its ID and its customer’s ID.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

getSubscription

public SubscriptionResponse getSubscription(String customerId,
                                            String subscriptionId,
                                            QueryParams params)
                                     throws MollieException

Retrieve a subscription by its ID and its customer’s ID.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

params - A map of query parameters

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

cancelSubscription

public SubscriptionResponse cancelSubscription(String customerId,
                                               String subscriptionId)
                                        throws MollieException

Cancel a subscription

Parameters:

customerId - a customer id

subscriptionId - a subscription id

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

cancelSubscription

public SubscriptionResponse cancelSubscription(String customerId,
                                               String subscriptionId,
                                               QueryParams params)
                                        throws MollieException

Cancel a subscription

Parameters:

customerId - a customer id

subscriptionId - a subscription id

params - A map of query parameters

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

listSubscriptions

public Pagination<SubscriptionListResponse> listSubscriptions(String customerId)
                                                       throws MollieException

Retrieve all subscriptions of a customer.

Parameters:

customerId - a customer id

Returns:

paginated list of Subscription objects

Throws:

MollieException - when something went wrong

listSubscriptions

public Pagination<SubscriptionListResponse> listSubscriptions(String customerId,
                                                              QueryParams params)
                                                       throws MollieException

Retrieve all subscriptions of a customer.

Parameters:

customerId - a customer id

params - A map of query parameters

Returns:

paginated list of Subscription objects

Throws:

MollieException - when something went wrong

listSubscriptionPayments

public Pagination<PaymentListResponse> listSubscriptionPayments(String customerId,
                                                                String subscriptionId)
                                                         throws MollieException

Retrieve all payments of a specific subscriptions of a customer.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

Returns:

paginated list of PaymentResponse objects

Throws:

MollieException - when something went wrong

listSubscriptionPayments

public Pagination<PaymentListResponse> listSubscriptionPayments(String customerId,
                                                                String subscriptionId,
                                                                QueryParams params)
                                                         throws MollieException

Retrieve all payments of a specific subscriptions of a customer.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

params - A map of query parameters

Returns:

paginated list of PaymentResponse objects

Throws:

MollieException - when something went wrong

updateSubscription

public SubscriptionResponse updateSubscription(String customerId,
                                               String subscriptionId,
                                               UpdateSubscriptionRequest body)
                                        throws MollieException

Update a subscription.

You cannot update a canceled subscription.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

body - UpdateSubscriptionRequest object

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong

updateSubscription

public SubscriptionResponse updateSubscription(String customerId,
                                               String subscriptionId,
                                               UpdateSubscriptionRequest body,
                                               QueryParams params)
                                        throws MollieException

Update a subscription.

You cannot update a canceled subscription.

Parameters:

customerId - a customer id

subscriptionId - a subscription id

body - UpdateSubscriptionRequest object

params - A map of query parameters

Returns:

SubscriptionResponse object

Throws:

MollieException - when something went wrong