Web.Stripe.InvoiceItem

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

import Web.Stripe         
import Web.Stripe.Customer
import Web.Stripe.InvoiceItem

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ do
    Customer { customerId = cid } <- createEmptyCustomer
    createInvoiceItem cid 100 USD Nothing Nothing (Just "description") []
  case result of
    Right invoiceitem -> print invoiceitem
    Left  stripeError -> print stripeError

API

createInvoiceItem

Arguments

:: CustomerId

CustomerId of Customer on which to create an InvoiceItem

-> Amount

Amount associated with InvoiceItem

-> Currency

Currency to use for InvoiceItem

-> Maybe InvoiceId

InvoiceId to use for InvoiceItem

-> Maybe SubscriptionId

SubscriptionId to use for InvoiceItem

-> Maybe Description

Description to use for InvoiceItem

-> MetaData

MetaData to use for InvoiceItem

-> Stripe InvoiceItem

Create an invoice for a Customer

getInvoiceItem

Arguments

:: InvoiceItemId

InvoiceItemId of InvoiceItem to retrieve

-> Stripe InvoiceItem

Retrieve an InvoiceItem by InvoiceItemId

getInvoiceItemExpandable

Arguments

:: InvoiceItemId

InvoiceItemId of InvoiceItem to retrieve

-> ExpandParams

ExpandParams of the objects for expansion

-> Stripe InvoiceItem

Retrieve an InvoiceItem by InvoiceItemId

getInvoiceItems

Arguments

:: Maybe CustomerId

When specified, only InvoiceItems for this Customer are returned

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter InvoiceItemId

Paginate starting after the following InvoiceItemId

-> EndingBefore InvoiceItemId

Paginate ending before the following InvoiceItemId

-> Stripe (StripeList InvoiceItem)

Retrieve an InvoiceItem by InvoiceItemId

getInvoiceItemsExpandable

Arguments

:: Maybe CustomerId

When specified, only InvoiceItems for this Customer are returned

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter InvoiceItemId

Paginate starting after the following InvoiceItemId

-> EndingBefore InvoiceItemId

Paginate ending before the following InvoiceItemId

-> ExpandParams

ExpandParams of the objects for expansion

-> Stripe (StripeList InvoiceItem)

Retrieve an InvoiceItem by InvoiceItemId with ExpandParams

updateInvoiceItem

Arguments

:: InvoiceItemId

InvoiceItemId of to update

-> Maybe Amount

Amount in cents of the charge to be applied to the invoice

-> Maybe Description

Amount in cents of the charge to be applied to the invoice

-> MetaData

MetaData of InvoiceItem to update

-> Stripe InvoiceItem

Update an InvoiceItem by InvoiceItemId

deleteInvoiceItem

Arguments

:: InvoiceItemId

InvoiceItemdId of InvoiceItem to be deleted

-> Stripe StripeDeleteResult

Delete an InvoiceItem by InvoiceItemId

Types

data InvoiceItemId

InvoiceItemId for InvoiceItem

Constructors

InvoiceItemId Text

ExpandedInvoiceItem InvoiceItem

Instances

Eq InvoiceItemId

Show InvoiceItemId

data InvoiceItem

InvoiceItem object

Constructors

InvoiceItem

Fields

invoiceItemObject :: Text

invoiceItemId :: InvoiceItemId

invoiceItemDate :: UTCTime

invoiceItemAmount :: Int

invoiceItemLiveMode :: Bool

invoiceItemProration :: Bool

invoiceItemCurrency :: Currency

invoiceItemCustomer :: CustomerId

invoiceItemDescription :: Maybe Description

invoiceItemInvoice :: Maybe InvoiceId

invoiceItemQuantity :: Maybe Quantity

invoiceItemSubscription :: Maybe Subscription

invoiceItemMetaData :: MetaData

Instances

Eq InvoiceItem

Show InvoiceItem

FromJSON InvoiceItem

JSON Instance for InvoiceItem

data CustomerId

CustomerId for a Customer

Constructors

CustomerId Text

ExpandedCustomer Customer

Instances

Eq CustomerId

Show CustomerId

FromJSON CustomerId

JSON Instance for CustomerId

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

data InvoiceId

Invoice for a Coupon

Constructors

InvoiceId Text

ExpandedInvoice Invoice

Instances

Eq InvoiceId

Show InvoiceId

FromJSON InvoiceId

JSON Instance for InvoiceId

data Invoice

Invoice Object

Constructors

Invoice

Fields

invoiceDate :: UTCTime

invoiceId :: Maybe InvoiceId

If upcoming no ID will exist

invoicePeriodStart :: UTCTime

invoicePeriodEnd :: UTCTime

invoiceLineItems :: StripeList InvoiceLineItem

invoiceSubTotal :: Int

invoiceTotal :: Int

invoiceCustomer :: CustomerId

invoiceObject :: Text

invoiceAttempted :: Bool

invoiceClosed :: Bool

invoiceForgiven :: Bool

invoicePaid :: Bool

invoiceLiveMode :: Bool

invoiceAttemptCount :: Int

invoiceAmountDue :: Int

invoiceCurrency :: Currency

invoiceStartingBalance :: Int

invoiceEndingBalance :: Maybe Int

invoiceNextPaymentAttempt :: Maybe UTCTime

invoiceWebHooksDeliveredAt :: Maybe UTCTime

invoiceCharge :: Maybe ChargeId

invoiceDiscount :: Maybe Discount

invoiceApplicateFee :: Maybe FeeId

invoiceSubscription :: Maybe SubscriptionId

invoiceStatementDescription :: Maybe Description

invoiceDescription :: Maybe Description

invoiceMetaData :: MetaData

Instances

Eq Invoice

Show Invoice

FromJSON Invoice

JSON Instance for Invoice

newtype SubscriptionId

SubscriptionId for a Subscription

Constructors

SubscriptionId Text

Instances

Eq SubscriptionId

Show SubscriptionId

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 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

type Description = Text

Generic Description for use in constructing API Calls

type Amount = Int

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