Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCreditNotesPreview

Contains the different functions to run the operation getCreditNotesPreview

Synopsis

value getCreditNotesPreview
data GetCreditNotesPreviewParameters
value mkGetCreditNotesPreviewParameters
data GetCreditNotesPreviewParametersQueryLines'
value mkGetCreditNotesPreviewParametersQueryLines'
data GetCreditNotesPreviewParametersQueryLines'TaxRates'Variants
data GetCreditNotesPreviewParametersQueryLines'Type'
data GetCreditNotesPreviewParametersQueryReason'
data GetCreditNotesPreviewResponse

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetCreditNotesPreview.hs

valuegetCreditNotesPreview

:: MonadHTTP m
=> GetCreditNotesPreviewParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetCreditNotesPreviewResponse)
Monadic computation which returns the result of the operation

GET /v1/credit_notes/preview

<p>Get a preview of a credit note without creating it.</p>

datadata GetCreditNotesPreviewParameters

Source#

Defines the object schema located at paths./v1/credit_notes/preview.GET.parameters in the specification.

Constructors

GetCreditNotesPreviewParameters
- getCreditNotesPreviewParametersQueryAmount :: Maybe Int
  queryAmount: Represents the parameter named 'amount'
  The integer amount in cents (or local equivalent) representing the total amount of the credit note.
- getCreditNotesPreviewParametersQueryCreditAmount :: Maybe Int
  queryCredit_amount: Represents the parameter named 'credit_amount'
  The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- getCreditNotesPreviewParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getCreditNotesPreviewParametersQueryInvoice :: Text
  queryInvoice: Represents the parameter named 'invoice'
  ID of the invoice.
  Constraints:
  - Maximum length of 5000
- getCreditNotesPreviewParametersQueryLines :: Maybe [GetCreditNotesPreviewParametersQueryLines']
  queryLines: Represents the parameter named 'lines'
  Line items that make up the credit note.
- getCreditNotesPreviewParametersQueryMemo :: Maybe Text
  queryMemo: Represents the parameter named 'memo'
  The credit note's memo appears on the credit note PDF.
  Constraints:
  - Maximum length of 5000
- getCreditNotesPreviewParametersQueryMetadata :: Maybe Object
  queryMetadata: Represents the parameter named 'metadata'
  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- getCreditNotesPreviewParametersQueryOutOfBandAmount :: Maybe Int
  queryOut_of_band_amount: Represents the parameter named 'out_of_band_amount'
  The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
- getCreditNotesPreviewParametersQueryReason :: Maybe GetCreditNotesPreviewParametersQueryReason'
  queryReason: Represents the parameter named 'reason'
  Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
- getCreditNotesPreviewParametersQueryRefund :: Maybe Text
  queryRefund: Represents the parameter named 'refund'
  ID of an existing refund to link this credit note to.
- getCreditNotesPreviewParametersQueryRefundAmount :: Maybe Int
  queryRefund_amount: Represents the parameter named 'refund_amount'
  The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesPreviewParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
FromJSON GetCreditNotesPreviewParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
ToJSON GetCreditNotesPreviewParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview

valuemkGetCreditNotesPreviewParameters

:: Text
getCreditNotesPreviewParametersQueryInvoice
-> GetCreditNotesPreviewParameters

Source#

Create a new GetCreditNotesPreviewParameters with all required fields.

datadata GetCreditNotesPreviewParametersQueryLines'

Source#

Defines the object schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'
- getCreditNotesPreviewParametersQueryLines'Amount :: Maybe Int
  amount
- getCreditNotesPreviewParametersQueryLines'Description :: Maybe Text
  description
  Constraints:
  - Maximum length of 5000
- getCreditNotesPreviewParametersQueryLines'InvoiceLineItem :: Maybe Text
  invoice_line_item
  Constraints:
  - Maximum length of 5000
- getCreditNotesPreviewParametersQueryLines'Quantity :: Maybe Int
  quantity
- getCreditNotesPreviewParametersQueryLines'TaxRates :: Maybe GetCreditNotesPreviewParametersQueryLines'TaxRates'Variants
  tax_rates
- getCreditNotesPreviewParametersQueryLines'Type :: GetCreditNotesPreviewParametersQueryLines'Type'
  type
- getCreditNotesPreviewParametersQueryLines'UnitAmount :: Maybe Int
  unit_amount
- getCreditNotesPreviewParametersQueryLines'UnitAmountDecimal :: Maybe Text
  unit_amount_decimal

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesPreviewParametersQueryLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewParametersQueryLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
FromJSON GetCreditNotesPreviewParametersQueryLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
ToJSON GetCreditNotesPreviewParametersQueryLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview

valuemkGetCreditNotesPreviewParametersQueryLines'

:: GetCreditNotesPreviewParametersQueryLines'Type'
getCreditNotesPreviewParametersQueryLines'Type
-> GetCreditNotesPreviewParametersQueryLines'

Source#

Create a new GetCreditNotesPreviewParametersQueryLines' with all required fields.

datadata GetCreditNotesPreviewParametersQueryLines'TaxRates'Variants

Source#

Defines the oneOf schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items.properties.tax_rates.anyOf in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'TaxRates'EmptyString
Represents the JSON value ""
GetCreditNotesPreviewParametersQueryLines'TaxRates'ListTText [Text]

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesPreviewParametersQueryLines'TaxRates'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewParametersQueryLines'TaxRates'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
FromJSON GetCreditNotesPreviewParametersQueryLines'TaxRates'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
ToJSON GetCreditNotesPreviewParametersQueryLines'TaxRates'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview

datadata GetCreditNotesPreviewParametersQueryLines'Type'

Source#

Defines the enum schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items.properties.type in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'Type'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetCreditNotesPreviewParametersQueryLines'Type'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetCreditNotesPreviewParametersQueryLines'Type'EnumCustomLineItem
Represents the JSON value "custom_line_item"
GetCreditNotesPreviewParametersQueryLines'Type'EnumInvoiceLineItem
Represents the JSON value "invoice_line_item"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesPreviewParametersQueryLines'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewParametersQueryLines'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
FromJSON GetCreditNotesPreviewParametersQueryLines'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
ToJSON GetCreditNotesPreviewParametersQueryLines'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview

datadata GetCreditNotesPreviewParametersQueryReason'

Source#

Defines the enum schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryReason in the specification.

Represents the parameter named 'reason'

Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`

Constructors

GetCreditNotesPreviewParametersQueryReason'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetCreditNotesPreviewParametersQueryReason'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetCreditNotesPreviewParametersQueryReason'EnumDuplicate
Represents the JSON value "duplicate"
GetCreditNotesPreviewParametersQueryReason'EnumFraudulent
Represents the JSON value "fraudulent"
GetCreditNotesPreviewParametersQueryReason'EnumOrderChange
Represents the JSON value "order_change"
GetCreditNotesPreviewParametersQueryReason'EnumProductUnsatisfactory
Represents the JSON value "product_unsatisfactory"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCreditNotesPreviewParametersQueryReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewParametersQueryReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
FromJSON GetCreditNotesPreviewParametersQueryReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
ToJSON GetCreditNotesPreviewParametersQueryReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview

datadata GetCreditNotesPreviewResponse

Source#

Represents a response of the operation getCreditNotesPreview.

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), GetCreditNotesPreviewResponseError is used.

Constructors

GetCreditNotesPreviewResponseError String
Means either no matching case available or a parse error
GetCreditNotesPreviewResponse200 CreditNote
Successful response.
GetCreditNotesPreviewResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetCreditNotesPreviewResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview
Show GetCreditNotesPreviewResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCreditNotesPreview