recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Types.SubscriptionCancel

Description

Contains the types generated from the schema SubscriptionCancel

Synopsis

Documentation

data SubscriptionCancel Source #

Defines the object schema located at components.schemas.SubscriptionCancel in the specification.

Constructors

SubscriptionCancel 

Fields

  • subscriptionCancelTimeframe :: Maybe SubscriptionCancelTimeframe

    timeframe: The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.

mkSubscriptionCancel :: SubscriptionCancel Source #

Create a new SubscriptionCancel with all required fields.

data SubscriptionCancelTimeframe Source #

Defines the enum schema located at components.schemas.SubscriptionCancel.properties.timeframe in the specification.

The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.

Constructors

SubscriptionCancelTimeframeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionCancelTimeframeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionCancelTimeframeEnumBill_date

Represents the JSON value "bill_date"

SubscriptionCancelTimeframeEnumTerm_end

Represents the JSON value "term_end"