Copyright	(c) David Johnson, 2014
Maintainer	djohnson.m@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Stripe.Invoice

Contents

API
Types

Description

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

import Web.Stripe         
import Web.Stripe.Customer
import Web.Stripe.Invoice
import Web.Stripe.InvoiceItem
import Web.Stripe.Plan

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ do
     Customer { customerId = cid } <- createEmptyCustomer
     Plan { } <- createPlan (PlanId "planid") 20 USD Day "testplan" []
     InvoiceItem { } <- createInvoiceItem cid 100 USD Nothing Nothing Nothing []
     createInvoice cid []
  case result of
    Right invoice -> print invoice
    Left  stripeError -> print stripeError

Synopsis

API

createInvoice Source

Arguments

:: CustomerId	`CustomerId` of `Customer` to `Invoice`
-> MetaData	`MetaData` of `Customer` to `Invoice`
-> Stripe Invoice

The Invoice to be created for a Customer

getInvoice Source

Arguments

:: InvoiceId	Get an `Invoice` by `InvoiceId`
-> Stripe Invoice

Retrieve an Invoice by InvoiceId

getInvoiceExpandable Source

Arguments

:: InvoiceId	Get an `Invoice` by `InvoiceId`
-> ExpandParams	`ExpandParams` of the objects for expansion
-> Stripe Invoice

Retrieve an Invoice by InvoiceId with ExpandParams

getInvoices Source

Arguments

:: Maybe Limit	Defaults to 10 if `Nothing` specified
-> StartingAfter InvoiceItemId	Paginate starting after the following `Customer`
-> EndingBefore InvoiceItemId	Paginate ending before the following `CustomerID`
-> Stripe (StripeList Invoice)

Retrieve a StripeList of Invoices

getInvoicesExpandable Source

Arguments

:: Maybe Limit	Defaults to 10 if `Nothing` specified
-> StartingAfter InvoiceItemId	Paginate starting after the following `Customer`
-> EndingBefore InvoiceItemId	Paginate ending before the following `CustomerID`
-> ExpandParams	`ExpandParams` of the objects for expansion
-> Stripe (StripeList Invoice)

Retrieve a StripeList of Invoices with ExpandParams

getInvoiceLineItems Source

Arguments

:: InvoiceId	Get an `Invoice` by `InvoiceId`
-> Limit	Defaults to 10 if `Nothing` specified
-> StartingAfter InvoiceLineItemId	Paginate starting after the following `InvoiceLineItemId`
-> EndingBefore InvoiceLineItemId	Paginate ending before the following `InvoiceLineItemId`
-> Stripe (StripeList InvoiceLineItem)

Retrieve an Invoice by InvoiceId

getUpcomingInvoice Source

Arguments

:: CustomerId	The `InvoiceId` of the `Invoice` to retrieve
-> Stripe Invoice

Retrieve an upcoming Invoice for a Customer by CustomerId

getUpcomingInvoices Source

Arguments

:: CustomerId	The `InvoiceId` of the `Invoice` to retrieve
-> Stripe (StripeList Invoice)

Retrieve a StripeList of Invoices

updateInvoice Source

Arguments

:: InvoiceId	The `InvoiceId` of the `Invoice` to update
-> MetaData	`MetaData` of `Customer` to `Invoice`
-> Stripe Invoice

Update Invoice by InvoiceId

payInvoice Source

Arguments

:: InvoiceId	The `InvoiceId` of the `Invoice` to pay
-> Stripe Invoice

Pay Invoice by InvoiceId

Types

data Invoice Source

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`

data InvoiceId Source

Invoice for a Coupon

Constructors

InvoiceId Text
ExpandedInvoice Invoice

Instances

Eq InvoiceId
Show InvoiceId
FromJSON InvoiceId	JSON Instance for `InvoiceId`

data InvoiceLineItem Source

InvoiceLineItem Object

Instances

Eq InvoiceLineItem
Show InvoiceLineItem
FromJSON InvoiceLineItem	JSON Instance for `InvoiceLineItem`

newtype InvoiceLineItemId Source

InvoiceLineItemId for an InvoiceLineItem

Constructors

InvoiceLineItemId Text

Instances

Eq InvoiceLineItemId
Show InvoiceLineItemId

data InvoiceLineItemType Source

Type of InvoiceItem

Constructors

InvoiceItemType
SubscriptionItemType

Instances

Eq InvoiceLineItemType
Show InvoiceLineItemType
FromJSON InvoiceLineItemType	JSON Instance for `InvoiceLineItemType`

data Discount Source

Discount for Coupon

Constructors

Discount
Fields discountCoupon :: Coupon discountStart :: UTCTime discountEnd :: Maybe UTCTime discountCustomer :: CustomerId discountObject :: Text discountSubscription :: Maybe SubscriptionId

Instances

Eq Discount
Show Discount
FromJSON Discount	JSON Instance for `Discount`

data Period Source

Period for an InvoiceLineItem

Constructors

Period
Fields start :: UTCTime end :: UTCTime

Instances

Eq Period
Show Period
FromJSON Period	JSON Instance for `Period`