Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.Coupon

Description

Contains the types generated from the schema Coupon

Synopsis

data Coupon = Coupon {
- couponApplies_to_all_items :: Maybe Bool
- couponApplies_to_all_plans :: Maybe Bool
- couponApplies_to_non_plan_charges :: Maybe Bool
- couponCode :: Maybe Text
- couponCoupon_type :: Maybe CouponCoupon_type
- couponCreated_at :: Maybe JsonDateTime
- couponDiscount :: Maybe CouponDiscount
- couponDuration :: Maybe CouponDuration
- couponExpired_at :: Maybe JsonDateTime
- couponFree_trial_amount :: Maybe Int
- couponFree_trial_unit :: Maybe CouponFree_trial_unit
- couponHosted_page_description :: Maybe Text
- couponId :: Maybe Text
- couponInvoice_description :: Maybe Text
- couponItems :: Maybe [ItemMini]
- couponMax_redemptions :: Maybe Int
- couponMax_redemptions_per_account :: Maybe Int
- couponName :: Maybe Text
- couponObject :: Maybe Text
- couponPlans :: Maybe [PlanMini]
- couponRedeem_by :: Maybe JsonDateTime
- couponRedemption_resource :: Maybe CouponRedemption_resource
- couponState :: Maybe CouponState
- couponTemporal_amount :: Maybe Int
- couponTemporal_unit :: Maybe CouponTemporal_unit
- couponUnique_code_template :: Maybe Text
- couponUnique_coupon_code :: Maybe CouponUnique_coupon_code
- couponUnique_coupon_codes_count :: Maybe Int
- couponUpdated_at :: Maybe JsonDateTime
}
mkCoupon :: Coupon
data CouponCoupon_type
data CouponDuration
data CouponFree_trial_unit
data CouponRedemption_resource
data CouponState
data CouponTemporal_unit
data CouponUnique_coupon_code = CouponUnique_coupon_code {
}
mkCouponUnique_coupon_code :: CouponUnique_coupon_code
data CouponUnique_coupon_codeState

Documentation

data Coupon Source #

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

Constructors

Coupon

Fields

couponApplies_to_all_items :: Maybe Bool
applies_to_all_items: The coupon is valid for all items if true. If false then `items` will list the applicable items.
couponApplies_to_all_plans :: Maybe Bool
applies_to_all_plans: The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
couponApplies_to_non_plan_charges :: Maybe Bool
applies_to_non_plan_charges: The coupon is valid for one-time, non-plan charges if true.
couponCode :: Maybe Text
code: The code the customer enters to redeem the coupon.
couponCoupon_type :: Maybe CouponCoupon_type
coupon_type: Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
couponCreated_at :: Maybe JsonDateTime
created_at
couponDiscount :: Maybe CouponDiscount
discount: Details of the discount a coupon applies. Will contain a `type` property and one of the following properties: `percent`, `fixed`, `trial`.
couponDuration :: Maybe CouponDuration
duration: - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
couponExpired_at :: Maybe JsonDateTime
expired_at: The date and time the coupon was expired early or reached its `max_redemptions`.
couponFree_trial_amount :: Maybe Int
free_trial_amount: Sets the duration of time the `free_trial_unit` is for.
Constraints:
- Maxium of 9999.0
- Minimum of 1.0
couponFree_trial_unit :: Maybe CouponFree_trial_unit
free_trial_unit: Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
couponHosted_page_description :: Maybe Text
hosted_page_description: This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
couponId :: Maybe Text
id
couponInvoice_description :: Maybe Text
invoice_description: Description of the coupon on the invoice.
Constraints:
- Maximum length of 255
couponItems :: Maybe [ItemMini]
items: A list of items for which this coupon applies. This will be `null` if `applies_to_all_items=true`.
couponMax_redemptions :: Maybe Int
max_redemptions: A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
couponMax_redemptions_per_account :: Maybe Int
max_redemptions_per_account: Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
couponName :: Maybe Text
name: The internal name for the coupon.
couponObject :: Maybe Text
object
couponPlans :: Maybe [PlanMini]
plans: A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
couponRedeem_by :: Maybe JsonDateTime
redeem_by: The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
couponRedemption_resource :: Maybe CouponRedemption_resource
redemption_resource: Whether the discount is for all eligible charges on the account, or only a specific subscription.
couponState :: Maybe CouponState
state: Indicates if the coupon is redeemable, and if it is not, why.
couponTemporal_amount :: Maybe Int
temporal_amount: If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
couponTemporal_unit :: Maybe CouponTemporal_unit
temporal_unit: If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
couponUnique_code_template :: Maybe Text
unique_code_template: On a bulk coupon, the template from which unique coupon codes are generated.
couponUnique_coupon_code :: Maybe CouponUnique_coupon_code
unique_coupon_code: Will be populated when the Coupon being returned is a `UniqueCouponCode`.
couponUnique_coupon_codes_count :: Maybe Int
unique_coupon_codes_count: When this number reaches `max_redemptions` the coupon will no longer be redeemable.
couponUpdated_at :: Maybe JsonDateTime
updated_at

Instances

Instances details

FromJSON Coupon Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser Coupon # parseJSONList :: Value -> Parser [Coupon] #
ToJSON Coupon Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: Coupon -> Value # toEncoding :: Coupon -> Encoding # toJSONList :: [Coupon] -> Value # toEncodingList :: [Coupon] -> Encoding #
Show Coupon Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> Coupon -> ShowS # show :: Coupon -> String # showList :: [Coupon] -> ShowS #
Eq Coupon Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: Coupon -> Coupon -> Bool # (/=) :: Coupon -> Coupon -> Bool #

mkCoupon :: Coupon Source #

Create a new Coupon with all required fields.

data CouponCoupon_type Source #

Defines the enum schema located at components.schemas.Coupon.properties.coupon_type in the specification.

Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.

Constructors

CouponCoupon_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponCoupon_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponCoupon_typeEnumBulk	Represents the JSON value `"bulk"`
CouponCoupon_typeEnumSingle_code	Represents the JSON value `"single_code"`

Instances

Instances details

FromJSON CouponCoupon_type Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponCoupon_type # parseJSONList :: Value -> Parser [CouponCoupon_type] #
ToJSON CouponCoupon_type Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponCoupon_type -> Value # toEncoding :: CouponCoupon_type -> Encoding # toJSONList :: [CouponCoupon_type] -> Value # toEncodingList :: [CouponCoupon_type] -> Encoding #
Show CouponCoupon_type Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponCoupon_type -> ShowS # show :: CouponCoupon_type -> String # showList :: [CouponCoupon_type] -> ShowS #
Eq CouponCoupon_type Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponCoupon_type -> CouponCoupon_type -> Bool # (/=) :: CouponCoupon_type -> CouponCoupon_type -> Bool #

data CouponDuration Source #

Defines the enum schema located at components.schemas.Coupon.properties.duration in the specification.

"single_use" coupons applies to the first invoice only.
"temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.

Constructors

CouponDurationOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponDurationTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponDurationEnumForever	Represents the JSON value `"forever"`
CouponDurationEnumSingle_use	Represents the JSON value `"single_use"`
CouponDurationEnumTemporal	Represents the JSON value `"temporal"`

Instances

Instances details

FromJSON CouponDuration Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponDuration # parseJSONList :: Value -> Parser [CouponDuration] #
ToJSON CouponDuration Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponDuration -> Value # toEncoding :: CouponDuration -> Encoding # toJSONList :: [CouponDuration] -> Value # toEncodingList :: [CouponDuration] -> Encoding #
Show CouponDuration Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponDuration -> ShowS # show :: CouponDuration -> String # showList :: [CouponDuration] -> ShowS #
Eq CouponDuration Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponDuration -> CouponDuration -> Bool # (/=) :: CouponDuration -> CouponDuration -> Bool #

data CouponFree_trial_unit Source #

Defines the enum schema located at components.schemas.Coupon.properties.free_trial_unit in the specification.

Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.

Constructors

CouponFree_trial_unitOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponFree_trial_unitTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponFree_trial_unitEnumDay	Represents the JSON value `"day"`
CouponFree_trial_unitEnumMonth	Represents the JSON value `"month"`
CouponFree_trial_unitEnumWeek	Represents the JSON value `"week"`

Instances

Instances details

FromJSON CouponFree_trial_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponFree_trial_unit # parseJSONList :: Value -> Parser [CouponFree_trial_unit] #
ToJSON CouponFree_trial_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponFree_trial_unit -> Value # toEncoding :: CouponFree_trial_unit -> Encoding # toJSONList :: [CouponFree_trial_unit] -> Value # toEncodingList :: [CouponFree_trial_unit] -> Encoding #
Show CouponFree_trial_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponFree_trial_unit -> ShowS # show :: CouponFree_trial_unit -> String # showList :: [CouponFree_trial_unit] -> ShowS #
Eq CouponFree_trial_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponFree_trial_unit -> CouponFree_trial_unit -> Bool # (/=) :: CouponFree_trial_unit -> CouponFree_trial_unit -> Bool #

data CouponRedemption_resource Source #

Defines the enum schema located at components.schemas.Coupon.properties.redemption_resource in the specification.

Whether the discount is for all eligible charges on the account, or only a specific subscription.

Constructors

CouponRedemption_resourceOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponRedemption_resourceTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponRedemption_resourceEnumAccount	Represents the JSON value `"account"`
CouponRedemption_resourceEnumSubscription	Represents the JSON value `"subscription"`

Instances

Instances details

FromJSON CouponRedemption_resource Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponRedemption_resource # parseJSONList :: Value -> Parser [CouponRedemption_resource] #
ToJSON CouponRedemption_resource Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponRedemption_resource -> Value # toEncoding :: CouponRedemption_resource -> Encoding # toJSONList :: [CouponRedemption_resource] -> Value # toEncodingList :: [CouponRedemption_resource] -> Encoding #
Show CouponRedemption_resource Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponRedemption_resource -> ShowS # show :: CouponRedemption_resource -> String # showList :: [CouponRedemption_resource] -> ShowS #
Eq CouponRedemption_resource Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponRedemption_resource -> CouponRedemption_resource -> Bool # (/=) :: CouponRedemption_resource -> CouponRedemption_resource -> Bool #

data CouponState Source #

Defines the enum schema located at components.schemas.Coupon.properties.state in the specification.

Indicates if the coupon is redeemable, and if it is not, why.

Constructors

CouponStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponStateEnumExpired	Represents the JSON value `"expired"`
CouponStateEnumMaxed_out	Represents the JSON value `"maxed_out"`
CouponStateEnumRedeemable	Represents the JSON value `"redeemable"`

Instances

Instances details

FromJSON CouponState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponState # parseJSONList :: Value -> Parser [CouponState] #
ToJSON CouponState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponState -> Value # toEncoding :: CouponState -> Encoding # toJSONList :: [CouponState] -> Value # toEncodingList :: [CouponState] -> Encoding #
Show CouponState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponState -> ShowS # show :: CouponState -> String # showList :: [CouponState] -> ShowS #
Eq CouponState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponState -> CouponState -> Bool # (/=) :: CouponState -> CouponState -> Bool #

data CouponTemporal_unit Source #

Defines the enum schema located at components.schemas.Coupon.properties.temporal_unit in the specification.

If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.

Constructors

CouponTemporal_unitOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponTemporal_unitTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponTemporal_unitEnumDay	Represents the JSON value `"day"`
CouponTemporal_unitEnumMonth	Represents the JSON value `"month"`
CouponTemporal_unitEnumWeek	Represents the JSON value `"week"`
CouponTemporal_unitEnumYear	Represents the JSON value `"year"`

Instances

Instances details

FromJSON CouponTemporal_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponTemporal_unit # parseJSONList :: Value -> Parser [CouponTemporal_unit] #
ToJSON CouponTemporal_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponTemporal_unit -> Value # toEncoding :: CouponTemporal_unit -> Encoding # toJSONList :: [CouponTemporal_unit] -> Value # toEncodingList :: [CouponTemporal_unit] -> Encoding #
Show CouponTemporal_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponTemporal_unit -> ShowS # show :: CouponTemporal_unit -> String # showList :: [CouponTemporal_unit] -> ShowS #
Eq CouponTemporal_unit Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponTemporal_unit -> CouponTemporal_unit -> Bool # (/=) :: CouponTemporal_unit -> CouponTemporal_unit -> Bool #

data CouponUnique_coupon_code Source #

Defines the object schema located at components.schemas.Coupon.properties.unique_coupon_code.allOf in the specification.

Will be populated when the Coupon being returned is a \`UniqueCouponCode\`.

Constructors

CouponUnique_coupon_code

Fields

couponUnique_coupon_codeBulk_coupon_code :: Maybe Text
bulk_coupon_code: The Coupon code of the parent Bulk Coupon
couponUnique_coupon_codeBulk_coupon_id :: Maybe Text
bulk_coupon_id: The Coupon ID of the parent Bulk Coupon
couponUnique_coupon_codeCode :: Maybe Text
code: The code the customer enters to redeem the coupon.
couponUnique_coupon_codeCreated_at :: Maybe JsonDateTime
created_at
couponUnique_coupon_codeExpired_at :: Maybe JsonDateTime
expired_at: The date and time the coupon was expired early or reached its `max_redemptions`.
couponUnique_coupon_codeId :: Maybe Text
id
couponUnique_coupon_codeObject :: Maybe Text
object
couponUnique_coupon_codeRedeemed_at :: Maybe JsonDateTime
redeemed_at: The date and time the unique coupon code was redeemed.
couponUnique_coupon_codeState :: Maybe CouponUnique_coupon_codeState
state: Indicates if the unique coupon code is redeemable or why not.
couponUnique_coupon_codeUpdated_at :: Maybe JsonDateTime
updated_at

Instances

Instances details

FromJSON CouponUnique_coupon_code Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponUnique_coupon_code # parseJSONList :: Value -> Parser [CouponUnique_coupon_code] #
ToJSON CouponUnique_coupon_code Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponUnique_coupon_code -> Value # toEncoding :: CouponUnique_coupon_code -> Encoding # toJSONList :: [CouponUnique_coupon_code] -> Value # toEncodingList :: [CouponUnique_coupon_code] -> Encoding #
Show CouponUnique_coupon_code Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponUnique_coupon_code -> ShowS # show :: CouponUnique_coupon_code -> String # showList :: [CouponUnique_coupon_code] -> ShowS #
Eq CouponUnique_coupon_code Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponUnique_coupon_code -> CouponUnique_coupon_code -> Bool # (/=) :: CouponUnique_coupon_code -> CouponUnique_coupon_code -> Bool #

mkCouponUnique_coupon_code :: CouponUnique_coupon_code Source #

Create a new CouponUnique_coupon_code with all required fields.

data CouponUnique_coupon_codeState Source #

Defines the enum schema located at components.schemas.Coupon.properties.unique_coupon_code.allOf.properties.state in the specification.

Indicates if the unique coupon code is redeemable or why not.

Constructors

CouponUnique_coupon_codeStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponUnique_coupon_codeStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponUnique_coupon_codeStateEnumExpired	Represents the JSON value `"expired"`
CouponUnique_coupon_codeStateEnumInactive	Represents the JSON value `"inactive"`
CouponUnique_coupon_codeStateEnumMaxed_out	Represents the JSON value `"maxed_out"`
CouponUnique_coupon_codeStateEnumRedeemable	Represents the JSON value `"redeemable"`

Instances

Instances details

FromJSON CouponUnique_coupon_codeState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods parseJSON :: Value -> Parser CouponUnique_coupon_codeState # parseJSONList :: Value -> Parser [CouponUnique_coupon_codeState] #
ToJSON CouponUnique_coupon_codeState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods toJSON :: CouponUnique_coupon_codeState -> Value # toEncoding :: CouponUnique_coupon_codeState -> Encoding # toJSONList :: [CouponUnique_coupon_codeState] -> Value # toEncodingList :: [CouponUnique_coupon_codeState] -> Encoding #
Show CouponUnique_coupon_codeState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods showsPrec :: Int -> CouponUnique_coupon_codeState -> ShowS # show :: CouponUnique_coupon_codeState -> String # showList :: [CouponUnique_coupon_codeState] -> ShowS #
Eq CouponUnique_coupon_codeState Source #
Instance details Defined in RecurlyClient.Types.Coupon Methods (==) :: CouponUnique_coupon_codeState -> CouponUnique_coupon_codeState -> Bool # (/=) :: CouponUnique_coupon_codeState -> CouponUnique_coupon_codeState -> Bool #