Mollie.API.Subscriptions

Documentation

subscriptionsPath :: Text

Subscriptions resource's path, relative to API's versioned customer resource url.

newSubscription :: Double -> Text -> Text -> NewSubscription

Helper to create a minimal new subscription. Defaults to an ongoing subscription.

createCustomerSubscription :: Text -> NewSubscription -> Mollie (Either ResponseError Subscription)

Handler to create a new subscription for a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/create.

getCustomerSubscription :: Text -> Text -> Mollie (Either ResponseError Subscription)

Handler to get a subscription by its identifier from a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/get.

getCustomerSubscriptions :: Text -> Int -> Int -> Mollie (Either ResponseError (List Subscription))

Handler to get a list of subscriptions for a specific customer. Because the list endpoint is paginated this handler requires an offset and a count. The maximum amount of subscriptions returned with a single call is 250.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/list.

cancelCustomerSubscription :: Text -> Text -> Mollie (Either ResponseError Subscription)

Handler to cancel a subscription by its identifier for a specific customer.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/delete.

data PaymentMethod

All possible payment methods.

Constructors

Ideal

Creditcard

Mistercard

Sofort

Banktransfer

Directdebit

Belfius

Paypal

Bitcoin

Podiumcadeaukaart

Paysafecard

NewPaymentMethod Text

Instances

Eq PaymentMethod

Methods

(==) :: PaymentMethod -> PaymentMethod -> Bool

(/=) :: PaymentMethod -> PaymentMethod -> Bool

Read PaymentMethod

Methods

readsPrec :: Int -> ReadS PaymentMethod

readList :: ReadS [PaymentMethod]

readPrec :: ReadPrec PaymentMethod

readListPrec :: ReadPrec [PaymentMethod]

Show PaymentMethod

Methods

showsPrec :: Int -> PaymentMethod -> ShowS

show :: PaymentMethod -> String

showList :: [PaymentMethod] -> ShowS

ToJSON PaymentMethod

Methods

toJSON :: PaymentMethod -> Value

toEncoding :: PaymentMethod -> Encoding

FromJSON PaymentMethod

Methods

parseJSON :: Value -> Parser PaymentMethod

ToText PaymentMethod

Methods

toText :: PaymentMethod -> Text

data NewSubscription

Structure to request a new subscription with.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/create.

Constructors

NewSubscription

Fields

• newSubscription_amount :: Double

  Set the constant amount in EURO you want to charge with each payment.

• newSubscription_times :: Maybe Int

  Set the total number of charges for the subscription to complete. Leave empty for ongoing subscriptions.

• newSubscription_interval :: Text

  Set the interval to wait between charges like `1 month(s)`, `2 weeks` or `14 days`.

• newSubscription_description :: Text

  Set the description which will be included in the payment description along with the carge date in `Y-m-d` format.

• newSubscription_method :: Maybe PaymentMethod

  Force the payment method, leave empty to use one of the customers valid mandates.

• newSubscription_webhookUrl :: Maybe Text

  Set a webhook URL for all subscription payments.

Instances

Show NewSubscription

Methods

showsPrec :: Int -> NewSubscription -> ShowS

show :: NewSubscription -> String

showList :: [NewSubscription] -> ShowS

ToJSON NewSubscription

Methods

toJSON :: NewSubscription -> Value

toEncoding :: NewSubscription -> Encoding

data SubscriptionStatus

All possible statusses a subscription could be assigned.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/get.

Constructors

SubscriptionPending

SubscriptionActive

SubscriptionCancelled

SubscriptionSuspended

SubscriptionCompleted

Instances

Eq SubscriptionStatus

Methods

(==) :: SubscriptionStatus -> SubscriptionStatus -> Bool

(/=) :: SubscriptionStatus -> SubscriptionStatus -> Bool

Read SubscriptionStatus

Methods

readsPrec :: Int -> ReadS SubscriptionStatus

readList :: ReadS [SubscriptionStatus]

readPrec :: ReadPrec SubscriptionStatus

readListPrec :: ReadPrec [SubscriptionStatus]

Show SubscriptionStatus

Methods

showsPrec :: Int -> SubscriptionStatus -> ShowS

show :: SubscriptionStatus -> String

showList :: [SubscriptionStatus] -> ShowS

FromJSON SubscriptionStatus

Methods

parseJSON :: Value -> Parser SubscriptionStatus

ToText SubscriptionStatus

Methods

toText :: SubscriptionStatus -> Text

data SubscriptionLinks

Important links used for a subscription.

Constructors

SubscriptionLinks

Fields

• subscriptionLinks_webhookUrl :: Maybe Text

  The webhook URL used for payment made with this subscription.

Instances

Show SubscriptionLinks

Methods

showsPrec :: Int -> SubscriptionLinks -> ShowS

show :: SubscriptionLinks -> String

showList :: [SubscriptionLinks] -> ShowS

FromJSON SubscriptionLinks

Methods

parseJSON :: Value -> Parser SubscriptionLinks

data Subscription

Representation of a subscription available at Mollie.

For more information see: https://www.mollie.com/en/docs/reference/subscriptions/get.

Constructors

Subscription

Fields

• subscription_id :: Text

  Mollies reference to the subscription.

• subscription_customerId :: Text

  The reference to the customer this subscription was made for.

• subscription_mode :: Mode

  The mode used to create this subscription

• subscription_createdDatetime :: UTCTime

  The date on which this subscription was created.

• subscription_status :: SubscriptionStatus

  The subscriptions status.

• subscription_amount :: Text

  The amount of EURO charged with each payment for this subscription.

• subscription_times :: Maybe Int

  The total number or charges for the subscription to complete.

• subscription_interval :: Text

  The interval to wait between charges.

• subscription_description :: Text

  The description for the payments made with this subscription.

• subscription_method :: Maybe PaymentMethod

  The payment method used for this subscription.

• subscription_cancelledDatetime :: Maybe UTCTime

  The date on which this subscription was cancelled.

• subscription_links :: SubscriptionLinks

  Important links used for this subscription.

Instances

Show Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

FromJSON Subscription

Methods

parseJSON :: Value -> Parser Subscription

data ListLinks

Important links associated with List responses.

Constructors

ListLinks

Fields

• listLinks_previous :: Maybe Text

  URL to previous list.

• listLinks_next :: Maybe Text

  URL to next list.

• listLinks_first :: Maybe Text

  URL to first list.

• listLinks_last :: Maybe Text

  URL to last list.

Instances

Show ListLinks

Methods

showsPrec :: Int -> ListLinks -> ShowS

show :: ListLinks -> String

showList :: [ListLinks] -> ShowS

FromJSON ListLinks

Methods

parseJSON :: Value -> Parser ListLinks

data List a

List response for any resource with metadata.

For more information see: https://www.mollie.com/nl/docs/reference/payments/list.

Constructors

List

Fields

• list_totalCount :: Int

  Total number of resources available.

• list_offset :: Int

  The number of skipped resources.

• list_count :: Int

  The number of resources found in `data`.

• list_data :: [a]

  The resources for this request.

• list_links :: Maybe ListLinks

  Important links for this list.

Instances

Show a => Show (List a)

Methods

showsPrec :: Int -> List a -> ShowS

show :: List a -> String

showList :: [List a] -> ShowS

FromJSON a0 => FromJSON (List a0)

Methods

parseJSON :: Value -> Parser (List a0)

data ResponseError

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error

ServerError Int

UnexpectedResponse

Instances

Show ResponseError

Methods

showsPrec :: Int -> ResponseError -> ShowS

show :: ResponseError -> String

showList :: [ResponseError] -> ShowS