| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetCreditNotesPreviewLines
Description
Contains the different functions to run the operation getCreditNotesPreviewLines
Synopsis
- getCreditNotesPreviewLines :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> m (Either HttpException (Response GetCreditNotesPreviewLinesResponse))
- getCreditNotesPreviewLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> m (Either HttpException (Response ByteString))
- getCreditNotesPreviewLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesPreviewLinesResponse))
- getCreditNotesPreviewLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetCreditNotesPreviewLinesRequestBody = GetCreditNotesPreviewLinesRequestBody {
- data GetCreditNotesPreviewLinesResponse
- data GetCreditNotesPreviewLinesResponseBody200 = GetCreditNotesPreviewLinesResponseBody200 {}
- data GetCreditNotesPreviewLinesResponseBody200Object'
Documentation
getCreditNotesPreviewLines Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe Integer | amount: The integer amount in **%s** representing the total amount of the credit note. |
| -> Maybe Integer | credit_amount: The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. |
| -> Maybe String | ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000 |
| -> Maybe String | expand: Specifies which fields in the response should be expanded. |
| -> String | invoice: ID of the invoice. | Constraints: Maximum length of 5000 |
| -> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| -> Maybe String | lines: Line items that make up the credit note. |
| -> Maybe String | memo: The credit note's memo appears on the credit note PDF. | Constraints: Maximum length of 5000 |
| -> Maybe String | 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`. |
| -> Maybe Integer | out_of_band_amount: The integer amount in **%s** representing the amount that is credited outside of Stripe. |
| -> Maybe String | reason: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` |
| -> Maybe String | refund: ID of an existing refund to link this credit note to. |
| -> Maybe Integer | refund_amount: The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. |
| -> Maybe String | starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
| -> GetCreditNotesPreviewLinesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetCreditNotesPreviewLinesResponse)) | Monad containing the result of the operation |
GET /v1/credit_notes/preview/lines
<p>When retrieving a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.</p>
getCreditNotesPreviewLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/credit_notes/preview/lines
The same as getCreditNotesPreviewLines but returns the raw ByteString
getCreditNotesPreviewLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesPreviewLinesResponse)) Source #
GET /v1/credit_notes/preview/lines
Monadic version of getCreditNotesPreviewLines (use with runWithConfiguration)
getCreditNotesPreviewLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesPreviewLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/credit_notes/preview/lines
Monadic version of getCreditNotesPreviewLinesRaw (use with runWithConfiguration)
data GetCreditNotesPreviewLinesRequestBody Source #
Defines the data type for the schema getCreditNotesPreviewLinesRequestBody
Constructors
| GetCreditNotesPreviewLinesRequestBody | |
Instances
data GetCreditNotesPreviewLinesResponse Source #
Represents a response of the operation getCreditNotesPreviewLines.
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), GetCreditNotesPreviewLinesResponseError is used.
Constructors
| GetCreditNotesPreviewLinesResponseError String | Means either no matching case available or a parse error |
| GetCreditNotesPreviewLinesResponse200 GetCreditNotesPreviewLinesResponseBody200 | Successful response. |
| GetCreditNotesPreviewLinesResponseDefault Error | Error response. |
Instances
data GetCreditNotesPreviewLinesResponseBody200 Source #
Defines the data type for the schema GetCreditNotesPreviewLinesResponseBody200
Constructors
| GetCreditNotesPreviewLinesResponseBody200 | |
Fields
| |
data GetCreditNotesPreviewLinesResponseBody200Object' Source #
Defines the enum schema GetCreditNotesPreviewLinesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetCreditNotesPreviewLinesResponseBody200Object'EnumOther Value | |
| GetCreditNotesPreviewLinesResponseBody200Object'EnumTyped String | |
| GetCreditNotesPreviewLinesResponseBody200Object'EnumStringList |