Package com.stripe.service

Class CreditNoteService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.CreditNoteService

public final class CreditNoteService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
CreditNoteService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
CreditNote	create(CreditNoteCreateParams params)	Issue a credit note to adjust the amount of a finalized invoice.
CreditNote	create(CreditNoteCreateParams params, RequestOptions options)	Issue a credit note to adjust the amount of a finalized invoice.
CreditNoteLineItemService	lineItems()
StripeCollection<CreditNote>	list()	Returns a list of credit notes.
StripeCollection<CreditNote>	list(RequestOptions options)	Returns a list of credit notes.
StripeCollection<CreditNote>	list(CreditNoteListParams params)	Returns a list of credit notes.
StripeCollection<CreditNote>	list(CreditNoteListParams params, RequestOptions options)	Returns a list of credit notes.
CreditNote	preview(CreditNotePreviewParams params)	Get a preview of a credit note without creating it.
CreditNote	preview(CreditNotePreviewParams params, RequestOptions options)	Get a preview of a credit note without creating it.
CreditNotePreviewLinesService	previewLines()
CreditNote	retrieve(String id)	Retrieves the credit note object with the given identifier.
CreditNote	retrieve(String id, RequestOptions options)	Retrieves the credit note object with the given identifier.
CreditNote	retrieve(String id, CreditNoteRetrieveParams params)	Retrieves the credit note object with the given identifier.
CreditNote	retrieve(String id, CreditNoteRetrieveParams params, RequestOptions options)	Retrieves the credit note object with the given identifier.
CreditNote	update(String id)	Updates an existing credit note.
CreditNote	update(String id, RequestOptions options)	Updates an existing credit note.
CreditNote	update(String id, CreditNoteUpdateParams params)	Updates an existing credit note.
CreditNote	update(String id, CreditNoteUpdateParams params, RequestOptions options)	Updates an existing credit note.
CreditNote	voidCreditNote(String id)	Marks a credit note as void.
CreditNote	voidCreditNote(String id, RequestOptions options)	Marks a credit note as void.
CreditNote	voidCreditNote(String id, CreditNoteVoidCreditNoteParams params)	Marks a credit note as void.
CreditNote	voidCreditNote(String id, CreditNoteVoidCreditNoteParams params, RequestOptions options)	Marks a credit note as void.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CreditNoteService

public CreditNoteService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<CreditNote> list(CreditNoteListParams params)
                                  throws StripeException

Returns a list of credit notes.

Throws:

StripeException

list

public StripeCollection<CreditNote> list(RequestOptions options)
                                  throws StripeException

Returns a list of credit notes.

Throws:

StripeException

list

public StripeCollection<CreditNote> list()
                                  throws StripeException

Returns a list of credit notes.

Throws:

StripeException

list

public StripeCollection<CreditNote> list(CreditNoteListParams params,
 RequestOptions options)
                                  throws StripeException

Returns a list of credit notes.

Throws:

StripeException

create

public CreditNote create(CreditNoteCreateParams params)
                  throws StripeException

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

• Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
• Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
• Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

Throws:

StripeException

create

public CreditNote create(CreditNoteCreateParams params,
 RequestOptions options)
                  throws StripeException

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

• Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
• Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
• Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

Throws:

StripeException

retrieve

public CreditNote retrieve(String id,
 CreditNoteRetrieveParams params)
                    throws StripeException

Retrieves the credit note object with the given identifier.

Throws:

StripeException

retrieve

public CreditNote retrieve(String id,
 RequestOptions options)
                    throws StripeException

Retrieves the credit note object with the given identifier.

Throws:

StripeException

retrieve

public CreditNote retrieve(String id)
                    throws StripeException

Retrieves the credit note object with the given identifier.

Throws:

StripeException

retrieve

public CreditNote retrieve(String id,
 CreditNoteRetrieveParams params,
 RequestOptions options)
                    throws StripeException

Retrieves the credit note object with the given identifier.

Throws:

StripeException

update

public CreditNote update(String id,
 CreditNoteUpdateParams params)
                  throws StripeException

Updates an existing credit note.

Throws:

StripeException

update

public CreditNote update(String id,
 RequestOptions options)
                  throws StripeException

Updates an existing credit note.

Throws:

StripeException

update

public CreditNote update(String id)
                  throws StripeException

Updates an existing credit note.

Throws:

StripeException

update

public CreditNote update(String id,
 CreditNoteUpdateParams params,
 RequestOptions options)
                  throws StripeException

Updates an existing credit note.

Throws:

StripeException

preview

public CreditNote preview(CreditNotePreviewParams params)
                   throws StripeException

Get a preview of a credit note without creating it.

Throws:

StripeException

preview

public CreditNote preview(CreditNotePreviewParams params,
 RequestOptions options)
                   throws StripeException

Get a preview of a credit note without creating it.

Throws:

StripeException

voidCreditNote

public CreditNote voidCreditNote(String id,
 CreditNoteVoidCreditNoteParams params)
                          throws StripeException

Marks a credit note as void. Learn more about voiding credit notes.

Throws:

StripeException

voidCreditNote

public CreditNote voidCreditNote(String id,
 RequestOptions options)
                          throws StripeException

Marks a credit note as void. Learn more about voiding credit notes.

Throws:

StripeException

voidCreditNote

public CreditNote voidCreditNote(String id)
                          throws StripeException

Marks a credit note as void. Learn more about voiding credit notes.

Throws:

StripeException

voidCreditNote

public CreditNote voidCreditNote(String id,
 CreditNoteVoidCreditNoteParams params,
 RequestOptions options)
                          throws StripeException

Marks a credit note as void. Learn more about voiding credit notes.

Throws:

StripeException

lineItems

public CreditNoteLineItemService lineItems()

previewLines

public CreditNotePreviewLinesService previewLines()