Package com.stripe.service

Class InvoiceService

java.lang.Object
com.stripe.net.ApiService
com.stripe.service.InvoiceService
public final class InvoiceService extends ApiService

  • Constructor Details

  • Method Details

    • delete

      public Invoice delete(String invoice) throws StripeException
      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.
      Throws:
      StripeException

    • delete

      public Invoice delete(String invoice, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • retrieve

      public Invoice retrieve(String invoice, InvoiceRetrieveParams params) throws StripeException
      Retrieves the invoice with the given ID.
      Throws:
      StripeException

    • retrieve

      public Invoice retrieve(String invoice, RequestOptions options) throws StripeException
      Retrieves the invoice with the given ID.
      Throws:
      StripeException

    • retrieve

      public Invoice retrieve(String invoice) throws StripeException
      Retrieves the invoice with the given ID.
      Throws:
      StripeException

    • retrieve

      public Invoice retrieve(String invoice, InvoiceRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the invoice with the given ID.
      Throws:
      StripeException

    • update

      public Invoice update(String invoice, InvoiceUpdateParams params) throws StripeException
      Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

      If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

      Throws:
      StripeException

    • update

      public Invoice update(String invoice, RequestOptions options) throws StripeException
      Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

      If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

      Throws:
      StripeException

    • update

      public Invoice update(String invoice) throws StripeException
      Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

      If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

      Throws:
      StripeException

    • update

      public Invoice update(String invoice, InvoiceUpdateParams params, RequestOptions options) throws StripeException
      Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

      If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

      Throws:
      StripeException

    • list

      public StripeCollection<Invoice> list(InvoiceListParams params) throws StripeException
      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.
      Throws:
      StripeException

    • list

      public StripeCollection<Invoice> list(RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • list

      public StripeCollection<Invoice> list() throws StripeException
      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.
      Throws:
      StripeException

    • list

      public StripeCollection<Invoice> list(InvoiceListParams params, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • create

      public Invoice create(InvoiceCreateParams params) throws StripeException
      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.
      Throws:
      StripeException

    • create

      public Invoice create(RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • create

      public Invoice create() throws StripeException
      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.
      Throws:
      StripeException

    • create

      public Invoice create(InvoiceCreateParams params, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • search

      public StripeSearchResult<Invoice> search(InvoiceSearchParams params) throws StripeException
      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.
      Throws:
      StripeException

    • search

      public StripeSearchResult<Invoice> search(InvoiceSearchParams params, RequestOptions options) throws StripeException
      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.
      Throws:
      StripeException

    • upcoming

      public Invoice upcoming(InvoiceUpcomingParams params) throws StripeException
      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

      Throws:
      StripeException

    • upcoming

      public Invoice upcoming(RequestOptions options) throws StripeException
      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

      Throws:
      StripeException

    • upcoming

      public Invoice upcoming() throws StripeException
      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

      Throws:
      StripeException

    • upcoming

      public Invoice upcoming(InvoiceUpcomingParams params, RequestOptions options) throws StripeException
      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

      Throws:
      StripeException

    • finalizeInvoice

      public Invoice finalizeInvoice(String invoice, InvoiceFinalizeInvoiceParams params) throws StripeException
      Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.
      Throws:
      StripeException

    • finalizeInvoice

      public Invoice finalizeInvoice(String invoice, RequestOptions options) throws StripeException
      Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.
      Throws:
      StripeException

    • finalizeInvoice

      public Invoice finalizeInvoice(String invoice) throws StripeException
      Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.
      Throws:
      StripeException

    • finalizeInvoice

      public Invoice finalizeInvoice(String invoice, InvoiceFinalizeInvoiceParams params, RequestOptions options) throws StripeException
      Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.
      Throws:
      StripeException

    • markUncollectible

      public Invoice markUncollectible(String invoice, InvoiceMarkUncollectibleParams params) throws StripeException
      Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
      Throws:
      StripeException

    • markUncollectible

      public Invoice markUncollectible(String invoice, RequestOptions options) throws StripeException
      Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
      Throws:
      StripeException

    • markUncollectible

      public Invoice markUncollectible(String invoice) throws StripeException
      Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
      Throws:
      StripeException

    • markUncollectible

      public Invoice markUncollectible(String invoice, InvoiceMarkUncollectibleParams params, RequestOptions options) throws StripeException
      Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
      Throws:
      StripeException

    • pay

      public Invoice pay(String invoice, InvoicePayParams params) throws StripeException
      Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
      Throws:
      StripeException

    • pay

      public Invoice pay(String invoice, RequestOptions options) throws StripeException
      Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
      Throws:
      StripeException

    • pay

      public Invoice pay(String invoice) throws StripeException
      Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
      Throws:
      StripeException

    • pay

      public Invoice pay(String invoice, InvoicePayParams params, RequestOptions options) throws StripeException
      Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
      Throws:
      StripeException

    • sendInvoice

      public Invoice sendInvoice(String invoice, InvoiceSendInvoiceParams params) throws StripeException
      Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

      Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

      Throws:
      StripeException

    • sendInvoice

      public Invoice sendInvoice(String invoice, RequestOptions options) throws StripeException
      Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

      Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

      Throws:
      StripeException

    • sendInvoice

      public Invoice sendInvoice(String invoice) throws StripeException
      Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

      Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

      Throws:
      StripeException

    • sendInvoice

      public Invoice sendInvoice(String invoice, InvoiceSendInvoiceParams params, RequestOptions options) throws StripeException
      Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

      Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

      Throws:
      StripeException

    • voidInvoice

      public Invoice voidInvoice(String invoice, InvoiceVoidInvoiceParams params) throws StripeException
      Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

      Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

      Throws:
      StripeException

    • voidInvoice

      public Invoice voidInvoice(String invoice, RequestOptions options) throws StripeException
      Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

      Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

      Throws:
      StripeException

    • voidInvoice

      public Invoice voidInvoice(String invoice) throws StripeException
      Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

      Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

      Throws:
      StripeException

    • voidInvoice

      public Invoice voidInvoice(String invoice, InvoiceVoidInvoiceParams params, RequestOptions options) throws StripeException
      Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

      Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

      Throws:
      StripeException

    • createPreview

      public Invoice createPreview(InvoiceCreatePreviewParams params) throws StripeException
      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

      Throws:
      StripeException

    • createPreview

      public Invoice createPreview(RequestOptions options) throws StripeException
      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

      Throws:
      StripeException

    • createPreview

      public Invoice createPreview() throws StripeException
      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

      Throws:
      StripeException

    • createPreview

      public Invoice createPreview(InvoiceCreatePreviewParams params, RequestOptions options) throws StripeException
      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

      Throws:
      StripeException

    • lineItems

      public InvoiceLineItemService lineItems()

    • upcomingLines

      public InvoiceUpcomingLinesService upcomingLines()