Package com.stripe.model

Class InvoicePayment

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.InvoicePayment
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class InvoicePayment extends ApiResource implements HasId
Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways: 1. By expanding the payments field on the Invoice resource. 2. By using the Invoice Payment retrieve and list endpoints.

Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and monitor the allocation details of the payments.

  • Constructor Details

    • InvoicePayment

      public InvoicePayment()

  • Method Details

    • getInvoice

      public String getInvoice()
      Get ID of expandable invoice object.

    • setInvoice

      public void setInvoice(String id)

    • getInvoiceObject

      public Invoice getInvoiceObject()
      Get expanded invoice.

    • setInvoiceObject

      public void setInvoiceObject(Invoice expandableObject)

    • list

      public static InvoicePaymentCollection list(Map<String,Object> params) throws StripeException
      When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
      Throws:
      StripeException

    • list

      public static InvoicePaymentCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
      Throws:
      StripeException

    • list

      public static InvoicePaymentCollection list(InvoicePaymentListParams params) throws StripeException
      When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
      Throws:
      StripeException

    • list

      public static InvoicePaymentCollection list(InvoicePaymentListParams params, RequestOptions options) throws StripeException
      When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
      Throws:
      StripeException

    • retrieve

      public static InvoicePayment retrieve(String invoicePayment) throws StripeException
      Retrieves the invoice payment with the given ID.
      Throws:
      StripeException

    • retrieve

      public static InvoicePayment retrieve(String invoicePayment, RequestOptions options) throws StripeException
      Retrieves the invoice payment with the given ID.
      Throws:
      StripeException

    • retrieve

      public static InvoicePayment retrieve(String invoicePayment, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the invoice payment with the given ID.
      Throws:
      StripeException

    • retrieve

      public static InvoicePayment retrieve(String invoicePayment, InvoicePaymentRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the invoice payment with the given ID.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAmountPaid

      public Long getAmountPaid()
      Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to.

    • getAmountRequested

      public Long getAmountRequested()
      Amount intended to be paid toward this invoice, in cents (or local equivalent).

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getIsDefault

      public Boolean getIsDefault()
      Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to invoice_payment.

    • getPayment

      public InvoicePayment.Payment getPayment()

    • getStatus

      public String getStatus()
      The status of the payment, one of open, paid, or canceled.

    • getStatusTransitions

      public InvoicePayment.StatusTransitions getStatusTransitions()

    • setAmountPaid

      public void setAmountPaid(Long amountPaid)
      Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to.

    • setAmountRequested

      public void setAmountRequested(Long amountRequested)
      Amount intended to be paid toward this invoice, in cents (or local equivalent).

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setIsDefault

      public void setIsDefault(Boolean isDefault)
      Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to invoice_payment.

    • setPayment

      public void setPayment(InvoicePayment.Payment payment)

    • setStatus

      public void setStatus(String status)
      The status of the payment, one of open, paid, or canceled.

    • setStatusTransitions

      public void setStatusTransitions(InvoicePayment.StatusTransitions statusTransitions)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId