@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

@required @param invoice [String?] @return [Stripe::DeletedInvoice]

<p>Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be <a href=&quot;#void_invoice&quot;>voided</a>.</p> @required @param invoice [String?] @return nil

<p>Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be <a href=&quot;#void_invoice&quot;>voided</a>.</p> @required @param invoice [String?] @return [Tuple(Stripe::DeletedInvoice, Integer, Hash)] Stripe::DeletedInvoice, response status code and response headers

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

@optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return invoices for the customer specified by this customer ID. @optional @param subscription [String?] Only return invoices for the subscription specified by this subscription ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return invoices that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param collection_method [String?] The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. @optional @param status [String?] The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) @optional @param due_date [Stripe::GetAccountsCreatedParameter?] @return [Stripe::InvoicesResourceList]

<p>You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.</p> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return invoices for the customer specified by this customer ID. @optional @param subscription [String?] Only return invoices for the subscription specified by this subscription ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return invoices that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param collection_method [String?] The collection method of the invoice to retrieve. Either charge_automatically or send_invoice. @optional @param status [String?] The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more @optional @param due_date [Stripe::GetAccountsCreatedParameter?] @return nil

Retrieves the invoice with the given ID.

@required @param invoice [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Invoice]

<p>Retrieves the invoice with the given ID.</p> @required @param invoice [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

When retrieving an invoice, you’ll get a lines 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.

@required @param invoice [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::InvoiceLinesList]

<p>When retrieving an 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> @required @param invoice [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>When retrieving an 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> @required @param invoice [String?] @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::InvoiceLinesList, Integer, Hash)] Stripe::InvoiceLinesList, response status code and response headers

<p>Retrieves the invoice with the given ID.</p> @required @param invoice [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Invoice, Integer, Hash)] Stripe::Invoice, response status code and response headers

Search for invoices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

@required @param query [String?] The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices). @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SearchResult]

<p>Search for invoices you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for invoices. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Search for invoices you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for invoices. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SearchResult, Integer, Hash)] Stripe::SearchResult, response status code and response headers

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

@optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. @optional @param subscription_proration_behavior [String?] Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/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. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/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`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. @optional @param subscription_trial_from_plan [Bool?] 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. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of `customer` if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. @return [Stripe::Invoice]

<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p> <p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p> <p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_details.proration_date</code> value passed in the request.</p> <p>Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. <a href=&quot;https://docs.stripe.com/currencies/conversions&quot;>Learn more</a></p> @optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use subscription_details.items instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use subscription_details.start_date instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param subscription_proration_behavior [String?] 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. The default value is create_prorations. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_behavior instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use subscription_details.resume_at instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_date instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at_period_end instead. @optional @param subscription_trial_from_plan [Bool?] 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. See Using trial periods on subscriptions to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of customer if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_now instead. @return nil

When retrieving an upcoming invoice, you’ll get a lines 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.

@optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. @optional @param subscription_proration_behavior [String?] Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/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. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/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`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. @optional @param subscription_trial_from_plan [Bool?] 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. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of `customer` if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. @return [Stripe::InvoiceLinesList]

<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> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use subscription_details.items instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use subscription_details.start_date instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param subscription_proration_behavior [String?] 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. The default value is create_prorations. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_behavior instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use subscription_details.resume_at instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_date instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at_period_end instead. @optional @param subscription_trial_from_plan [Bool?] 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. See Using trial periods on subscriptions to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of customer if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_now instead. @return nil

<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> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use subscription_details.items instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use subscription_details.start_date instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param subscription_proration_behavior [String?] 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. The default value is create_prorations. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_behavior instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use subscription_details.resume_at instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_date instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at_period_end instead. @optional @param subscription_trial_from_plan [Bool?] 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. See Using trial periods on subscriptions to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of customer if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_now instead. @return [Tuple(Stripe::InvoiceLinesList, Integer, Hash)] Stripe::InvoiceLinesList, response status code and response headers

<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p> <p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p> <p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_details.proration_date</code> value passed in the request.</p> <p>Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. <a href=&quot;https://docs.stripe.com/currencies/conversions&quot;>Learn more</a></p> @optional @param subscription_items [Array(Array(SubscriptionItemUpdateParams))?] A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use subscription_details.items instead. @optional @param subscription_cancel_at [Stripe::GetInvoicesUpcomingSubscriptionCancelAtParameter?] A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead. @optional @param preview_mode [String?] Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified. @optional @param subscription_start_date [Int32?] Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use subscription_details.start_date instead. @optional @param customer_details [Stripe::CustomerDetailsParam?] Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param subscription_proration_behavior [String?] 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. The default value is create_prorations. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_behavior instead. @optional @param subscription_billing_cycle_anchor [Stripe::GetInvoicesUpcomingSubscriptionBillingCycleAnchorParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead. @optional @param subscription_resume_at [String?] For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use subscription_details.resume_at instead. @optional @param subscription_proration_date [Int32?] 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 within the current phase of the schedule backing this subscription, if the schedule exists. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_date instead. @optional @param subscription_trial_end [Stripe::GetInvoicesUpcomingSubscriptionTrialEndParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead. @optional @param subscription_default_tax_rates [Stripe::GetInvoicesUpcomingSubscriptionDefaultTaxRatesParameter?] 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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead. @optional @param subscription_cancel_at_period_end [Bool?] Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at_period_end instead. @optional @param subscription_trial_from_plan [Bool?] 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. See Using trial periods on subscriptions to learn more. @optional @param invoice_items [Array(Array(InvoiceItemPreviewParams))?] List of invoice items to add or update in the upcoming invoice preview (up to 250). @optional @param automatic_tax [Stripe::AutomaticTaxParam?] Settings for automatic tax lookup for this invoice preview. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param coupon [String?] The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead. @optional @param on_behalf_of [Stripe::GetInvoicesUpcomingOnBehalfOfParameter?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details. @optional @param issuer [Stripe::ConnectAccountReference?] The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. @optional @param discounts [Stripe::GetInvoicesUpcomingDiscountsParameter?] The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. @optional @param currency [String?] The currency to preview this invoice in. Defaults to that of customer if not specified. @optional @param customer [String?] The identifier of the customer whose upcoming invoice you'd like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set. @optional @param schedule [String?] The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @optional @param subscription [String?] The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. @optional @param schedule_details [Stripe::ScheduleDetailsParams?] The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields. @optional @param subscription_details [Stripe::SubscriptionDetailsParams?] The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields. @optional @param subscription_cancel_now [Bool?] This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_now instead. @return [Tuple(Stripe::Invoice, Integer, Hash)] Stripe::Invoice, response status code and response headers

<p>You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.</p> @optional @param ending_before [String?] 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. @optional @param starting_after [String?] 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return invoices for the customer specified by this customer ID. @optional @param subscription [String?] Only return invoices for the subscription specified by this subscription ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return invoices that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param collection_method [String?] The collection method of the invoice to retrieve. Either charge_automatically or send_invoice. @optional @param status [String?] The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more @optional @param due_date [Stripe::GetAccountsCreatedParameter?] @return [Tuple(Stripe::InvoicesResourceList, Integer, Hash)] Stripe::InvoicesResourceList, response status code and response headers

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

@optional @param account_tax_ids [Stripe::PostInvoicesRequestAccountTaxIds?] @optional @param application_fee_amount [Int32?] A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). @optional @param auto_advance [Bool?] Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. @optional @param automatic_tax [Stripe::AutomaticTaxParam?] @optional @param collection_method [String?] Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`. @optional @param currency [String?] The currency to create this invoice in. Defaults to that of `customer` if not specified. @optional @param custom_fields [Stripe::PostInvoicesRequestCustomFields?] @optional @param customer [String?] The ID of the customer who will be billed. @optional @param days_until_due [Int32?] The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. @optional @param default_payment_method [String?] ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. @optional @param default_source [String?] ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. @optional @param default_tax_rates [Array(String)?] The tax rates that will apply to any line item that does not have `tax_rates` set. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. @optional @param discounts [Stripe::PostInvoicesRequestDiscounts?] @optional @param due_date [Int32?] The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. @optional @param effective_at [Int32?] The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param footer [String?] Footer to be displayed on the invoice. @optional @param from_invoice [Stripe::FromInvoice?] @optional @param issuer [Stripe::ConnectAccountReference?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param number [String?] Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. @optional @param on_behalf_of [String?] The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. @optional @param payment_settings [Stripe::PaymentSettings?] @optional @param pending_invoice_items_behavior [String?] How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. @optional @param rendering [Stripe::RenderingParam?] @optional @param shipping_cost [Stripe::ShippingCost?] @optional @param shipping_details [Stripe::RecipientShippingWithOptionalFieldsAddress?] @optional @param statement_descriptor [String?] Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. @optional @param subscription [String?] The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected. @optional @param transfer_data [Stripe::TransferDataSpecs?] @return [Stripe::Invoice]