Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotesId

Description

Contains the different functions to run the operation getCreditNotesId

Documentation

getCreditNotesId Source #

Arguments

:: forall m. MonadHTTP m
=> GetCreditNotesIdParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetCreditNotesIdResponse)	Monadic computation which returns the result of the operation

GET /v1/credit_notes/{id}

<p>Retrieves the credit note object with the given identifier.</p>

data GetCreditNotesIdParameters Source #

Defines the object schema located at paths./v1/credit_notes/{id}.GET.parameters in the specification.

Constructors

GetCreditNotesIdParameters
Fields getCreditNotesIdParametersPathId :: Text pathId: Represents the parameter named 'id' Constraints: Maximum length of 5000 getCreditNotesIdParametersQueryExpand :: Maybe [Text] queryExpand: Represents the parameter named 'expand' Specifies which fields in the response should be expanded.

Instances

Instances details

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

mkGetCreditNotesIdParameters Source #

Arguments

:: Text	`getCreditNotesIdParametersPathId`
-> GetCreditNotesIdParameters

Create a new GetCreditNotesIdParameters with all required fields.

data GetCreditNotesIdResponse Source #

Represents a response of the operation getCreditNotesId.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetCreditNotesIdResponseError is used.

Constructors

GetCreditNotesIdResponseError String	Means either no matching case available or a parse error
GetCreditNotesIdResponse200 CreditNote	Successful response.
GetCreditNotesIdResponseDefault Error	Error response.

Instances

Instances details

Eq GetCreditNotesIdResponse Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesId Methods (==) :: GetCreditNotesIdResponse -> GetCreditNotesIdResponse -> Bool # (/=) :: GetCreditNotesIdResponse -> GetCreditNotesIdResponse -> Bool #
Show GetCreditNotesIdResponse Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotesId Methods showsPrec :: Int -> GetCreditNotesIdResponse -> ShowS # show :: GetCreditNotesIdResponse -> String # showList :: [GetCreditNotesIdResponse] -> ShowS #