stripe-haskell-0.1.0.5: Stripe API for Haskell

Copyright(c) David Johnson, 2014
Maintainerdjohnson.m@gmail.com
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Web.Stripe.Coupon

Contents

Description

https://stripe.com/docs/api#coupons

import Web.Stripe         
import Web.Stripe.Coupon

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- createCoupon
           (Just $ CouponId "$1 Off!")
           Once
           (Just $ AmountOff 1)
           (Just USD)
           Nothing
           Nothing
           Nothing
           Nothing
           []
  case result of
    Right coupon      -> print coupon
    Left  stripeError -> print stripeError

Synopsis

API

createCoupon Source

Arguments

:: Maybe CouponId

Name of the Coupon

-> Duration

Duration of the Coupon

-> Maybe AmountOff

AmountOff of the Coupon

-> Maybe Currency

Currency of the Coupon

-> Maybe DurationInMonths

DurationInMonths of the Coupon

-> Maybe MaxRedemptions

MaxRedemptions of the Coupon

-> Maybe PercentOff

PercentOff of the Coupon

-> Maybe RedeemBy

RedeemBy date of the Coupon

-> MetaData

MetaData of the Coupon

-> Stripe Coupon 

Coupon creation

getCoupon Source

Arguments

:: CouponId

CouponId of the Coupon to retrieve

-> Stripe Coupon 

Retrieve a Coupon by CouponId

getCoupons Source

Arguments

:: Maybe Limit

Defaults to 10 if Nothing specified

-> StartingAfter CouponId

Paginate starting after the following CouponId

-> EndingBefore CouponId

Paginate ending before the following CouponId

-> Stripe (StripeList Coupon) 

Retrieve a list of Coupons

updateCoupon Source

Arguments

:: CouponId

The CoupondId of the Coupon to update

-> MetaData

The MetaData for the Coupon

-> Stripe Coupon 

Update Coupon

deleteCoupon Source

Arguments

:: CouponId

The CoupondId of the Coupon to update

-> Stripe StripeDeleteResult 

Delete 'Coupon" by CouponId

Types

data Duration Source

Coupon Duration

Constructors

Forever 
Once 
Repeating 

Instances

newtype AmountOff Source

AmountOff for a Coupon

Constructors

AmountOff Int 

Instances

newtype CouponId Source

CouponId for a Coupon

Constructors

CouponId Text 

Instances

data Coupon Source

Coupon Object

Constructors

Coupon 

Fields

couponId :: CouponId
 
couponCreated :: UTCTime
 
couponPercentOff :: Maybe Int
 
couponAmountOff :: Maybe Int
 
couponCurrency :: Maybe Currency
 
couponLiveMode :: Bool
 
couponDuration :: Duration
 
couponRedeemBy :: Maybe UTCTime
 
couponMaxRedemptions :: Maybe Int
 
couponTimesRedeemed :: Maybe Int
 
couponDurationInMonths :: Maybe Int
 
couponValid :: Bool
 
couponMetaData :: MetaData
 

Instances

data Currency Source

Stripe supports 138 currencies

Constructors

AED

United Arab Emirates Dirham

AFN

Afghan Afghani

ALL

Albanian Lek

AMD

Armenian Dram

ANG

Netherlands Antillean Gulden

AOA

Angolan Kwanza

ARS

Argentine Peso

AUD

Australian Dollar

AWG

Aruban Florin

AZN

Azerbaijani Manat

BAM

Bosnia & Herzegovina Convertible Mark

BBD

Barbadian Dollar

BDT

Bangladeshi Taka

BGN

Bulgarian Lev

BIF

Burundian Franc

BMD

Bermudian Dollar

BND

Brunei Dollar

BOB

Bolivian Boliviano

BRL

Brazilian Real

BSD

Bahamian Dollar

BWP

Botswana Pula

BZD

Belize Dollar

CAD

Canadian Dollar

CDF

Congolese Franc

CHF

Swiss Franc

CLP

Chilean Peso

CNY

Chinese Renminbi Yuan

COP

Colombian Peso

CRC

Costa Rican Colón

CVE

Cape Verdean Escudo

CZK

Czech Koruna

DJF

Djiboutian Franc

DKK

Danish Krone

DOP

Dominican Peso

DZD

Algerian Dinar

EEK

Estonian Kroon

EGP

Egyptian Pound

ETB

Ethiopian Birr

EUR

Euro

FJD

Fijian Dollar

FKP

Falkland Islands Pound

GBP

British Pound

GEL

Georgian Lari

GIP

Gibraltar Pound

GMD

Gambian Dalasi

GNF

Guinean Franc

GTQ

Guatemalan Quetzal

GYD

Guyanese Dollar

HKD

Hong Kong Dollar

HNL

Honduran Lempira

HRK

Croatian Kuna

HTG

Haitian Gourde

HUF

Hungarian Forint

IDR

Indonesian Rupiah

ILS

Israeli New Sheqel

INR

Indian Rupee

ISK

Icelandic Króna

JMD

Jamaican Dollar

JPY

Japanese Yen

KES

Kenyan Shilling

KGS

Kyrgyzstani Som

KHR

Cambodian Riel

KMF

Comorian Franc

KRW

South Korean Won

KYD

Cayman Islands Dollar

KZT

Kazakhstani Tenge

LAK

Lao Kip

LBP

Lebanese Pound

LKR

Sri Lankan Rupee

LRD

Liberian Dollar

LSL

Lesotho Loti

LTL

Lithuanian Litas

LVL

Latvian Lats

MAD

Moroccan Dirham

MDL

Moldovan Leu

MGA

Malagasy Ariary

MKD

Macedonian Denar

MNT

Mongolian Tögrög

MOP

Macanese Pataca

MRO

Mauritanian Ouguiya

MUR

Mauritian Rupee

MVR

Maldivian Rufiyaa

MWK

Malawian Kwacha

MXN

Mexican Peso

MYR

Malaysian Ringgit

MZN

Mozambican Metical

NAD

Namibian Dollar

NGN

Nigerian Naira

NIO

Nicaraguan Córdoba

NOK

Norwegian Krone

NPR

Nepalese Rupee

NZD

New Zealand Dollar

PAB

Panamanian Balboa

PEN

Peruvian Nuevo Sol

PGK

Papua New Guinean Kina

PHP

Philippine Peso

PKR

Pakistani Rupee

PLN

Polish Złoty

PYG

Paraguayan Guaraní

QAR

Qatari Riyal

RON

Romanian Leu

RSD

Serbian Dinar

RUB

Russian Ruble

RWF

Rwandan Franc

SAR

Saudi Riyal

SBD

Solomon Islands Dollar

SCR

Seychellois Rupee

SEK

Swedish Krona

SGD

Singapore Dollar

SHP

Saint Helenian Pound

SLL

Sierra Leonean Leone

SOS

Somali Shilling

SRD

Surinamese Dollar

STD

São Tomé and Príncipe Dobra

SVC

Salvadoran Colón

SZL

Swazi Lilangeni

THB

Thai Baht

TJS

Tajikistani Somoni

TOP

Tongan Paʻanga

TRY

Turkish Lira

TTD

Trinidad and Tobago Dollar

TWD

New Taiwan Dollar

TZS

Tanzanian Shilling

UAH

Ukrainian Hryvnia

UGX

Ugandan Shilling

USD

United States Dollar

UYU

Uruguayan Peso

UZS

Uzbekistani Som

VND

Vietnamese Đồng

VUV

Vanuatu Vatu

WST

Samoan Tala

XAF

Central African Cfa Franc

XCD

East Caribbean Dollar

XOF

West African Cfa Franc

XPF

Cfp Franc

YER

Yemeni Rial

ZAR

South African Rand

ZMW

Zambian Kwacha

UnknownCurrency

Unknown Currency

Instances

newtype DurationInMonths Source

DurationInMonths for a Coupon

Constructors

DurationInMonths Int 

Instances

newtype MaxRedemptions Source

MaxRedemptions for a Coupon

Constructors

MaxRedemptions Int 

Instances

newtype PercentOff Source

PercentOff for a Coupon

Constructors

PercentOff Int 

Instances

newtype RedeemBy Source

RedeemBy date for a Coupon

Constructors

RedeemBy UTCTime 

Instances

data StripeList a Source

Generic handling of Stripe JSON arrays

Constructors

StripeList 

Fields

list :: [a]
 
stripeUrl :: Text
 
object :: Text
 
totalCount :: Maybe Int
 
hasMore :: Bool
 

Instances

Eq a => Eq (StripeList a) 
Show a => Show (StripeList a) 
FromJSON a => FromJSON (StripeList a)

JSON Instance for StripeList

data StripeDeleteResult Source

JSON returned from a Stripe deletion request

Constructors

StripeDeleteResult 

Fields

deleted :: Bool
 
deletedId :: Maybe Text
 

Instances