com.stripe.model

Class Invoice

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Invoice

All Implemented Interfaces:

HasId, MetadataStore<Invoice>

public class Invoice
extends APIResource
implements MetadataStore<Invoice>, HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

APIResource.RequestMethod, APIResource.RequestType

Field Summary

Fields inherited from class com.stripe.net.APIResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Invoice()

Method Summary

Modifier and Type	Method and Description
static InvoiceCollection	all(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static InvoiceCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
static InvoiceCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Invoice	create(java.util.Map<java.lang.String,java.lang.Object> params) Create an invoice.
static Invoice	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Create an invoice.
static Invoice	create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
java.lang.Long	getAmountDue()
java.lang.Long	getAmountPaid()
java.lang.Long	getAmountRemaining()
java.lang.Long	getApplicationFee()
java.lang.Integer	getAttemptCount()
java.lang.Boolean	getAttempted()
java.lang.String	getBilling()
java.lang.String	getBillingReason()
java.lang.String	getCharge()
Charge	getChargeObject()
java.lang.Boolean	getClosed()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getCustomer()
java.lang.Long	getDate()
java.lang.String	getDescription()
Discount	getDiscount()
java.lang.Long	getDueDate()
java.lang.Long	getEndingBalance()
java.lang.Boolean	getForgiven()
java.lang.String	getHostedInvoiceURL()
java.lang.String	getId()
java.lang.String	getInvoicePDF()
InvoiceLineItemCollection	getLines()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.Long	getNextPaymentAttempt()
java.lang.String	getNumber()
java.lang.String	getObject()
java.lang.Boolean	getPaid()
java.lang.Long	getPeriodEnd()
java.lang.Long	getPeriodStart()
java.lang.String	getReceiptNumber()
java.lang.Long	getStartingBalance()
java.lang.String	getStatementDescriptor()
java.lang.String	getSubscription()
Subscription	getSubscriptionObject()
java.lang.Long	getSubscriptionProrationDate()
java.lang.Long	getSubtotal()
java.lang.Long	getTax()
java.lang.Double	getTaxPercent()
java.lang.Long	getTotal()
java.lang.Long	getWebhooksDeliveredAt()
int	hashCode()
static InvoiceCollection	list(java.util.Map<java.lang.String,java.lang.Object> params) List all invoices.
static InvoiceCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) List all invoices.
Invoice	pay() Pay an invoice.
Invoice	pay(java.util.Map<java.lang.String,java.lang.Object> params) Pay an invoice.
Invoice	pay(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Pay an invoice.
Invoice	pay(RequestOptions options) Pay an invoice.
Invoice	pay(java.lang.String apiKey) Deprecated. Use the pay(RequestOptions) method instead. This method will be removed in the next major version.
static Invoice	retrieve(java.lang.String id) Retrieve an invoice.
static Invoice	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieve an invoice.
static Invoice	retrieve(java.lang.String id, RequestOptions options) Retrieve an invoice.
static Invoice	retrieve(java.lang.String id, java.lang.String apiKey) Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.
void	setAmountDue(java.lang.Long amountDue)
void	setAmountPaid(java.lang.Long amountPaid)
void	setAmountRemaining(java.lang.Long amountRemaining)
void	setApplicationFee(java.lang.Long applicationFee)
void	setAttemptCount(java.lang.Integer attemptCount)
void	setAttempted(java.lang.Boolean attempted)
void	setBilling(java.lang.String billing)
void	setBillingReason(java.lang.String billingReason)
void	setCharge(java.lang.String chargeID)
void	setChargeObject(Charge charge)
void	setClosed(java.lang.Boolean closed)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setCustomer(java.lang.String customer)
void	setDate(java.lang.Long date)
void	setDescription(java.lang.String description)
void	setDiscount(Discount discount)
void	setDueDate(java.lang.Long dueDate)
void	setEndingBalance(java.lang.Long endingBalance)
void	setForgiven(java.lang.Boolean forgiven)
void	setHostedInvoiceURL(java.lang.String hostedInvoiceURL)
void	setId(java.lang.String id)
void	setInvoicePDF(java.lang.String invoicePDF)
void	setLines(InvoiceLineItemCollection lines)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setNextPaymentAttempt(java.lang.Long nextPaymentAttempt)
void	setNumber(java.lang.String number)
void	setObject(java.lang.String object)
void	setPaid(java.lang.Boolean paid)
void	setPeriodEnd(java.lang.Long periodEnd)
void	setPeriodStart(java.lang.Long periodStart)
void	setReceiptNumber(java.lang.String receiptNumber)
void	setStartingBalance(java.lang.Long startingBalance)
void	setStatementDescriptor(java.lang.String statementDescriptor)
void	setSubscription(java.lang.String subscriptionID)
void	setSubscriptionObject(Subscription subscription)
void	setSubscriptionProrationDate(java.lang.Long subscriptionProrationDate)
void	setSubtotal(java.lang.Long subtotal)
void	setTax(java.lang.Long tax)
void	setTaxPercent(java.lang.Double taxPercent)
void	setTotal(java.lang.Long total)
void	setWebhooksDeliveredAt(java.lang.Long webhooksDeliveredAt)
static Invoice	upcoming(java.util.Map<java.lang.String,java.lang.Object> params) Retrieve an upcoming invoice.
static Invoice	upcoming(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieve an upcoming invoice.
static Invoice	upcoming(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the upcoming(Map, RequestOptions) method instead. This method will be removed in the next major version.
Invoice	update(java.util.Map<java.lang.String,java.lang.Object> params) Update an invoice.
Invoice	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Update an invoice.
Invoice	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Invoice

public Invoice()

Method Detail

getCharge

public java.lang.String getCharge()

setCharge

public void setCharge(java.lang.String chargeID)

getChargeObject

public Charge getChargeObject()

setChargeObject

public void setChargeObject(Charge charge)

getSubscription

public java.lang.String getSubscription()

setSubscription

public void setSubscription(java.lang.String subscriptionID)

getSubscriptionObject

public Subscription getSubscriptionObject()

setSubscriptionObject

public void setSubscriptionObject(Subscription subscription)

all

@Deprecated
public static InvoiceCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                                         throws AuthenticationException,
                                                InvalidRequestException,
                                                APIConnectionException,
                                                CardException,
                                                APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all invoices.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static InvoiceCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                RequestOptions options)
                                         throws AuthenticationException,
                                                InvalidRequestException,
                                                APIConnectionException,
                                                CardException,
                                                APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all invoices.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static InvoiceCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                java.lang.String apiKey)
                                         throws AuthenticationException,
                                                InvalidRequestException,
                                                APIConnectionException,
                                                CardException,
                                                APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all invoices.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Invoice create(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Create an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Invoice create(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Create an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

@Deprecated
public static Invoice create(java.util.Map<java.lang.String,java.lang.Object> params,
                                         java.lang.String apiKey)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.

Create an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static InvoiceCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

List all invoices.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static InvoiceCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                     RequestOptions options)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

List all invoices.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

pay

public Invoice pay()
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Pay an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

pay

public Invoice pay(RequestOptions options)
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Pay an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

pay

@Deprecated
public Invoice pay(java.lang.String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Deprecated. Use the pay(RequestOptions) method instead. This method will be removed in the next major version.

Pay an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

pay

public Invoice pay(java.util.Map<java.lang.String,java.lang.Object> params)
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Pay an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

pay

public Invoice pay(java.util.Map<java.lang.String,java.lang.Object> params,
                   RequestOptions options)
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Pay an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Invoice retrieve(java.lang.String id)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Invoice retrieve(java.lang.String id,
                               RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

@Deprecated
public static Invoice retrieve(java.lang.String id,
                                           java.lang.String apiKey)
                                    throws AuthenticationException,
                                           InvalidRequestException,
                                           APIConnectionException,
                                           CardException,
                                           APIException

Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.

Retrieve an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Invoice retrieve(java.lang.String id,
                               java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upcoming

public static Invoice upcoming(java.util.Map<java.lang.String,java.lang.Object> params)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve an upcoming invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upcoming

public static Invoice upcoming(java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Retrieve an upcoming invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upcoming

@Deprecated
public static Invoice upcoming(java.util.Map<java.lang.String,java.lang.Object> params,
                                           java.lang.String apiKey)
                                    throws AuthenticationException,
                                           InvalidRequestException,
                                           APIConnectionException,
                                           CardException,
                                           APIException

Deprecated. Use the upcoming(Map, RequestOptions) method instead. This method will be removed in the next major version.

Retrieve an upcoming invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Invoice update(java.util.Map<java.lang.String,java.lang.Object> params)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Update an invoice.

Specified by:

update in interface MetadataStore<Invoice>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Invoice update(java.util.Map<java.lang.String,java.lang.Object> params,
                      RequestOptions options)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Update an invoice.

Specified by:

update in interface MetadataStore<Invoice>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Invoice update(java.util.Map<java.lang.String,java.lang.Object> params,
                                  java.lang.String apiKey)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update an invoice.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getAmountDue

public java.lang.Long getAmountDue()

getAmountPaid

public java.lang.Long getAmountPaid()

getAmountRemaining

public java.lang.Long getAmountRemaining()

getApplicationFee

public java.lang.Long getApplicationFee()

getAttemptCount

public java.lang.Integer getAttemptCount()

getAttempted

public java.lang.Boolean getAttempted()

getBilling

public java.lang.String getBilling()

getBillingReason

public java.lang.String getBillingReason()

getClosed

public java.lang.Boolean getClosed()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getCustomer

public java.lang.String getCustomer()

getDate

public java.lang.Long getDate()

getDescription

public java.lang.String getDescription()

getDiscount

public Discount getDiscount()

getDueDate

public java.lang.Long getDueDate()

getEndingBalance

public java.lang.Long getEndingBalance()

getForgiven

public java.lang.Boolean getForgiven()

getHostedInvoiceURL

public java.lang.String getHostedInvoiceURL()

getInvoicePDF

public java.lang.String getInvoicePDF()

getLines

public InvoiceLineItemCollection getLines()

getLivemode

public java.lang.Boolean getLivemode()

getNextPaymentAttempt

public java.lang.Long getNextPaymentAttempt()

getNumber

public java.lang.String getNumber()

getPaid

public java.lang.Boolean getPaid()

getPeriodEnd

public java.lang.Long getPeriodEnd()

getPeriodStart

public java.lang.Long getPeriodStart()

getReceiptNumber

public java.lang.String getReceiptNumber()

getStartingBalance

public java.lang.Long getStartingBalance()

getStatementDescriptor

public java.lang.String getStatementDescriptor()

getSubscriptionProrationDate

public java.lang.Long getSubscriptionProrationDate()

getSubtotal

public java.lang.Long getSubtotal()

getTax

public java.lang.Long getTax()

getTaxPercent

public java.lang.Double getTaxPercent()

getTotal

public java.lang.Long getTotal()

getWebhooksDeliveredAt

public java.lang.Long getWebhooksDeliveredAt()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setAmountDue

public void setAmountDue(java.lang.Long amountDue)

setAmountPaid

public void setAmountPaid(java.lang.Long amountPaid)

setAmountRemaining

public void setAmountRemaining(java.lang.Long amountRemaining)

setApplicationFee

public void setApplicationFee(java.lang.Long applicationFee)

setAttemptCount

public void setAttemptCount(java.lang.Integer attemptCount)

setAttempted

public void setAttempted(java.lang.Boolean attempted)

setBilling

public void setBilling(java.lang.String billing)

setBillingReason

public void setBillingReason(java.lang.String billingReason)

setClosed

public void setClosed(java.lang.Boolean closed)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setCustomer

public void setCustomer(java.lang.String customer)

setDate

public void setDate(java.lang.Long date)

setDescription

public void setDescription(java.lang.String description)

setDiscount

public void setDiscount(Discount discount)

setDueDate

public void setDueDate(java.lang.Long dueDate)

setEndingBalance

public void setEndingBalance(java.lang.Long endingBalance)

setForgiven

public void setForgiven(java.lang.Boolean forgiven)

setHostedInvoiceURL

public void setHostedInvoiceURL(java.lang.String hostedInvoiceURL)

setInvoicePDF

public void setInvoicePDF(java.lang.String invoicePDF)

setLines

public void setLines(InvoiceLineItemCollection lines)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setNextPaymentAttempt

public void setNextPaymentAttempt(java.lang.Long nextPaymentAttempt)

setNumber

public void setNumber(java.lang.String number)

setPaid

public void setPaid(java.lang.Boolean paid)

setPeriodEnd

public void setPeriodEnd(java.lang.Long periodEnd)

setPeriodStart

public void setPeriodStart(java.lang.Long periodStart)

setReceiptNumber

public void setReceiptNumber(java.lang.String receiptNumber)

setStartingBalance

public void setStartingBalance(java.lang.Long startingBalance)

setStatementDescriptor

public void setStatementDescriptor(java.lang.String statementDescriptor)

setSubscriptionProrationDate

public void setSubscriptionProrationDate(java.lang.Long subscriptionProrationDate)

setSubtotal

public void setSubtotal(java.lang.Long subtotal)

setTax

public void setTax(java.lang.Long tax)

setTaxPercent

public void setTaxPercent(java.lang.Double taxPercent)

setTotal

public void setTotal(java.lang.Long total)

setWebhooksDeliveredAt

public void setWebhooksDeliveredAt(java.lang.Long webhooksDeliveredAt)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Invoice>