Web.Stripe.Plan

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

import Web.Stripe         
import Web.Stripe.Plan

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ do
      createPlan (PlanId "free plan")
                 (0 :: Amount) 
                 (USD :: Currency)
                 (Month :: Interval)
                 ("a sample free plan" :: Name)
                 ([] :: MetaData)
  case result of
    Right plan     -> print plan
    Left stripeError -> print stripeError

API

createPlan

Arguments

:: PlanId

Unique string used to identify Plan

-> Amount

Positive integer in cents (or 0 for a free plan) representing how much to charge on a recurring basis

-> Currency

Currency of Plan

-> Interval

Billing Frequency

-> Name

Name of Plan to be displayed on Invoices

-> MetaData

MetaData for the Plan

-> Stripe Plan

Create a Plan

createPlanIntervalCount

Arguments

:: PlanId

Unique string used to identify Plan

-> Amount

Positive integer in cents (or 0 for a free plan) representing how much to charge on a recurring basis

-> Currency

Currency of Plan

-> Interval

Billing Frequency

-> Name

Name of Plan to be displayed on Invoices

-> IntervalCount

# of billins between each Subscription billing

-> Stripe Plan

Create a Plan with a specified IntervalCount

createPlanTrialPeriodDays

Arguments

:: PlanId

Unique string used to identify Plan

-> Amount

Positive integer in cents (or 0 for a free plan) representing how much to charge on a recurring basis

-> Currency

Currency of Plan

-> Interval

Billing Frequency

-> Name

Name of Plan to be displayed on Invoices

-> TrialPeriodDays

Number of Trial Period Days to be displayed on Invoices

-> Stripe Plan

Create a Plan with a specified number of TrialPeriodDays

createPlanBase

Arguments

:: PlanId

Unique string used to identify Plan

-> Amount

Positive integer in cents representing how much to charge on a recurring basis

-> Currency

Currency of Plan

-> Interval

Billing Frequency (i.e. Day, Week or Month)

-> Name

Name of Plan to be displayed on Invoices

-> Maybe IntervalCount

Number of intervals between each Subscription billing, default 1

-> Maybe TrialPeriodDays

Integer number of days a trial will have

-> Maybe Description

An arbitrary string to be displayed on Customer credit card statements

-> MetaData

MetaData for the Plan

-> Stripe Plan

Base Request for creating a Plan, useful for making custom Plan creation requests

getPlan

Arguments

:: PlanId

The ID of the plan to retrieve

-> Stripe Plan

Retrieve a Plan

getPlans

Arguments

:: Limit

Defaults to 10 if Nothing specified

-> StartingAfter PlanId

Paginate starting after the following CustomerID

-> EndingBefore PlanId

Paginate ending before the following CustomerID

-> Stripe (StripeList Plan)

Retrieve a Plan

updatePlanName

Arguments

:: PlanId

The ID of the Plan to update

-> Description

The Name of the Plan to update

-> Stripe Plan

Update a Plan Name

updatePlanDescription

Arguments

:: PlanId

The ID of the Plan to update

-> Description

The Description of the Plan to update

-> Stripe Plan

Update a Plan Description

updatePlanBase

Arguments

:: PlanId

The ID of the Plan to update

-> Maybe Name

The Name of the Plan to update

-> Maybe Description

The Description of the Plan to update

-> MetaData

The MetaData for the Plan

-> Stripe Plan

Base Request for updating a Plan, useful for creating customer Plan update functions

deletePlan

Arguments

:: PlanId

The ID of the Plan to delete

-> Stripe StripeDeleteResult

Delete a Plan

Types

newtype PlanId

PlanId for a Plan

Constructors

PlanId Text

Instances

Eq PlanId

Show PlanId

data Plan

Plan object

Constructors

Plan

Fields

planInterval :: Interval

planName :: Text

planCreated :: UTCTime

planAmount :: Int

planCurrency :: Currency

planId :: PlanId

planObject :: Text

planLiveMode :: Bool

planIntervalCount :: Maybe Int

planTrialPeriodDays :: Maybe Int

planMetaData :: MetaData

planDescription :: Maybe Description

Instances

Eq Plan

Show Plan

FromJSON Plan

JSON Instance for Plan

data Interval

Interval for Plans

Constructors

Day

Week

Month

Year

Instances

Eq Interval

Show Interval

Show instance for Interval

FromJSON Interval

JSON Instance for Interval

data StripeList a

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

newtype IntervalCount

IntervalCount for a Coupon

Constructors

IntervalCount Int

Instances

Eq IntervalCount

Show IntervalCount

newtype TrialPeriodDays

TrialPeriodDays for a Coupon

Constructors

TrialPeriodDays Int

Instances

Eq TrialPeriodDays

Show TrialPeriodDays

data StripeDeleteResult

JSON returned from a Stripe deletion request

Constructors

StripeDeleteResult

Fields

deleted :: Bool

deletedId :: Maybe Text

Instances

Eq StripeDeleteResult

Show StripeDeleteResult

FromJSON StripeDeleteResult

JSON Instance for StripeDeleteResult

data Currency

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

Eq Currency

Show Currency

FromJSON Currency

Currency JSON instances

type Limit = Maybe Int

Pagination Option for StripeList

type StartingAfter a = Maybe a

Pagination Option for StripeList

type EndingBefore a = Maybe a

Pagination Option for StripeList

type Name = Text

Generic URL for use in constructing API Calls

type Amount = Int

Amount representing a monetary value. Stripe represents pennies as whole numbers i.e. 100 = $1

type Description = Text

Generic Description for use in constructing API Calls

type MetaData = [(Text, Text)]

Type of MetaData for use on Stripe objects