com.stripe.model.Invoice Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.model.testhelpers.TestClock;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.InvoiceAddLinesParams;
import com.stripe.param.InvoiceAttachPaymentIntentParams;
import com.stripe.param.InvoiceAttachPaymentParams;
import com.stripe.param.InvoiceCreateParams;
import com.stripe.param.InvoiceCreatePreviewParams;
import com.stripe.param.InvoiceFinalizeInvoiceParams;
import com.stripe.param.InvoiceListParams;
import com.stripe.param.InvoiceMarkUncollectibleParams;
import com.stripe.param.InvoicePayParams;
import com.stripe.param.InvoiceRemoveLinesParams;
import com.stripe.param.InvoiceRetrieveParams;
import com.stripe.param.InvoiceSearchParams;
import com.stripe.param.InvoiceSendInvoiceParams;
import com.stripe.param.InvoiceUpcomingLinesParams;
import com.stripe.param.InvoiceUpcomingParams;
import com.stripe.param.InvoiceUpdateLinesParams;
import com.stripe.param.InvoiceUpdateParams;
import com.stripe.param.InvoiceVoidInvoiceParams;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* Invoices are statements of amounts owed by a customer, and are either generated one-off, or
* generated periodically from a subscription.
*
* They contain invoice items, and
* proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
*
*
If your invoice is configured to be billed through automatic charges, Stripe automatically
* finalizes your invoice and attempts payment. Note that finalizing the invoice, when
* automatic, does not happen immediately as the invoice is created. Stripe waits until one hour
* after the last webhook was successfully sent (or the last webhook timed out after failing). If
* you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one
* hour after creation to finalize the invoice.
*
*
If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will
* email the invoice to your customer and await payment. These emails can contain a link to a hosted
* page to pay the invoice.
*
*
Stripe applies any customer credit on the account before determining the amount due for the
* invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is
* less than Stripe's minimum allowed
* charge per currency, the invoice is automatically marked paid, and we add the amount due to
* the customer's credit balance which is applied to the next invoice.
*
*
More details on the customer's credit balance are here.
*
*
Related guide: Send invoices to
* customers
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Invoice extends ApiResource implements HasId, MetadataStore {
/**
* The country of the business associated with this invoice, most often the business creating the
* invoice.
*/
@SerializedName("account_country")
String accountCountry;
/**
* The public name of the business associated with this invoice, most often the business creating
* the invoice.
*/
@SerializedName("account_name")
String accountName;
/** The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */
@SerializedName("account_tax_ids")
List> accountTaxIds;
/**
* Final amount due at this time for this invoice. If the invoice's total is smaller than the
* minimum charge amount, for example, or if there is account credit that can be applied to the
* invoice, the {@code amount_due} may be 0. If there is a positive {@code starting_balance} for
* the invoice (the customer owes money), the {@code amount_due} will also take that into account.
* The charge that gets generated for the invoice will be for the amount specified in {@code
* amount_due}.
*/
@SerializedName("amount_due")
Long amountDue;
/** The amount, in cents (or local equivalent), that was paid. */
@SerializedName("amount_paid")
Long amountPaid;
/** The difference between amount_due and amount_paid, in cents (or local equivalent). */
@SerializedName("amount_remaining")
Long amountRemaining;
/** This is the sum of all the shipping amounts. */
@SerializedName("amount_shipping")
Long amountShipping;
/**
* List of expected payments and corresponding due dates. This value will be null for invoices
* where collection_method=charge_automatically.
*/
@SerializedName("amounts_due")
List amountsDue;
/** ID of the Connect Application that created the invoice. */
@SerializedName("application")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField application;
/**
* The fee in cents (or local equivalent) that will be applied to the invoice and transferred to
* the application owner's Stripe account when the invoice is paid.
*/
@SerializedName("application_fee_amount")
Long applicationFeeAmount;
/**
* Number of payment attempts made for this invoice, from the perspective of the payment retry
* schedule. Any payment attempt counts as the first attempt, and subsequently only automatic
* retries increment the attempt count. In other words, manual payment attempts after the first
* attempt do not affect the retry schedule. If a failure is returned with a non-retryable return
* code, the invoice can no longer be retried unless a new payment method is obtained. Retries
* will continue to be scheduled, and attempt_count will continue to increment, but retries will
* only be executed if a new payment method is obtained.
*/
@SerializedName("attempt_count")
Long attemptCount;
/**
* Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour
* after the {@code invoice.created} webhook, for example, so you might not want to display that
* invoice as unpaid to your users.
*/
@SerializedName("attempted")
Boolean attempted;
/**
* Controls whether Stripe performs automatic
* collection of the invoice. If {@code false}, the invoice's state doesn't automatically
* advance without an explicit action.
*/
@SerializedName("auto_advance")
Boolean autoAdvance;
@SerializedName("automatic_tax")
AutomaticTax automaticTax;
/**
* Indicates the reason why the invoice was created.
*
* * {@code manual}: Unrelated to a subscription, for example, created via the invoice editor.
* * {@code subscription}: No longer in use. Applies to subscriptions from before May 2018 where
* no distinction was made between updates, cycles, and thresholds. * {@code subscription_create}:
* A new subscription was created. * {@code subscription_cycle}: A subscription advanced into a
* new period. * {@code subscription_threshold}: A subscription reached a billing threshold. *
* {@code subscription_update}: A subscription was updated. * {@code upcoming}: Reserved for
* simulated invoices, per the upcoming invoice endpoint.
*
*
One of {@code automatic_pending_invoice_item_invoice}, {@code manual}, {@code quote_accept},
* {@code subscription}, {@code subscription_create}, {@code subscription_cycle}, {@code
* subscription_threshold}, {@code subscription_update}, or {@code upcoming}.
*/
@SerializedName("billing_reason")
String billingReason;
/** ID of the latest charge generated for this invoice, if any. */
@SerializedName("charge")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField charge;
/**
* Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically,
* Stripe will attempt to pay this invoice using the default source attached to the customer. When
* sending an invoice, Stripe will email this invoice to the customer with payment instructions.
*
* One of {@code charge_automatically}, or {@code send_invoice}.
*/
@SerializedName("collection_method")
String collectionMethod;
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** Custom fields displayed on the invoice. */
@SerializedName("custom_fields")
List customFields;
/** The ID of the customer who will be billed. */
@SerializedName("customer")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField customer;
/**
* The customer's address. Until the invoice is finalized, this field will equal {@code
* customer.address}. Once the invoice is finalized, this field will no longer be updated.
*/
@SerializedName("customer_address")
Address customerAddress;
/**
* The customer's email. Until the invoice is finalized, this field will equal {@code
* customer.email}. Once the invoice is finalized, this field will no longer be updated.
*/
@SerializedName("customer_email")
String customerEmail;
/**
* The customer's name. Until the invoice is finalized, this field will equal {@code
* customer.name}. Once the invoice is finalized, this field will no longer be updated.
*/
@SerializedName("customer_name")
String customerName;
/**
* The customer's phone number. Until the invoice is finalized, this field will equal {@code
* customer.phone}. Once the invoice is finalized, this field will no longer be updated.
*/
@SerializedName("customer_phone")
String customerPhone;
/**
* The customer's shipping information. Until the invoice is finalized, this field will equal
* {@code customer.shipping}. Once the invoice is finalized, this field will no longer be updated.
*/
@SerializedName("customer_shipping")
ShippingDetails customerShipping;
/**
* The customer's tax exempt status. Until the invoice is finalized, this field will equal {@code
* customer.tax_exempt}. Once the invoice is finalized, this field will no longer be updated.
*
* One of {@code exempt}, {@code none}, or {@code reverse}.
*/
@SerializedName("customer_tax_exempt")
String customerTaxExempt;
/**
* The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax
* IDs as {@code customer.tax_ids}. Once the invoice is finalized, this field will no longer be
* updated.
*/
@SerializedName("customer_tax_ids")
List customerTaxIds;
/**
* The margins applied to the invoice. Can be overridden by line item {@code margins}. Use {@code
* expand[]=default_margins} to expand each margin.
*/
@SerializedName("default_margins")
List> defaultMargins;
/**
* ID of the default payment method for the invoice. It must belong to the customer associated
* with the invoice. If not set, defaults to the subscription's default payment method, if any, or
* to the default payment method in the customer's invoice settings.
*/
@SerializedName("default_payment_method")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField defaultPaymentMethod;
/**
* ID of the default payment source for the invoice. It must belong to the customer associated
* with the invoice and be in a chargeable state. If not set, defaults to the subscription's
* default source, if any, or to the customer's default source.
*/
@SerializedName("default_source")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField defaultSource;
/** The tax rates applied to this invoice, if any. */
@SerializedName("default_tax_rates")
List defaultTaxRates;
/** Always true for a deleted object. */
@SerializedName("deleted")
Boolean deleted;
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as
* 'memo' in the Dashboard.
*/
@SerializedName("description")
String description;
/**
* Describes the current discount applied to this invoice, if there is one. Not populated if there
* are multiple discounts.
*/
@SerializedName("discount")
Discount discount;
/**
* The discounts applied to the invoice. Line item discounts are applied before invoice discounts.
* Use {@code expand[]=discounts} to expand each discount.
*/
@SerializedName("discounts")
List> discounts;
/**
* The date on which payment for this invoice is due. This value will be {@code null} for invoices
* where {@code collection_method=charge_automatically}.
*/
@SerializedName("due_date")
Long dueDate;
/**
* The date when this invoice is in effect. Same as {@code finalized_at} unless overwritten. When
* defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF
* and receipt.
*/
@SerializedName("effective_at")
Long effectiveAt;
/**
* Ending customer balance after the invoice is finalized. Invoices are finalized approximately an
* hour after successful webhook delivery or when payment collection is attempted for the invoice.
* If the invoice has not been finalized yet, this will be null.
*/
@SerializedName("ending_balance")
Long endingBalance;
/** Footer displayed on the invoice. */
@SerializedName("footer")
String footer;
/**
* Details of the invoice that was cloned. See the revision documentation for more
* details.
*/
@SerializedName("from_invoice")
FromInvoice fromInvoice;
/**
* The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the
* invoice has not been finalized yet, this will be null.
*/
@SerializedName("hosted_invoice_url")
String hostedInvoiceUrl;
/**
* Unique identifier for the object. This property is always present unless the invoice is an
* upcoming invoice. See Retrieve an
* upcoming invoice for more details.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* The link to download the PDF for the invoice. If the invoice has not been finalized yet, this
* will be null.
*/
@SerializedName("invoice_pdf")
String invoicePdf;
@SerializedName("issuer")
Issuer issuer;
/**
* The error encountered during the previous attempt to finalize the invoice. This field is
* cleared when the invoice is successfully finalized.
*/
@SerializedName("last_finalization_error")
StripeError lastFinalizationError;
/** The ID of the most recent non-draft revision of this invoice. */
@SerializedName("latest_revision")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField latestRevision;
/**
* The individual line items that make up the invoice. {@code lines} is sorted as follows: (1)
* pending invoice items (including prorations) in reverse chronological order, (2) subscription
* items in reverse chronological order, and (3) invoice items added after invoice creation in
* chronological order.
*/
@SerializedName("lines")
InvoiceLineItemCollection lines;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map metadata;
/**
* The time at which payment will next be attempted. This value will be {@code null} for invoices
* where {@code collection_method=send_invoice}.
*/
@SerializedName("next_payment_attempt")
Long nextPaymentAttempt;
/**
* A unique, identifying string that appears on emails sent to the customer for this invoice. This
* starts with the customer's unique invoice_prefix if it is specified.
*/
@SerializedName("number")
String number;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code invoice}.
*/
@SerializedName("object")
String object;
/**
* The account (if any) for which the funds of the invoice payment are intended. If set, the
* invoice will be presented with the branding and support information of the specified account.
* See the Invoices with Connect
* documentation for details.
*/
@SerializedName("on_behalf_of")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField onBehalfOf;
/**
* Whether payment was successfully collected for this invoice. An invoice can be paid (most
* commonly) with a charge or with credit from the customer's account balance.
*/
@SerializedName("paid")
Boolean paid;
/**
* Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been
* paid yet or was paid on Stripe.
*/
@SerializedName("paid_out_of_band")
Boolean paidOutOfBand;
/**
* The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice
* is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel
* the PaymentIntent.
*/
@SerializedName("payment_intent")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField paymentIntent;
@SerializedName("payment_settings")
PaymentSettings paymentSettings;
/** Payments for this invoice. */
@SerializedName("payments")
InvoicePaymentCollection payments;
/**
* End of the usage period during which invoice items were added to this invoice. This looks back
* one period for a subscription invoice. Use the line item
* period to get the service period for each price.
*/
@SerializedName("period_end")
Long periodEnd;
/**
* Start of the usage period during which invoice items were added to this invoice. This looks
* back one period for a subscription invoice. Use the line item
* period to get the service period for each price.
*/
@SerializedName("period_start")
Long periodStart;
/** Total amount of all post-payment credit notes issued for this invoice. */
@SerializedName("post_payment_credit_notes_amount")
Long postPaymentCreditNotesAmount;
/** Total amount of all pre-payment credit notes issued for this invoice. */
@SerializedName("pre_payment_credit_notes_amount")
Long prePaymentCreditNotesAmount;
/** The quote this invoice was generated from. */
@SerializedName("quote")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField quote;
/** This is the transaction number that appears on email receipts sent for this invoice. */
@SerializedName("receipt_number")
String receiptNumber;
/**
* The rendering-related settings that control how the invoice is displayed on customer-facing
* surfaces such as PDF and Hosted Invoice Page.
*/
@SerializedName("rendering")
Rendering rendering;
/** The details of the cost of shipping, including the ShippingRate applied on the invoice. */
@SerializedName("shipping_cost")
ShippingCost shippingCost;
/**
* Shipping details for the invoice. The Invoice PDF will use the {@code shipping_details} value
* if it is set, otherwise the PDF will render the shipping address from the customer.
*/
@SerializedName("shipping_details")
ShippingDetails shippingDetails;
/**
* Starting customer balance before the invoice is finalized. If the invoice has not been
* finalized yet, this will be the current customer balance. For revision invoices, this also
* includes any customer balance that was applied to the original invoice.
*/
@SerializedName("starting_balance")
Long startingBalance;
/** Extra information about an invoice for the customer's credit card statement. */
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code
* uncollectible}, or {@code void}. Learn more
*/
@SerializedName("status")
String status;
@SerializedName("status_transitions")
StatusTransitions statusTransitions;
/** The subscription that this invoice was prepared for, if any. */
@SerializedName("subscription")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField subscription;
/** Details about the subscription that created this invoice. */
@SerializedName("subscription_details")
SubscriptionDetails subscriptionDetails;
/**
* Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
*/
@SerializedName("subscription_proration_date")
Long subscriptionProrationDate;
/**
* Total of all subscriptions, invoice items, and prorations on the invoice before any invoice
* level discount or exclusive tax is applied. Item discounts are already incorporated
*/
@SerializedName("subtotal")
Long subtotal;
/**
* The integer amount in cents (or local equivalent) representing the subtotal of the invoice
* before any invoice level discount or tax is applied. Item discounts are already incorporated
*/
@SerializedName("subtotal_excluding_tax")
Long subtotalExcludingTax;
/** The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */
@SerializedName("tax")
Long tax;
/** ID of the test clock this invoice belongs to. */
@SerializedName("test_clock")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField testClock;
@SerializedName("threshold_reason")
ThresholdReason thresholdReason;
/** Total after discounts and taxes. */
@SerializedName("total")
Long total;
/** The aggregate amounts calculated per discount across all line items. */
@SerializedName("total_discount_amounts")
List totalDiscountAmounts;
/**
* The integer amount in cents (or local equivalent) representing the total amount of the invoice
* including all discounts but excluding all tax.
*/
@SerializedName("total_excluding_tax")
Long totalExcludingTax;
/** The aggregate amounts calculated per margin across all line items. */
@SerializedName("total_margin_amounts")
List totalMarginAmounts;
/** The aggregate amounts calculated per tax rate for all line items. */
@SerializedName("total_tax_amounts")
List totalTaxAmounts;
/**
* The account (if any) the payment will be attributed to for tax reporting, and where funds from
* the payment will be transferred to for the invoice.
*/
@SerializedName("transfer_data")
TransferData transferData;
/**
* Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all
* webhook delivery attempts have been exhausted. This field
* tracks the time when webhooks for this invoice were successfully delivered. If the invoice had
* no webhooks to deliver, this will be set while the invoice is being created.
*/
@SerializedName("webhooks_delivered_at")
Long webhooksDeliveredAt;
/** Get ID of expandable {@code application} object. */
public String getApplication() {
return (this.application != null) ? this.application.getId() : null;
}
public void setApplication(String id) {
this.application = ApiResource.setExpandableFieldId(id, this.application);
}
/** Get expanded {@code application}. */
public Application getApplicationObject() {
return (this.application != null) ? this.application.getExpanded() : null;
}
public void setApplicationObject(Application expandableObject) {
this.application = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code charge} object. */
public String getCharge() {
return (this.charge != null) ? this.charge.getId() : null;
}
public void setCharge(String id) {
this.charge = ApiResource.setExpandableFieldId(id, this.charge);
}
/** Get expanded {@code charge}. */
public Charge getChargeObject() {
return (this.charge != null) ? this.charge.getExpanded() : null;
}
public void setChargeObject(Charge expandableObject) {
this.charge = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code customer} object. */
public String getCustomer() {
return (this.customer != null) ? this.customer.getId() : null;
}
public void setCustomer(String id) {
this.customer = ApiResource.setExpandableFieldId(id, this.customer);
}
/** Get expanded {@code customer}. */
public Customer getCustomerObject() {
return (this.customer != null) ? this.customer.getExpanded() : null;
}
public void setCustomerObject(Customer expandableObject) {
this.customer = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code defaultPaymentMethod} object. */
public String getDefaultPaymentMethod() {
return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getId() : null;
}
public void setDefaultPaymentMethod(String id) {
this.defaultPaymentMethod = ApiResource.setExpandableFieldId(id, this.defaultPaymentMethod);
}
/** Get expanded {@code defaultPaymentMethod}. */
public PaymentMethod getDefaultPaymentMethodObject() {
return (this.defaultPaymentMethod != null) ? this.defaultPaymentMethod.getExpanded() : null;
}
public void setDefaultPaymentMethodObject(PaymentMethod expandableObject) {
this.defaultPaymentMethod =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code defaultSource} object. */
public String getDefaultSource() {
return (this.defaultSource != null) ? this.defaultSource.getId() : null;
}
public void setDefaultSource(String id) {
this.defaultSource = ApiResource.setExpandableFieldId(id, this.defaultSource);
}
/** Get expanded {@code defaultSource}. */
public PaymentSource getDefaultSourceObject() {
return (this.defaultSource != null) ? this.defaultSource.getExpanded() : null;
}
public void setDefaultSourceObject(PaymentSource expandableObject) {
this.defaultSource =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code latestRevision} object. */
public String getLatestRevision() {
return (this.latestRevision != null) ? this.latestRevision.getId() : null;
}
public void setLatestRevision(String id) {
this.latestRevision = ApiResource.setExpandableFieldId(id, this.latestRevision);
}
/** Get expanded {@code latestRevision}. */
public Invoice getLatestRevisionObject() {
return (this.latestRevision != null) ? this.latestRevision.getExpanded() : null;
}
public void setLatestRevisionObject(Invoice expandableObject) {
this.latestRevision = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code onBehalfOf} object. */
public String getOnBehalfOf() {
return (this.onBehalfOf != null) ? this.onBehalfOf.getId() : null;
}
public void setOnBehalfOf(String id) {
this.onBehalfOf = ApiResource.setExpandableFieldId(id, this.onBehalfOf);
}
/** Get expanded {@code onBehalfOf}. */
public Account getOnBehalfOfObject() {
return (this.onBehalfOf != null) ? this.onBehalfOf.getExpanded() : null;
}
public void setOnBehalfOfObject(Account expandableObject) {
this.onBehalfOf = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code paymentIntent} object. */
public String getPaymentIntent() {
return (this.paymentIntent != null) ? this.paymentIntent.getId() : null;
}
public void setPaymentIntent(String id) {
this.paymentIntent = ApiResource.setExpandableFieldId(id, this.paymentIntent);
}
/** Get expanded {@code paymentIntent}. */
public PaymentIntent getPaymentIntentObject() {
return (this.paymentIntent != null) ? this.paymentIntent.getExpanded() : null;
}
public void setPaymentIntentObject(PaymentIntent expandableObject) {
this.paymentIntent =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code quote} object. */
public String getQuote() {
return (this.quote != null) ? this.quote.getId() : null;
}
public void setQuote(String id) {
this.quote = ApiResource.setExpandableFieldId(id, this.quote);
}
/** Get expanded {@code quote}. */
public Quote getQuoteObject() {
return (this.quote != null) ? this.quote.getExpanded() : null;
}
public void setQuoteObject(Quote expandableObject) {
this.quote = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code subscription} object. */
public String getSubscription() {
return (this.subscription != null) ? this.subscription.getId() : null;
}
public void setSubscription(String id) {
this.subscription = ApiResource.setExpandableFieldId(id, this.subscription);
}
/** Get expanded {@code subscription}. */
public Subscription getSubscriptionObject() {
return (this.subscription != null) ? this.subscription.getExpanded() : null;
}
public void setSubscriptionObject(Subscription expandableObject) {
this.subscription =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code testClock} object. */
public String getTestClock() {
return (this.testClock != null) ? this.testClock.getId() : null;
}
public void setTestClock(String id) {
this.testClock = ApiResource.setExpandableFieldId(id, this.testClock);
}
/** Get expanded {@code testClock}. */
public TestClock getTestClockObject() {
return (this.testClock != null) ? this.testClock.getExpanded() : null;
}
public void setTestClockObject(TestClock expandableObject) {
this.testClock = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get IDs of expandable {@code accountTaxIds} object list. */
public List getAccountTaxIds() {
return (this.accountTaxIds != null)
? this.accountTaxIds.stream().map(x -> x.getId()).collect(Collectors.toList())
: null;
}
public void setAccountTaxIds(List ids) {
if (ids == null) {
this.accountTaxIds = null;
return;
}
if (this.accountTaxIds != null
&& this.accountTaxIds.stream()
.map(x -> x.getId())
.collect(Collectors.toList())
.equals(ids)) {
// noop if the ids are equal to what are already present
return;
}
this.accountTaxIds =
(ids != null)
? ids.stream()
.map(id -> new ExpandableField(id, null))
.collect(Collectors.toList())
: null;
}
/** Get expanded {@code accountTaxIds}. */
public List getAccountTaxIdObjects() {
return (this.accountTaxIds != null)
? this.accountTaxIds.stream().map(x -> x.getExpanded()).collect(Collectors.toList())
: null;
}
public void setAccountTaxIdObjects(List objs) {
this.accountTaxIds =
objs != null
? objs.stream()
.map(x -> new ExpandableField(x.getId(), x))
.collect(Collectors.toList())
: null;
}
/** Get IDs of expandable {@code defaultMargins} object list. */
public List getDefaultMargins() {
return (this.defaultMargins != null)
? this.defaultMargins.stream().map(x -> x.getId()).collect(Collectors.toList())
: null;
}
public void setDefaultMargins(List ids) {
if (ids == null) {
this.defaultMargins = null;
return;
}
if (this.defaultMargins != null
&& this.defaultMargins.stream()
.map(x -> x.getId())
.collect(Collectors.toList())
.equals(ids)) {
// noop if the ids are equal to what are already present
return;
}
this.defaultMargins =
(ids != null)
? ids.stream()
.map(id -> new ExpandableField(id, null))
.collect(Collectors.toList())
: null;
}
/** Get expanded {@code defaultMargins}. */
public List getDefaultMarginObjects() {
return (this.defaultMargins != null)
? this.defaultMargins.stream().map(x -> x.getExpanded()).collect(Collectors.toList())
: null;
}
public void setDefaultMarginObjects(List objs) {
this.defaultMargins =
objs != null
? objs.stream()
.map(x -> new ExpandableField(x.getId(), x))
.collect(Collectors.toList())
: null;
}
/** Get IDs of expandable {@code discounts} object list. */
public List getDiscounts() {
return (this.discounts != null)
? this.discounts.stream().map(x -> x.getId()).collect(Collectors.toList())
: null;
}
public void setDiscounts(List ids) {
if (ids == null) {
this.discounts = null;
return;
}
if (this.discounts != null
&& this.discounts.stream().map(x -> x.getId()).collect(Collectors.toList()).equals(ids)) {
// noop if the ids are equal to what are already present
return;
}
this.discounts =
(ids != null)
? ids.stream()
.map(id -> new ExpandableField(id, null))
.collect(Collectors.toList())
: null;
}
/** Get expanded {@code discounts}. */
public List getDiscountObjects() {
return (this.discounts != null)
? this.discounts.stream().map(x -> x.getExpanded()).collect(Collectors.toList())
: null;
}
public void setDiscountObjects(List objs) {
this.discounts =
objs != null
? objs.stream()
.map(x -> new ExpandableField(x.getId(), x))
.collect(Collectors.toList())
: null;
}
/**
* Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
*/
public Invoice addLines(Map params) throws StripeException {
return addLines(params, (RequestOptions) null);
}
/**
* Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
*/
public Invoice addLines(Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/add_lines", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
*/
public Invoice addLines(InvoiceAddLinesParams params) throws StripeException {
return addLines(params, (RequestOptions) null);
}
/**
* Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
*/
public Invoice addLines(InvoiceAddLinesParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/add_lines", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
* For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment() throws StripeException {
return attachPayment((Map) null, (RequestOptions) null);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
* For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment(RequestOptions options) throws StripeException {
return attachPayment((Map) null, options);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
* For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment(Map params) throws StripeException {
return attachPayment(params, (RequestOptions) null);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
* For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/attach_payment", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
* For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment(InvoiceAttachPaymentParams params) throws StripeException {
return attachPayment(params, (RequestOptions) null);
}
/**
* Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of
* {@code payments}.
*
*
For Out of Band Payment, the payment is credited to the invoice immediately, increasing the
* {@code amount_paid} of the invoice and subsequently transitioning the status of the invoice to
* {@code paid} if necessary.
*
*
For the PaymentIntent, when the PaymentIntent’s status changes to {@code succeeded}, the
* payment is credited to the invoice, increasing its {@code amount_paid}. When the invoice is
* fully paid, the invoice’s status becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it’s attached, it’s credited
* to the invoice immediately.
*
*
See: Create an invoice
* payment to learn more.
*/
public Invoice attachPayment(InvoiceAttachPaymentParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/attach_payment", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Attaches a PaymentIntent to the invoice, adding it to the list of {@code payments}. When the
* PaymentIntent’s status changes to {@code succeeded}, the payment is credited to the invoice,
* increasing its {@code amount_paid}. When the invoice is fully paid, the invoice’s status
* becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it is attached, it is
* credited to the invoice immediately.
*
*
Related guide: Create an invoice
* payment
*/
public Invoice attachPaymentIntent(Map params) throws StripeException {
return attachPaymentIntent(params, (RequestOptions) null);
}
/**
* Attaches a PaymentIntent to the invoice, adding it to the list of {@code payments}. When the
* PaymentIntent’s status changes to {@code succeeded}, the payment is credited to the invoice,
* increasing its {@code amount_paid}. When the invoice is fully paid, the invoice’s status
* becomes {@code paid}.
*
* If the PaymentIntent’s status is already {@code succeeded} when it is attached, it is
* credited to the invoice immediately.
*
*
Related guide: Create an invoice
* payment
*/
public Invoice attachPaymentIntent(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/invoices/%s/attach_payment_intent", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Attaches a PaymentIntent to the invoice, adding it to the list of {@code payments}. When the
* PaymentIntent’s status changes to {@code succeeded}, the payment is credited to the invoice,
* increasing its {@code amount_paid}. When the invoice is fully paid, the invoice’s status
* becomes {@code paid}.
*
* If the PaymentIntent’s status is already {@code succeeded} when it is attached, it is
* credited to the invoice immediately.
*
*
Related guide: Create an invoice
* payment
*/
public Invoice attachPaymentIntent(InvoiceAttachPaymentIntentParams params)
throws StripeException {
return attachPaymentIntent(params, (RequestOptions) null);
}
/**
* Attaches a PaymentIntent to the invoice, adding it to the list of {@code payments}. When the
* PaymentIntent’s status changes to {@code succeeded}, the payment is credited to the invoice,
* increasing its {@code amount_paid}. When the invoice is fully paid, the invoice’s status
* becomes {@code paid}.
*
*
If the PaymentIntent’s status is already {@code succeeded} when it is attached, it is
* credited to the invoice immediately.
*
*
Related guide: Create an invoice
* payment
*/
public Invoice attachPaymentIntent(
InvoiceAttachPaymentIntentParams params, RequestOptions options) throws StripeException {
String path =
String.format(
"/v1/invoices/%s/attach_payment_intent", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public static Invoice create(Map params) throws StripeException {
return create(params, (RequestOptions) null);
}
/**
* 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.
*/
public static Invoice create(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public static Invoice create(InvoiceCreateParams params) throws StripeException {
return create(params, (RequestOptions) null);
}
/**
* 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.
*/
public static Invoice create(InvoiceCreateParams params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview() throws StripeException {
return createPreview((Map) null, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview(RequestOptions options) throws StripeException {
return createPreview((Map) null, options);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview(Map params) throws StripeException {
return createPreview(params, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/create_preview";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview(InvoiceCreatePreviewParams params) throws StripeException {
return createPreview(params, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice createPreview(InvoiceCreatePreviewParams params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/create_preview";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice delete() throws StripeException {
return delete((Map) null, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice delete(RequestOptions options) throws StripeException {
return delete((Map) null, options);
}
/**
* 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.
*/
public Invoice delete(Map params) throws StripeException {
return delete(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice delete(Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.DELETE, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice finalizeInvoice() throws StripeException {
return finalizeInvoice((Map) null, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice finalizeInvoice(RequestOptions options) throws StripeException {
return finalizeInvoice((Map) null, options);
}
/**
* 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.
*/
public Invoice finalizeInvoice(Map params) throws StripeException {
return finalizeInvoice(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice finalizeInvoice(Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/finalize", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice finalizeInvoice(InvoiceFinalizeInvoiceParams params) throws StripeException {
return finalizeInvoice(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice finalizeInvoice(InvoiceFinalizeInvoiceParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/finalize", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public static InvoiceCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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.
*/
public static InvoiceCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, InvoiceCollection.class);
}
/**
* 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.
*/
public static InvoiceCollection list(InvoiceListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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.
*/
public static InvoiceCollection list(InvoiceListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, InvoiceCollection.class);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible() throws StripeException {
return markUncollectible((Map) null, (RequestOptions) null);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible(RequestOptions options) throws StripeException {
return markUncollectible((Map) null, options);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible(Map params) throws StripeException {
return markUncollectible(params, (RequestOptions) null);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/mark_uncollectible", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible(InvoiceMarkUncollectibleParams params) throws StripeException {
return markUncollectible(params, (RequestOptions) null);
}
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be
* written off for accounting purposes.
*/
public Invoice markUncollectible(InvoiceMarkUncollectibleParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/mark_uncollectible", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice pay() throws StripeException {
return pay((Map) null, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice pay(RequestOptions options) throws StripeException {
return pay((Map) null, options);
}
/**
* 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.
*/
public Invoice pay(Map params) throws StripeException {
return pay(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice pay(Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s/pay", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice pay(InvoicePayParams params) throws StripeException {
return pay(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice pay(InvoicePayParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s/pay", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Removes multiple line items from an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice removeLines(Map params) throws StripeException {
return removeLines(params, (RequestOptions) null);
}
/**
* Removes multiple line items from an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice removeLines(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/remove_lines", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Removes multiple line items from an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice removeLines(InvoiceRemoveLinesParams params) throws StripeException {
return removeLines(params, (RequestOptions) null);
}
/**
* Removes multiple line items from an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice removeLines(InvoiceRemoveLinesParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/remove_lines", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/** Retrieves the invoice with the given ID. */
public static Invoice retrieve(String invoice) throws StripeException {
return retrieve(invoice, (Map) null, (RequestOptions) null);
}
/** Retrieves the invoice with the given ID. */
public static Invoice retrieve(String invoice, RequestOptions options) throws StripeException {
return retrieve(invoice, (Map) null, options);
}
/** Retrieves the invoice with the given ID. */
public static Invoice retrieve(String invoice, Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s", ApiResource.urlEncodeId(invoice));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/** Retrieves the invoice with the given ID. */
public static Invoice retrieve(
String invoice, InvoiceRetrieveParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s", ApiResource.urlEncodeId(invoice));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public static InvoiceSearchResult search(Map params) throws StripeException {
return search(params, (RequestOptions) null);
}
/**
* 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.
*/
public static InvoiceSearchResult search(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/search";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, InvoiceSearchResult.class);
}
/**
* 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.
*/
public static InvoiceSearchResult search(InvoiceSearchParams params) throws StripeException {
return search(params, (RequestOptions) null);
}
/**
* 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.
*/
public static InvoiceSearchResult search(InvoiceSearchParams params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/search";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, InvoiceSearchResult.class);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice() throws StripeException {
return sendInvoice((Map) null, (RequestOptions) null);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice(RequestOptions options) throws StripeException {
return sendInvoice((Map) null, options);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice(Map params) throws StripeException {
return sendInvoice(params, (RequestOptions) null);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice(Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/send", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice(InvoiceSendInvoiceParams params) throws StripeException {
return sendInvoice(params, (RequestOptions) null);
}
/**
* 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 {@code
* invoice.sent} event.
*/
public Invoice sendInvoice(InvoiceSendInvoiceParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/send", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice upcoming() throws StripeException {
return upcoming((Map) null, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice upcoming(Map params) throws StripeException {
return upcoming(params, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice upcoming(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/upcoming";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice upcoming(InvoiceUpcomingParams params) throws StripeException {
return upcoming(params, (RequestOptions) null);
}
/**
* 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 {@code 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 {@code period[start]}
* is equal to the {@code 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
*/
public static Invoice upcoming(InvoiceUpcomingParams params, RequestOptions options)
throws StripeException {
String path = "/v1/invoices/upcoming";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Invoice.class);
}
/**
* When retrieving an upcoming invoice, you’ll get a lines property containing
* the total count of line items and the first handful of those items. There is also a URL where
* you can retrieve the full (paginated) list of line items.
*/
public static InvoiceLineItemCollection upcomingLines() throws StripeException {
return upcomingLines((Map) null, (RequestOptions) null);
}
/**
* When retrieving an upcoming invoice, you’ll get a lines property containing
* the total count of line items and the first handful of those items. There is also a URL where
* you can retrieve the full (paginated) list of line items.
*/
public static InvoiceLineItemCollection upcomingLines(Map params)
throws StripeException {
return upcomingLines(params, (RequestOptions) null);
}
/**
* When retrieving an upcoming invoice, you’ll get a lines property containing
* the total count of line items and the first handful of those items. There is also a URL where
* you can retrieve the full (paginated) list of line items.
*/
public static InvoiceLineItemCollection upcomingLines(
Map params, RequestOptions options) throws StripeException {
String path = "/v1/invoices/upcoming/lines";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, InvoiceLineItemCollection.class);
}
/**
* When retrieving an upcoming invoice, you’ll get a lines property containing
* the total count of line items and the first handful of those items. There is also a URL where
* you can retrieve the full (paginated) list of line items.
*/
public static InvoiceLineItemCollection upcomingLines(InvoiceUpcomingLinesParams params)
throws StripeException {
return upcomingLines(params, (RequestOptions) null);
}
/**
* When retrieving an upcoming invoice, you’ll get a lines property containing
* the total count of line items and the first handful of those items. There is also a URL where
* you can retrieve the full (paginated) list of line items.
*/
public static InvoiceLineItemCollection upcomingLines(
InvoiceUpcomingLinesParams params, RequestOptions options) throws StripeException {
String path = "/v1/invoices/upcoming/lines";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, InvoiceLineItemCollection.class);
}
/**
* Draft invoices are fully editable. Once an invoice is finalized, monetary
* values, as well as {@code 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 {@code auto_advance=false}.
*/
@Override
public Invoice update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Draft invoices are fully editable. Once an invoice is finalized, monetary
* values, as well as {@code 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 {@code auto_advance=false}.
*/
@Override
public Invoice update(Map params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Draft invoices are fully editable. Once an invoice is finalized, monetary
* values, as well as {@code 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 {@code auto_advance=false}.
*/
public Invoice update(InvoiceUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Draft invoices are fully editable. Once an invoice is finalized, monetary
* values, as well as {@code 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 {@code auto_advance=false}.
*/
public Invoice update(InvoiceUpdateParams params, RequestOptions options) throws StripeException {
String path = String.format("/v1/invoices/%s", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Updates multiple line items on an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice updateLines(Map params) throws StripeException {
return updateLines(params, (RequestOptions) null);
}
/**
* Updates multiple line items on an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice updateLines(Map params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/update_lines", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* Updates multiple line items on an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice updateLines(InvoiceUpdateLinesParams params) throws StripeException {
return updateLines(params, (RequestOptions) null);
}
/**
* Updates multiple line items on an invoice. This is only possible when an invoice is still a
* draft.
*/
public Invoice updateLines(InvoiceUpdateLinesParams params, RequestOptions options)
throws StripeException {
String path =
String.format("/v1/invoices/%s/update_lines", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice voidInvoice() throws StripeException {
return voidInvoice((Map) null, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice voidInvoice(RequestOptions options) throws StripeException {
return voidInvoice((Map) null, options);
}
/**
* 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.
*/
public Invoice voidInvoice(Map params) throws StripeException {
return voidInvoice(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice voidInvoice(Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/void", ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, Invoice.class);
}
/**
* 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.
*/
public Invoice voidInvoice(InvoiceVoidInvoiceParams params) throws StripeException {
return voidInvoice(params, (RequestOptions) null);
}
/**
* 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.
*/
public Invoice voidInvoice(InvoiceVoidInvoiceParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/invoices/%s/void", ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, Invoice.class);
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class AmountsDue extends StripeObject {
/** Incremental amount due for this payment in cents (or local equivalent). */
@SerializedName("amount")
Long amount;
/** The amount in cents (or local equivalent) that was paid for this payment. */
@SerializedName("amount_paid")
Long amountPaid;
/**
* The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
*/
@SerializedName("amount_remaining")
Long amountRemaining;
/** Number of days from when invoice is finalized until the payment is due. */
@SerializedName("days_until_due")
Long daysUntilDue;
/** An arbitrary string attached to the object. Often useful for displaying to users. */
@SerializedName("description")
String description;
/** Date on which a payment plan’s payment is due. */
@SerializedName("due_date")
Long dueDate;
/** Timestamp when the payment was paid. */
@SerializedName("paid_at")
Long paidAt;
/** The status of the payment, one of {@code open}, {@code paid}, or {@code past_due}. */
@SerializedName("status")
String status;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class AutomaticTax extends StripeObject {
/**
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice
* items (invoice items with manually specified tax rates, negative amounts, or {@code
* tax_behavior=unspecified}) cannot be added to automatic tax invoices.
*/
@SerializedName("enabled")
Boolean enabled;
/**
* The account that's liable for tax. If set, the business address and tax registrations
* required to perform the tax calculation are loaded from this account. The tax transaction is
* returned in the report of the connected account.
*/
@SerializedName("liability")
Liability liability;
/**
* The status of the most recent automated tax calculation for this invoice.
*
*
One of {@code complete}, {@code failed}, or {@code requires_location_inputs}.
*/
@SerializedName("status")
String status;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Liability extends StripeObject {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField account;
/**
* Type of the account referenced.
*
* One of {@code account}, or {@code self}.
*/
@SerializedName("type")
String type;
/** Get ID of expandable {@code account} object. */
public String getAccount() {
return (this.account != null) ? this.account.getId() : null;
}
public void setAccount(String id) {
this.account = ApiResource.setExpandableFieldId(id, this.account);
}
/** Get expanded {@code account}. */
public Account getAccountObject() {
return (this.account != null) ? this.account.getExpanded() : null;
}
public void setAccountObject(Account expandableObject) {
this.account = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class CustomField extends StripeObject {
/** The name of the custom field. */
@SerializedName("name")
String name;
/** The value of the custom field. */
@SerializedName("value")
String value;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class CustomerTaxId extends StripeObject {
/**
* The type of the tax ID, one of {@code ad_nrt}, {@code ar_cuit}, {@code eu_vat}, {@code
* bo_tin}, {@code br_cnpj}, {@code br_cpf}, {@code cn_tin}, {@code co_nit}, {@code cr_tin},
* {@code do_rcn}, {@code ec_ruc}, {@code eu_oss_vat}, {@code hr_oib}, {@code pe_ruc}, {@code
* ro_tin}, {@code rs_pib}, {@code sv_nit}, {@code uy_ruc}, {@code ve_rif}, {@code vn_tin},
* {@code gb_vat}, {@code nz_gst}, {@code au_abn}, {@code au_arn}, {@code in_gst}, {@code
* no_vat}, {@code no_voec}, {@code za_vat}, {@code ch_vat}, {@code mx_rfc}, {@code sg_uen},
* {@code ru_inn}, {@code ru_kpp}, {@code ca_bn}, {@code hk_br}, {@code es_cif}, {@code tw_vat},
* {@code th_vat}, {@code jp_cn}, {@code jp_rn}, {@code jp_trn}, {@code li_uid}, {@code my_itn},
* {@code us_ein}, {@code kr_brn}, {@code ca_qst}, {@code ca_gst_hst}, {@code ca_pst_bc}, {@code
* ca_pst_mb}, {@code ca_pst_sk}, {@code my_sst}, {@code sg_gst}, {@code ae_trn}, {@code
* cl_tin}, {@code sa_vat}, {@code id_npwp}, {@code my_frp}, {@code il_vat}, {@code ge_vat},
* {@code ua_vat}, {@code is_vat}, {@code bg_uic}, {@code hu_tin}, {@code si_tin}, {@code
* ke_pin}, {@code tr_tin}, {@code eg_tin}, {@code ph_tin}, {@code bh_vat}, {@code kz_bin},
* {@code ng_tin}, {@code om_vat}, {@code de_stn}, {@code ch_uid}, or {@code unknown}.
*/
@SerializedName("type")
String type;
/** The value of the tax ID. */
@SerializedName("value")
String value;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class FromInvoice extends StripeObject {
/** The relation between this invoice and the cloned invoice. */
@SerializedName("action")
String action;
/** The invoice that was cloned. */
@SerializedName("invoice")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField invoice;
/** Get ID of expandable {@code invoice} object. */
public String getInvoice() {
return (this.invoice != null) ? this.invoice.getId() : null;
}
public void setInvoice(String id) {
this.invoice = ApiResource.setExpandableFieldId(id, this.invoice);
}
/** Get expanded {@code invoice}. */
public Invoice getInvoiceObject() {
return (this.invoice != null) ? this.invoice.getExpanded() : null;
}
public void setInvoiceObject(Invoice expandableObject) {
this.invoice = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Issuer extends StripeObject {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField account;
/**
* Type of the account referenced.
*
* One of {@code account}, or {@code self}.
*/
@SerializedName("type")
String type;
/** Get ID of expandable {@code account} object. */
public String getAccount() {
return (this.account != null) ? this.account.getId() : null;
}
public void setAccount(String id) {
this.account = ApiResource.setExpandableFieldId(id, this.account);
}
/** Get expanded {@code account}. */
public Account getAccountObject() {
return (this.account != null) ? this.account.getExpanded() : null;
}
public void setAccountObject(Account expandableObject) {
this.account = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class PaymentSettings extends StripeObject {
/**
* ID of the mandate to be used for this invoice. It must correspond to the payment method used
* to pay the invoice, including the invoice's default_payment_method or default_source, if set.
*/
@SerializedName("default_mandate")
String defaultMandate;
/** Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */
@SerializedName("payment_method_options")
PaymentMethodOptions paymentMethodOptions;
/**
* The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If
* not set, Stripe attempts to automatically determine the types to use by looking at the
* invoice’s default payment method, the subscription’s default payment method, the customer’s
* default payment method, and your invoice template settings.
*/
@SerializedName("payment_method_types")
List paymentMethodTypes;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class PaymentMethodOptions extends StripeObject {
/**
* If paying by {@code acss_debit}, this sub-hash contains details about the Canadian
* pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("acss_debit")
AcssDebit acssDebit;
/**
* If paying by {@code bancontact}, this sub-hash contains details about the Bancontact
* payment method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("bancontact")
Bancontact bancontact;
/**
* If paying by {@code card}, this sub-hash contains details about the Card payment method
* options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("card")
Card card;
/**
* If paying by {@code customer_balance}, this sub-hash contains details about the Bank
* transfer payment method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("customer_balance")
CustomerBalance customerBalance;
/**
* If paying by {@code konbini}, this sub-hash contains details about the Konbini payment
* method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("konbini")
Konbini konbini;
/**
* If paying by {@code sepa_debit}, this sub-hash contains details about the SEPA Direct Debit
* payment method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("sepa_debit")
SepaDebit sepaDebit;
/**
* If paying by {@code us_bank_account}, this sub-hash contains details about the ACH direct
* debit payment method options to pass to the invoice’s PaymentIntent.
*/
@SerializedName("us_bank_account")
UsBankAccount usBankAccount;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class AcssDebit extends StripeObject {
@SerializedName("mandate_options")
MandateOptions mandateOptions;
/**
* Bank account verification method.
*
* One of {@code automatic}, {@code instant}, or {@code microdeposits}.
*/
@SerializedName("verification_method")
String verificationMethod;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class MandateOptions extends StripeObject {
/**
* Transaction type of the mandate.
*
*
One of {@code business}, or {@code personal}.
*/
@SerializedName("transaction_type")
String transactionType;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Bancontact extends StripeObject {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected
* to.
*
*
One of {@code de}, {@code en}, {@code fr}, or {@code nl}.
*/
@SerializedName("preferred_language")
String preferredLanguage;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Card extends StripeObject {
@SerializedName("installments")
Installments installments;
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your
* customers for authentication based on risk level and other requirements.
* However, if you wish to request 3D Secure based on logic from your own fraud engine,
* provide this option. Read our guide on manually
* requesting 3D Secure for more information on how this configuration interacts with
* Radar and our SCA Engine.
*
*
One of {@code any}, {@code automatic}, or {@code challenge}.
*/
@SerializedName("request_three_d_secure")
String requestThreeDSecure;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Installments extends StripeObject {
/** Whether Installments are enabled for this Invoice. */
@SerializedName("enabled")
Boolean enabled;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class CustomerBalance extends StripeObject {
@SerializedName("bank_transfer")
BankTransfer bankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer
* balance. Permitted values include: {@code bank_transfer}.
*
*
Equal to {@code bank_transfer}.
*/
@SerializedName("funding_type")
String fundingType;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class BankTransfer extends StripeObject {
@SerializedName("eu_bank_transfer")
EuBankTransfer euBankTransfer;
/**
* The bank transfer type that can be used for funding. Permitted values include: {@code
* eu_bank_transfer}, {@code gb_bank_transfer}, {@code jp_bank_transfer}, {@code
* mx_bank_transfer}, or {@code us_bank_transfer}.
*/
@SerializedName("type")
String type;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class EuBankTransfer extends StripeObject {
/**
* The desired country code of the bank account information. Permitted values include:
* {@code BE}, {@code DE}, {@code ES}, {@code FR}, {@code IE}, or {@code NL}.
*
*
One of {@code BE}, {@code DE}, {@code ES}, {@code FR}, {@code IE}, or {@code NL}.
*/
@SerializedName("country")
String country;
}
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Konbini extends StripeObject {}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class SepaDebit extends StripeObject {}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class UsBankAccount extends StripeObject {
@SerializedName("financial_connections")
FinancialConnections financialConnections;
/**
* Bank account verification method.
*
*
One of {@code automatic}, {@code instant}, or {@code microdeposits}.
*/
@SerializedName("verification_method")
String verificationMethod;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class FinancialConnections extends StripeObject {
@SerializedName("filters")
Filters filters;
/**
* The list of permissions to request. The {@code payment_method} permission must be
* included.
*/
@SerializedName("permissions")
List permissions;
/** Data features requested to be retrieved upon account creation. */
@SerializedName("prefetch")
List prefetch;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Filters extends StripeObject {
/**
* The account subcategories to use to filter for possible accounts to link. Valid
* subcategories are {@code checking} and {@code savings}.
*/
@SerializedName("account_subcategories")
List accountSubcategories;
/** The institution to use to filter for possible accounts to link. */
@SerializedName("institution")
String institution;
}
}
}
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Rendering extends StripeObject {
/** How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */
@SerializedName("amount_tax_display")
String amountTaxDisplay;
/** Invoice pdf rendering options. */
@SerializedName("pdf")
Pdf pdf;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Pdf extends StripeObject {
/**
* Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size
* will be switched to a4 or letter based on customer locale.
*
* One of {@code a4}, {@code auto}, or {@code letter}.
*/
@SerializedName("page_size")
String pageSize;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ShippingCost extends StripeObject {
/** Total shipping cost before any taxes are applied. */
@SerializedName("amount_subtotal")
Long amountSubtotal;
/** Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. */
@SerializedName("amount_tax")
Long amountTax;
/** Total shipping cost after taxes are applied. */
@SerializedName("amount_total")
Long amountTotal;
/** The ID of the ShippingRate for this invoice. */
@SerializedName("shipping_rate")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField shippingRate;
/** The taxes applied to the shipping rate. */
@SerializedName("taxes")
List taxes;
/** Get ID of expandable {@code shippingRate} object. */
public String getShippingRate() {
return (this.shippingRate != null) ? this.shippingRate.getId() : null;
}
public void setShippingRate(String id) {
this.shippingRate = ApiResource.setExpandableFieldId(id, this.shippingRate);
}
/** Get expanded {@code shippingRate}. */
public ShippingRate getShippingRateObject() {
return (this.shippingRate != null) ? this.shippingRate.getExpanded() : null;
}
public void setShippingRateObject(ShippingRate expandableObject) {
this.shippingRate =
new ExpandableField(expandableObject.getId(), expandableObject);
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Tax extends StripeObject {
/** Amount of tax applied for this rate. */
@SerializedName("amount")
Long amount;
/**
* Tax rates can be applied to invoices, subscriptions and Checkout
* Sessions to collect tax.
*
* Related guide: Tax rates
*/
@SerializedName("rate")
TaxRate rate;
/**
* The reasoning behind this tax, for example, if the product is tax exempt. The possible
* values for this field may be extended as new tax rules are supported.
*
*
One of {@code customer_exempt}, {@code not_collecting}, {@code not_subject_to_tax},
* {@code not_supported}, {@code portion_product_exempt}, {@code portion_reduced_rated},
* {@code portion_standard_rated}, {@code product_exempt}, {@code product_exempt_holiday},
* {@code proportionally_rated}, {@code reduced_rated}, {@code reverse_charge}, {@code
* standard_rated}, {@code taxable_basis_reduced}, or {@code zero_rated}.
*/
@SerializedName("taxability_reason")
String taxabilityReason;
/** The amount on which tax is calculated, in cents (or local equivalent). */
@SerializedName("taxable_amount")
Long taxableAmount;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class StatusTransitions extends StripeObject {
/** The time that the invoice draft was finalized. */
@SerializedName("finalized_at")
Long finalizedAt;
/** The time that the invoice was marked uncollectible. */
@SerializedName("marked_uncollectible_at")
Long markedUncollectibleAt;
/** The time that the invoice was paid. */
@SerializedName("paid_at")
Long paidAt;
/** The time that the invoice was voided. */
@SerializedName("voided_at")
Long voidedAt;
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class SubscriptionDetails extends StripeObject {
/**
* Set of key-value pairs defined as
* subscription metadata when an invoice is created. Becomes an immutable snapshot of the
* subscription metadata at the time of invoice finalization. Note: This attribute is
* populated only for invoices created on or after June 29, 2023.
*/
@SerializedName("metadata")
Map metadata;
/**
* If specified, payment collection for this subscription will be paused. Note that the
* subscription status will be unchanged and will not be updated to {@code paused}. Learn more
* about pausing
* collection.
*/
@SerializedName("pause_collection")
PauseCollection pauseCollection;
/**
* The Pause Collection settings determine how we will pause collection for this subscription
* and for how long the subscription should be paused.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class PauseCollection extends StripeObject {
/**
* The payment collection behavior for this subscription while paused. One of {@code
* keep_as_draft}, {@code mark_uncollectible}, or {@code void}.
*/
@SerializedName("behavior")
String behavior;
/** The time after which the subscription will resume collecting payments. */
@SerializedName("resumes_at")
Long resumesAt;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ThresholdReason extends StripeObject {
/** The total invoice amount threshold boundary if it triggered the threshold invoice. */
@SerializedName("amount_gte")
Long amountGte;
/** Indicates which line items triggered a threshold invoice. */
@SerializedName("item_reasons")
List itemReasons;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class ItemReason extends StripeObject {
/** The IDs of the line items that triggered the threshold invoice. */
@SerializedName("line_item_ids")
List lineItemIds;
/** The quantity threshold boundary that applied to the given line item. */
@SerializedName("usage_gte")
Long usageGte;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TotalDiscountAmount extends StripeObject {
/** The amount, in cents (or local equivalent), of the discount. */
@SerializedName("amount")
Long amount;
/** The discount that was applied to get this discount amount. */
@SerializedName("discount")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField discount;
/** Get ID of expandable {@code discount} object. */
public String getDiscount() {
return (this.discount != null) ? this.discount.getId() : null;
}
public void setDiscount(String id) {
this.discount = ApiResource.setExpandableFieldId(id, this.discount);
}
/** Get expanded {@code discount}. */
public Discount getDiscountObject() {
return (this.discount != null) ? this.discount.getExpanded() : null;
}
public void setDiscountObject(Discount expandableObject) {
this.discount = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TotalMarginAmount extends StripeObject {
/** The amount, in cents (or local equivalent), of the reduction in line item amount. */
@SerializedName("amount")
Long amount;
/** The margin that was applied to get this margin amount. */
@SerializedName("margin")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField margin;
/** Get ID of expandable {@code margin} object. */
public String getMargin() {
return (this.margin != null) ? this.margin.getId() : null;
}
public void setMargin(String id) {
this.margin = ApiResource.setExpandableFieldId(id, this.margin);
}
/** Get expanded {@code margin}. */
public Margin getMarginObject() {
return (this.margin != null) ? this.margin.getExpanded() : null;
}
public void setMarginObject(Margin expandableObject) {
this.margin = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TotalTaxAmount extends StripeObject {
/** The amount, in cents (or local equivalent), of the tax. */
@SerializedName("amount")
Long amount;
/** Whether this tax amount is inclusive or exclusive. */
@SerializedName("inclusive")
Boolean inclusive;
/** The tax rate that was applied to get this tax amount. */
@SerializedName("tax_rate")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField taxRate;
/**
* The reasoning behind this tax, for example, if the product is tax exempt. The possible values
* for this field may be extended as new tax rules are supported.
*
* One of {@code customer_exempt}, {@code not_collecting}, {@code not_subject_to_tax}, {@code
* not_supported}, {@code portion_product_exempt}, {@code portion_reduced_rated}, {@code
* portion_standard_rated}, {@code product_exempt}, {@code product_exempt_holiday}, {@code
* proportionally_rated}, {@code reduced_rated}, {@code reverse_charge}, {@code standard_rated},
* {@code taxable_basis_reduced}, or {@code zero_rated}.
*/
@SerializedName("taxability_reason")
String taxabilityReason;
/** The amount on which tax is calculated, in cents (or local equivalent). */
@SerializedName("taxable_amount")
Long taxableAmount;
/** Get ID of expandable {@code taxRate} object. */
public String getTaxRate() {
return (this.taxRate != null) ? this.taxRate.getId() : null;
}
public void setTaxRate(String id) {
this.taxRate = ApiResource.setExpandableFieldId(id, this.taxRate);
}
/** Get expanded {@code taxRate}. */
public TaxRate getTaxRateObject() {
return (this.taxRate != null) ? this.taxRate.getExpanded() : null;
}
public void setTaxRateObject(TaxRate expandableObject) {
this.taxRate = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TransferData extends StripeObject {
/**
* The amount in cents (or local equivalent) that will be transferred to the destination account
* when the invoice is paid. By default, the entire amount is transferred to the destination.
*/
@SerializedName("amount")
Long amount;
/** The account where funds from the payment will be transferred to upon payment success. */
@SerializedName("destination")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField destination;
/** Get ID of expandable {@code destination} object. */
public String getDestination() {
return (this.destination != null) ? this.destination.getId() : null;
}
public void setDestination(String id) {
this.destination = ApiResource.setExpandableFieldId(id, this.destination);
}
/** Get expanded {@code destination}. */
public Account getDestinationObject() {
return (this.destination != null) ? this.destination.getExpanded() : null;
}
public void setDestinationObject(Account expandableObject) {
this.destination = new ExpandableField(expandableObject.getId(), expandableObject);
}
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(application, responseGetter);
trySetResponseGetter(automaticTax, responseGetter);
trySetResponseGetter(charge, responseGetter);
trySetResponseGetter(customer, responseGetter);
trySetResponseGetter(customerAddress, responseGetter);
trySetResponseGetter(customerShipping, responseGetter);
trySetResponseGetter(defaultPaymentMethod, responseGetter);
trySetResponseGetter(defaultSource, responseGetter);
trySetResponseGetter(discount, responseGetter);
trySetResponseGetter(fromInvoice, responseGetter);
trySetResponseGetter(issuer, responseGetter);
trySetResponseGetter(lastFinalizationError, responseGetter);
trySetResponseGetter(latestRevision, responseGetter);
trySetResponseGetter(lines, responseGetter);
trySetResponseGetter(onBehalfOf, responseGetter);
trySetResponseGetter(paymentIntent, responseGetter);
trySetResponseGetter(paymentSettings, responseGetter);
trySetResponseGetter(payments, responseGetter);
trySetResponseGetter(quote, responseGetter);
trySetResponseGetter(rendering, responseGetter);
trySetResponseGetter(shippingCost, responseGetter);
trySetResponseGetter(shippingDetails, responseGetter);
trySetResponseGetter(statusTransitions, responseGetter);
trySetResponseGetter(subscription, responseGetter);
trySetResponseGetter(subscriptionDetails, responseGetter);
trySetResponseGetter(testClock, responseGetter);
trySetResponseGetter(thresholdReason, responseGetter);
trySetResponseGetter(transferData, responseGetter);
}
}