Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.CreditPayment

Description

Contains the types generated from the schema CreditPayment

Synopsis

Documentation

Defines the object schema located at components.schemas.CreditPayment in the specification.

Constructors

Fields

creditPaymentAccount :: Maybe AccountMini
account
creditPaymentAction :: Maybe CreditPaymentAction
action: The action for which the credit was created.
creditPaymentAmount :: Maybe Float
amount: Total credit payment amount applied to the charge invoice.
creditPaymentApplied_to_invoice :: Maybe InvoiceMini
applied_to_invoice
creditPaymentCreated_at :: Maybe JsonDateTime
created_at
creditPaymentCurrency :: Maybe Text
currency: 3-letter ISO 4217 currency code.
Constraints:
- Maximum length of 3
creditPaymentId :: Maybe Text
id
Constraints:
- Maximum length of 13
creditPaymentObject :: Maybe Text
object
creditPaymentOriginal_credit_payment_id :: Maybe Text
original_credit_payment_id: For credit payments with action `refund`, this is the credit payment that was refunded.
Constraints:
- Maximum length of 13
creditPaymentOriginal_invoice :: Maybe InvoiceMini
original_invoice
creditPaymentRefund_transaction :: Maybe Transaction
refund_transaction
creditPaymentUpdated_at :: Maybe JsonDateTime
updated_at
creditPaymentUuid :: Maybe Text
uuid: The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
Constraints:
- Maximum length of 32
creditPaymentVoided_at :: Maybe JsonDateTime
voided_at

Instances details

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

Create a new CreditPayment with all required fields.

Defines the enum schema located at components.schemas.CreditPayment.properties.action in the specification.

The action for which the credit was created.

Constructors

CreditPaymentActionOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditPaymentActionTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CreditPaymentActionEnumPayment	Represents the JSON value `"payment"`
CreditPaymentActionEnumReduction	Represents the JSON value `"reduction"`
CreditPaymentActionEnumRefund	Represents the JSON value `"refund"`
CreditPaymentActionEnumWrite_off	Represents the JSON value `"write_off"`

Instances details

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