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
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.
Invoice	delete() Delete an invoice.
Invoice	delete(RequestOptions options) Delete an invoice.
boolean	equals(java.lang.Object o)
Invoice	finalizeInvoice() Finalize an invoice.
Invoice	finalizeInvoice(java.util.Map<java.lang.String,java.lang.Object> params) Finalize an invoice.
Invoice	finalizeInvoice(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Finalize an invoice.
Invoice	finalizeInvoice(RequestOptions options) Finalize an invoice.
java.lang.Long	getAmountDue()
java.lang.Long	getAmountPaid()
java.lang.Long	getAmountRemaining()
java.lang.Long	getApplicationFee()
java.lang.Long	getAttemptCount()
java.lang.Boolean	getAttempted()
java.lang.Boolean	getAutoAdvance()
java.lang.String	getBilling()
java.lang.String	getBillingReason()
java.lang.String	getCharge()
Charge	getChargeObject()
java.lang.Boolean	getClosed() Deprecated. Prefer using the status attribute instead.
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getCustomer()
java.lang.Long	getDate()
java.lang.String	getDefaultSource()
ExternalAccount	getDefaultSourceObject()
java.lang.Boolean	getDeleted()
java.lang.String	getDescription()
Discount	getDiscount()
java.lang.Long	getDueDate()
java.lang.Long	getEndingBalance()
java.lang.Long	getFinalizedAt()
java.lang.Boolean	getForgiven() Deprecated. Prefer using the status attribute instead.
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	getStatus()
java.lang.String	getSubscription()
Subscription	getSubscriptionObject()
java.lang.Long	getSubscriptionProrationDate()
java.lang.Long	getSubtotal()
java.lang.Long	getTax()
java.math.BigDecimal	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	markUncollectible() Mark an invoice as uncollectible.
Invoice	markUncollectible(java.util.Map<java.lang.String,java.lang.Object> params) Mark an invoice as uncollectible.
Invoice	markUncollectible(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Mark an invoice as uncollectible.
Invoice	markUncollectible(RequestOptions options) Mark an invoice as uncollectible.
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.
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.
Invoice	sendInvoice() send an invoice.
Invoice	sendInvoice(java.util.Map<java.lang.String,java.lang.Object> params) send an invoice.
Invoice	sendInvoice(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) send an invoice.
Invoice	sendInvoice(RequestOptions options) send an invoice.
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.Long attemptCount)
void	setAttempted(java.lang.Boolean attempted)
void	setAutoAdvance(java.lang.Boolean autoAdvance)
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) Deprecated. Prefer using the status attribute instead.
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	setDefaultSource(java.lang.String defaultSourceId)
void	setDefaultSourceObject(ExternalAccount c)
void	setDeleted(java.lang.Boolean deleted)
void	setDescription(java.lang.String description)
void	setDiscount(Discount discount)
void	setDueDate(java.lang.Long dueDate)
void	setEndingBalance(java.lang.Long endingBalance)
void	setFinalizedAt(java.lang.Long finalizedAt)
void	setForgiven(java.lang.Boolean forgiven) Deprecated. Prefer using the status attribute instead.
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	setStatus(java.lang.String status)
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.math.BigDecimal 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.
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	voidInvoice() void an invoice.
Invoice	voidInvoice(java.util.Map<java.lang.String,java.lang.Object> params) void an invoice.
Invoice	voidInvoice(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) void an invoice.
Invoice	voidInvoice(RequestOptions options) void an invoice.

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)

getDefaultSource

public java.lang.String getDefaultSource()

setDefaultSource

public void setDefaultSource(java.lang.String defaultSourceId)

getDefaultSourceObject

public ExternalAccount getDefaultSourceObject()

setDefaultSourceObject

public void setDefaultSourceObject(ExternalAccount c)

getSubscription

public java.lang.String getSubscription()

setSubscription

public void setSubscription(java.lang.String subscriptionId)

getSubscriptionObject

public Subscription getSubscriptionObject()

setSubscriptionObject

public void setSubscriptionObject(Subscription subscription)

create

public static Invoice create(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws StripeException

Create an invoice.

Throws:

StripeException

create

public static Invoice create(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException

Create an invoice.

Throws:

StripeException

delete

public Invoice delete()
               throws StripeException

Delete an invoice.

Throws:

StripeException

delete

public Invoice delete(RequestOptions options)
               throws StripeException

Delete an invoice.

Throws:

StripeException

list

public static InvoiceCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                              throws StripeException

List all invoices.

Throws:

StripeException

list

public static InvoiceCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                     RequestOptions options)
                              throws StripeException

List all invoices.

Throws:

StripeException

finalizeInvoice

public Invoice finalizeInvoice()
                        throws StripeException

Finalize an invoice.

Throws:

StripeException

finalizeInvoice

public Invoice finalizeInvoice(RequestOptions options)
                        throws StripeException

Finalize an invoice.

Throws:

StripeException

finalizeInvoice

public Invoice finalizeInvoice(java.util.Map<java.lang.String,java.lang.Object> params)
                        throws StripeException

Finalize an invoice.

Throws:

StripeException

finalizeInvoice

public Invoice finalizeInvoice(java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException

Finalize an invoice.

Throws:

StripeException

markUncollectible

public Invoice markUncollectible()
                          throws StripeException

Mark an invoice as uncollectible.

Throws:

StripeException

markUncollectible

public Invoice markUncollectible(RequestOptions options)
                          throws StripeException

Mark an invoice as uncollectible.

Throws:

StripeException

markUncollectible

public Invoice markUncollectible(java.util.Map<java.lang.String,java.lang.Object> params)
                          throws StripeException

Mark an invoice as uncollectible.

Throws:

StripeException

markUncollectible

public Invoice markUncollectible(java.util.Map<java.lang.String,java.lang.Object> params,
                                 RequestOptions options)
                          throws StripeException

Mark an invoice as uncollectible.

Throws:

StripeException

pay

public Invoice pay()
            throws StripeException

Pay an invoice.

Throws:

StripeException

pay

public Invoice pay(RequestOptions options)
            throws StripeException

Pay an invoice.

Throws:

StripeException

pay

public Invoice pay(java.util.Map<java.lang.String,java.lang.Object> params)
            throws StripeException

Pay an invoice.

Throws:

StripeException

pay

public Invoice pay(java.util.Map<java.lang.String,java.lang.Object> params,
                   RequestOptions options)
            throws StripeException

Pay an invoice.

Throws:

StripeException

retrieve

public static Invoice retrieve(java.lang.String id)
                        throws StripeException

Retrieve an invoice.

Throws:

StripeException

retrieve

public static Invoice retrieve(java.lang.String id,
                               RequestOptions options)
                        throws StripeException

Retrieve an invoice.

Throws:

StripeException

retrieve

public static Invoice retrieve(java.lang.String id,
                               java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException

Retrieve an invoice.

Throws:

StripeException

sendInvoice

public Invoice sendInvoice()
                    throws StripeException

send an invoice.

Throws:

StripeException

sendInvoice

public Invoice sendInvoice(RequestOptions options)
                    throws StripeException

send an invoice.

Throws:

StripeException

sendInvoice

public Invoice sendInvoice(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

send an invoice.

Throws:

StripeException

sendInvoice

public Invoice sendInvoice(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

send an invoice.

Throws:

StripeException

upcoming

public static Invoice upcoming(java.util.Map<java.lang.String,java.lang.Object> params)
                        throws StripeException

Retrieve an upcoming invoice.

Throws:

StripeException

upcoming

public static Invoice upcoming(java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException

Retrieve an upcoming invoice.

Throws:

StripeException

update

public Invoice update(java.util.Map<java.lang.String,java.lang.Object> params)
               throws StripeException

Update an invoice.

Specified by:

update in interface MetadataStore<Invoice>

Throws:

StripeException

update

public Invoice update(java.util.Map<java.lang.String,java.lang.Object> params,
                      RequestOptions options)
               throws StripeException

Update an invoice.

Specified by:

update in interface MetadataStore<Invoice>

Throws:

StripeException

voidInvoice

public Invoice voidInvoice()
                    throws StripeException

void an invoice.

Throws:

StripeException

voidInvoice

public Invoice voidInvoice(RequestOptions options)
                    throws StripeException

void an invoice.

Throws:

StripeException

voidInvoice

public Invoice voidInvoice(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

void an invoice.

Throws:

StripeException

voidInvoice

public Invoice voidInvoice(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

void an invoice.

Throws:

StripeException

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.Long getAttemptCount()

getAttempted

public java.lang.Boolean getAttempted()

getAutoAdvance

public java.lang.Boolean getAutoAdvance()

getBilling

public java.lang.String getBilling()

getBillingReason

public java.lang.String getBillingReason()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getCustomer

public java.lang.String getCustomer()

getDate

public java.lang.Long getDate()

getDeleted

public java.lang.Boolean getDeleted()

getDescription

public java.lang.String getDescription()

getDiscount

public Discount getDiscount()

getDueDate

public java.lang.Long getDueDate()

getEndingBalance

public java.lang.Long getEndingBalance()

getFinalizedAt

public java.lang.Long getFinalizedAt()

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()

getStatus

public java.lang.String getStatus()

getSubscriptionProrationDate

public java.lang.Long getSubscriptionProrationDate()

getSubtotal

public java.lang.Long getSubtotal()

getTax

public java.lang.Long getTax()

getTaxPercent

public java.math.BigDecimal getTaxPercent()

getTotal

public java.lang.Long getTotal()

getWebhooksDeliveredAt

public java.lang.Long getWebhooksDeliveredAt()

getClosed

@Deprecated
public java.lang.Boolean getClosed()

Deprecated. Prefer using the status attribute instead.

The closed attribute.

getForgiven

@Deprecated
public java.lang.Boolean getForgiven()

Deprecated. Prefer using the status attribute instead.

The forgiven attribute.

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.Long attemptCount)

setAttempted

public void setAttempted(java.lang.Boolean attempted)

setAutoAdvance

public void setAutoAdvance(java.lang.Boolean autoAdvance)

setBilling

public void setBilling(java.lang.String billing)

setBillingReason

public void setBillingReason(java.lang.String billingReason)

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)

setDeleted

public void setDeleted(java.lang.Boolean deleted)

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)

setFinalizedAt

public void setFinalizedAt(java.lang.Long finalizedAt)

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)

setStatus

public void setStatus(java.lang.String status)

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.math.BigDecimal taxPercent)

setTotal

public void setTotal(java.lang.Long total)

setWebhooksDeliveredAt

public void setWebhooksDeliveredAt(java.lang.Long webhooksDeliveredAt)

setClosed

@Deprecated
public void setClosed(java.lang.Boolean closed)

Deprecated. Prefer using the status attribute instead.

The closed attribute.

setForgiven

@Deprecated
public void setForgiven(java.lang.Boolean forgiven)

Deprecated. Prefer using the status attribute instead.

The forgiven attribute.

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>