Safe Haskell	None
Language	Haskell2010

Mollie.API.Subscriptions

Synopsis

subscriptionsPath :: Text
newSubscription :: Double -> Text -> Text -> NewSubscription
createCustomerSubscription :: Text -> NewSubscription -> Mollie (Either ResponseError Subscription)
getCustomerSubscription :: Text -> Text -> Mollie (Either ResponseError Subscription)
getCustomerSubscriptions :: Text -> Int -> Int -> Mollie (Either ResponseError (List Subscription))
cancelCustomerSubscription :: Text -> Text -> Mollie (Either ResponseError Subscription)
data PaymentMethod
- = Ideal
- | Creditcard
- | Mistercard
- | Sofort
- | Banktransfer
- | Directdebit
- | Belfius
- | Paypal
- | Bitcoin
- | Podiumcadeaukaart
- | Paysafecard
- | NewPaymentMethod Text
data NewSubscription = NewSubscription {
}
data SubscriptionStatus
data SubscriptionLinks = SubscriptionLinks {
- subscriptionLinks_webhookUrl :: Maybe Text
}
data Subscription = Subscription {
}
data ListLinks = ListLinks {
- listLinks_previous :: Maybe Text
- listLinks_next :: Maybe Text
- listLinks_first :: Maybe Text
- listLinks_last :: Maybe Text
}
data List a = List {
- list_totalCount :: Int
- list_offset :: Int
- list_count :: Int
- list_data :: [a]
- list_links :: Maybe ListLinks
}
data ResponseError
- = ClientError Int Error
- | ServerError Int
- | UnexpectedResponse

Documentation

subscriptionsPath :: Text Source #

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

newSubscription Source #

Arguments

:: Double	amount
-> Text	interval
-> Text	description
-> NewSubscription

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

The interval is in human readable format and support the following values: `1 day/n days`, `1 week/n weeks`, `1 month/n months` where n > 1.

createCustomerSubscription Source #

Arguments

:: Text	customerId
-> 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 Source #

Arguments

:: Text	customerId
-> Text	subscriptionId
-> 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 Source #

Arguments

:: Text	customerId
-> Int	offset
-> Int	count
-> 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 Source #

Arguments

:: Text	customerId
-> Text	subscriptionId
-> 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 Source #

All possible payment methods.

Constructors

Ideal
Creditcard
Mistercard
Sofort
Banktransfer
Directdebit
Belfius
Paypal
Bitcoin
Podiumcadeaukaart
Paysafecard
NewPaymentMethod Text

Instances

Eq PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods (==) :: PaymentMethod -> PaymentMethod -> Bool # (/=) :: PaymentMethod -> PaymentMethod -> Bool #
Read PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods readsPrec :: Int -> ReadS PaymentMethod # readList :: ReadS [PaymentMethod] # readPrec :: ReadPrec PaymentMethod # readListPrec :: ReadPrec [PaymentMethod] #
Show PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> PaymentMethod -> ShowS # show :: PaymentMethod -> String # showList :: [PaymentMethod] -> ShowS #
ToJSON PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: PaymentMethod -> Value # toEncoding :: PaymentMethod -> Encoding # toJSONList :: [PaymentMethod] -> Value # toEncodingList :: [PaymentMethod] -> Encoding #
FromJSON PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser PaymentMethod # parseJSONList :: Value -> Parser [PaymentMethod] #
ToText PaymentMethod Source #
Instance details Defined in Mollie.API.Types Methods toText :: PaymentMethod -> Text Source #

data NewSubscription Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> NewSubscription -> ShowS # show :: NewSubscription -> String # showList :: [NewSubscription] -> ShowS #
ToJSON NewSubscription Source #
Instance details Defined in Mollie.API.Types Methods toJSON :: NewSubscription -> Value # toEncoding :: NewSubscription -> Encoding # toJSONList :: [NewSubscription] -> Value # toEncodingList :: [NewSubscription] -> Encoding #

data SubscriptionStatus Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods (==) :: SubscriptionStatus -> SubscriptionStatus -> Bool # (/=) :: SubscriptionStatus -> SubscriptionStatus -> Bool #
Read SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods readsPrec :: Int -> ReadS SubscriptionStatus # readList :: ReadS [SubscriptionStatus] # readPrec :: ReadPrec SubscriptionStatus # readListPrec :: ReadPrec [SubscriptionStatus] #
Show SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> SubscriptionStatus -> ShowS # show :: SubscriptionStatus -> String # showList :: [SubscriptionStatus] -> ShowS #
FromJSON SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser SubscriptionStatus # parseJSONList :: Value -> Parser [SubscriptionStatus] #
ToText SubscriptionStatus Source #
Instance details Defined in Mollie.API.Types Methods toText :: SubscriptionStatus -> Text Source #

data SubscriptionLinks Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> SubscriptionLinks -> ShowS # show :: SubscriptionLinks -> String # showList :: [SubscriptionLinks] -> ShowS #
FromJSON SubscriptionLinks Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser SubscriptionLinks # parseJSONList :: Value -> Parser [SubscriptionLinks] #

data Subscription Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #
FromJSON Subscription Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser Subscription # parseJSONList :: Value -> Parser [Subscription] #

data ListLinks Source #

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 Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> ListLinks -> ShowS # show :: ListLinks -> String # showList :: [ListLinks] -> ShowS #
FromJSON ListLinks Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser ListLinks # parseJSONList :: Value -> Parser [ListLinks] #

data List a Source #

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) Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> List a -> ShowS # show :: List a -> String # showList :: [List a] -> ShowS #
FromJSON a => FromJSON (List a) Source #
Instance details Defined in Mollie.API.Types Methods parseJSON :: Value -> Parser (List a) # parseJSONList :: Value -> Parser [List a] #

data ResponseError Source #

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error
ServerError Int
UnexpectedResponse

Instances

Show ResponseError Source #
Instance details Defined in Mollie.API.Types Methods showsPrec :: Int -> ResponseError -> ShowS # show :: ResponseError -> String # showList :: [ResponseError] -> ShowS #