| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetInvoicesUpcomingLines
Description
Contains the different functions to run the operation getInvoicesUpcomingLines
Synopsis
- getInvoicesUpcomingLines :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> m (Either HttpException (Response GetInvoicesUpcomingLinesResponse))
- getInvoicesUpcomingLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> m (Either HttpException (Response ByteString))
- getInvoicesUpcomingLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesUpcomingLinesResponse))
- getInvoicesUpcomingLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetInvoicesUpcomingLinesRequestBody = GetInvoicesUpcomingLinesRequestBody {
- data GetInvoicesUpcomingLinesResponse
- data GetInvoicesUpcomingLinesResponseBody200 = GetInvoicesUpcomingLinesResponseBody200 {}
- data GetInvoicesUpcomingLinesResponseBody200Object'
Documentation
getInvoicesUpcomingLines Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | coupon: The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. | Constraints: Maximum length of 5000 |
| -> Maybe String | customer: The identifier of the customer whose upcoming invoice you'd like to retrieve. | Constraints: Maximum length of 5000 |
| -> 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. |
| -> Maybe String | invoice_items: List of invoice items to add or update in the upcoming invoice preview. |
| -> 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 | schedule: The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. | Constraints: Maximum length of 5000 |
| -> 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 |
| -> Maybe String | subscription: The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. | Constraints: Maximum length of 5000 |
| -> Maybe String | subscription_billing_cycle_anchor: For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. |
| -> Maybe String | subscription_cancel_at: Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` |
| -> Maybe Bool | subscription_cancel_at_period_end: Boolean indicating whether this subscription should cancel at the end of the current period. |
| -> Maybe Bool | subscription_cancel_now: This simulates the subscription being canceled or expired immediately. |
| -> Maybe String | subscription_default_tax_rates: If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. |
| -> Maybe String | subscription_items: List of subscription items, each with an attached plan. |
| -> Maybe Bool | subscription_prorate: If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_items` or `subscription`, and one of `subscription_items` or `subscription_trial_end` are required. |
| -> Maybe String | subscription_proration_behavior: Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass `always_invoice`. Prorations can be disabled by passing `none`. |
| -> Maybe Integer | subscription_proration_date: If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. |
| -> Maybe Integer | subscription_start_date: Date a subscription is intended to start (can be future or past) |
| -> Maybe Double | subscription_tax_percent: If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the migration docs for `tax_rates`. |
| -> Maybe String | subscription_trial_end: If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. |
| -> Maybe Bool | subscription_trial_from_plan: Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. |
| -> GetInvoicesUpcomingLinesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetInvoicesUpcomingLinesResponse)) | Monad containing the result of the operation |
GET /v1/invoices/upcoming/lines
<p>When retrieving an upcoming invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>
getInvoicesUpcomingLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices/upcoming/lines
The same as getInvoicesUpcomingLines but returns the raw ByteString
getInvoicesUpcomingLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesUpcomingLinesResponse)) Source #
GET /v1/invoices/upcoming/lines
Monadic version of getInvoicesUpcomingLines (use with runWithConfiguration)
getInvoicesUpcomingLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe Double -> Maybe String -> Maybe Bool -> GetInvoicesUpcomingLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices/upcoming/lines
Monadic version of getInvoicesUpcomingLinesRaw (use with runWithConfiguration)
data GetInvoicesUpcomingLinesRequestBody Source #
Defines the data type for the schema getInvoicesUpcomingLinesRequestBody
Constructors
| GetInvoicesUpcomingLinesRequestBody | |
Instances
data GetInvoicesUpcomingLinesResponse Source #
Represents a response of the operation getInvoicesUpcomingLines.
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), GetInvoicesUpcomingLinesResponseError is used.
Constructors
| GetInvoicesUpcomingLinesResponseError String | Means either no matching case available or a parse error |
| GetInvoicesUpcomingLinesResponse200 GetInvoicesUpcomingLinesResponseBody200 | Successful response. |
| GetInvoicesUpcomingLinesResponseDefault Error | Error response. |
Instances
data GetInvoicesUpcomingLinesResponseBody200 Source #
Defines the data type for the schema GetInvoicesUpcomingLinesResponseBody200
Constructors
| GetInvoicesUpcomingLinesResponseBody200 | |
Fields
| |
Instances
data GetInvoicesUpcomingLinesResponseBody200Object' Source #
Defines the enum schema GetInvoicesUpcomingLinesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetInvoicesUpcomingLinesResponseBody200Object'EnumOther Value | |
| GetInvoicesUpcomingLinesResponseBody200Object'EnumTyped String | |
| GetInvoicesUpcomingLinesResponseBody200Object'EnumStringList |