One of {@code free_zone_establishment}, {@code free_zone_llc}, {@code
@@ -1883,10 +1883,10 @@ public static class Verification extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Document extends StripeObject {
/**
- * The back of a document returned by a file upload with a {@code purpose}
- * value of {@code additional_verification}. Note that {@code additional_verification} files
- * are not downloadable.
+ * The back of a document returned by a file
+ * upload with a {@code purpose} value of {@code additional_verification}. Note that
+ * {@code additional_verification} files are not downloadable.
*/
@SerializedName("back")
@Getter(lombok.AccessLevel.NONE)
@@ -1910,10 +1910,10 @@ public static class Document extends StripeObject {
String detailsCode;
/**
- * The front of a document returned by a file upload with a {@code purpose}
- * value of {@code additional_verification}. Note that {@code additional_verification} files
- * are not downloadable.
+ * The front of a document returned by a file
+ * upload with a {@code purpose} value of {@code additional_verification}. Note that
+ * {@code additional_verification} files are not downloadable.
*/
@SerializedName("front")
@Getter(lombok.AccessLevel.NONE)
@@ -1979,7 +1979,7 @@ public static class Controller extends StripeObject {
/**
* {@code true} if the Connect application retrieving the resource controls the account and can
* therefore exercise platform
+ * href="https://docs.stripe.com/connect/platform-controls-for-standard-accounts">platform
* controls. Otherwise, this field is null.
*/
@SerializedName("is_controller")
@@ -2119,8 +2119,11 @@ public static class StripeDashboard extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class FutureRequirements extends StripeObject {
/**
- * Fields that are due and can be satisfied by providing the corresponding alternative fields
- * instead.
+ * Fields that are due and can be resolved by providing the corresponding alternative fields
+ * instead. Many alternatives can list the same {@code original_fields_due}, and any of these
+ * alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing
+ * {@code original_fields_due} also serves as a pathway for attempting to resolve the fields
+ * again.
*/
@SerializedName("alternatives")
List One of {@code action_required.requested_capabilities}, {@code listed}, {@code other},
@@ -2361,8 +2366,8 @@ public static class Requirements extends StripeObject {
String disabledReason;
/**
- * Fields that are {@code currently_due} and need to be collected again because validation or
- * verification failed.
+ * Details about validation and verification failures for {@code due} requirements that must be
+ * resolved.
*/
@SerializedName("errors")
List One of {@code credit}, {@code fraud}, {@code fraud_no_intent_to_fulfill}, {@code
diff --git a/src/main/java/com/stripe/model/AccountLink.java b/src/main/java/com/stripe/model/AccountLink.java
index 086c507a67c..db03062d937 100644
--- a/src/main/java/com/stripe/model/AccountLink.java
+++ b/src/main/java/com/stripe/model/AccountLink.java
@@ -18,7 +18,7 @@
* Account Links are the means by which a Connect platform grants a connected account permission to
* access Stripe-hosted applications, such as Connect Onboarding.
*
- * Related guide: Connect
+ * Related guide: Connect
* Onboarding
*/
@Getter
diff --git a/src/main/java/com/stripe/model/AccountNotice.java b/src/main/java/com/stripe/model/AccountNotice.java
index 782f60a713a..133a770235d 100644
--- a/src/main/java/com/stripe/model/AccountNotice.java
+++ b/src/main/java/com/stripe/model/AccountNotice.java
@@ -22,7 +22,7 @@
* send the notices yourself.
*
* See the guide to
+ * href="https://docs.stripe.com/issuing/compliance-us/issuing-regulated-customer-notices">guide to
* send notices to your connected accounts.
*/
@Getter
@@ -58,7 +58,7 @@ public class AccountNotice extends ApiResource implements HasId, MetadataStorekey-value pairs that you can attach
+ * 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.
*/
@@ -77,7 +77,7 @@ public class AccountNotice extends ApiResource implements HasId, MetadataStoreregulated
+ * href="https://docs.stripe.com/issuing/compliance-us/issuing-regulated-customer-notices">regulated
* customer notices guide. All reasons might not apply to your integration, and Stripe might
* add new reasons in the future, so we recommend an internal warning when you receive an unknown
* reason.
@@ -254,18 +254,18 @@ public static class Email extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class LinkedObjects extends StripeObject {
- /** Associated Capability. */
+ /** Associated Capability. */
@SerializedName("capability")
String capability;
/**
- * Associated Credit
+ * Associated Credit
* Underwriting Record.
*/
@SerializedName("issuing_credit_underwriting_record")
String issuingCreditUnderwritingRecord;
- /** Associated Issuing Dispute. */
+ /** Associated Issuing Dispute. */
@SerializedName("issuing_dispute")
String issuingDispute;
}
diff --git a/src/main/java/com/stripe/model/AccountSession.java b/src/main/java/com/stripe/model/AccountSession.java
index ace8aea4254..577335a245b 100644
--- a/src/main/java/com/stripe/model/AccountSession.java
+++ b/src/main/java/com/stripe/model/AccountSession.java
@@ -24,7 +24,7 @@
* quickly, and cannot be used more than once.
*
* Related guide: Connect embedded
+ * href="https://docs.stripe.com/connect/get-started-connect-embedded-components">Connect embedded
* components
*/
@Getter
@@ -44,7 +44,7 @@ public class AccountSession extends ApiResource {
* that you have TLS enabled on any page that includes the client secret.
*
* Refer to our docs to setup Connect
+ * href="https://docs.stripe.com/connect/get-started-connect-embedded-components">setup Connect
* embedded components and learn about how {@code client_secret} should be handled.
*/
@SerializedName("client_secret")
diff --git a/src/main/java/com/stripe/model/Address.java b/src/main/java/com/stripe/model/Address.java
index f65f0d5f101..fb4a3980f9f 100644
--- a/src/main/java/com/stripe/model/Address.java
+++ b/src/main/java/com/stripe/model/Address.java
@@ -33,7 +33,10 @@ public class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO
+ * 3166-2).
+ */
@SerializedName("state")
String state;
}
diff --git a/src/main/java/com/stripe/model/Balance.java b/src/main/java/com/stripe/model/Balance.java
index 97b50660c93..0f4a9b3e8b3 100644
--- a/src/main/java/com/stripe/model/Balance.java
+++ b/src/main/java/com/stripe/model/Balance.java
@@ -23,8 +23,8 @@
* The top-level {@code available} and {@code pending} comprise your "payments
* balance."
*
- * Related guide: Balances and settlement
- * time, Understanding Connect
+ * Related guide: Balances and settlement
+ * time, Understanding Connect
* account balances
*/
@Getter
@@ -33,9 +33,9 @@
public class Balance extends ApiResource {
/**
* Available funds that you can transfer or pay out automatically by Stripe or explicitly through
- * the Transfers API or Payouts API. You can find the available balance
- * for each currency and payment type in the {@code source_types} property.
+ * the Transfers API or Payouts API. You can find the available balance for
+ * each currency and payment type in the {@code source_types} property.
*/
@SerializedName("available")
List Related guide: Balance
+ * Related guide: Balance
* transaction types
*/
@Getter
diff --git a/src/main/java/com/stripe/model/BankAccount.java b/src/main/java/com/stripe/model/BankAccount.java
index d46c75c332f..a05e4174703 100644
--- a/src/main/java/com/stripe/model/BankAccount.java
+++ b/src/main/java/com/stripe/model/BankAccount.java
@@ -110,7 +110,7 @@ public class BankAccount extends ApiResource
/**
* Information about the upcoming new
+ * href="https://docs.stripe.com/connect/custom-accounts/future-requirements">upcoming new
* requirements for the bank account, including what information needs to be collected, and by
* when.
*/
@@ -127,7 +127,7 @@ public class BankAccount extends ApiResource
String last4;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -514,33 +514,33 @@ public BankAccount delete(Map Related guide: Account
+ * Related guide: Account
* capabilities
*/
@Getter
@@ -146,8 +146,11 @@ public Capability update(CapabilityUpdateParams params, RequestOptions options)
@EqualsAndHashCode(callSuper = false)
public static class FutureRequirements extends StripeObject {
/**
- * Fields that are due and can be satisfied by providing the corresponding alternative fields
- * instead.
+ * Fields that are due and can be resolved by providing the corresponding alternative fields
+ * instead. Multiple alternatives can reference the same {@code original_fields_due}. When this
+ * happens, any of these alternatives can serve as a pathway for attempting to resolve the
+ * fields. Additionally, providing {@code original_fields_due} again also serves as a pathway
+ * for attempting to resolve the fields.
*/
@SerializedName("alternatives")
List One of {@code other}, {@code paused.inactivity}, {@code pending.onboarding}, {@code
@@ -371,8 +376,8 @@ public static class Requirements extends StripeObject {
String disabledReason;
/**
- * Fields that are {@code currently_due} and need to be collected again because validation or
- * verification failed.
+ * Details about validation and verification failures for {@code due} requirements that must be
+ * resolved.
*/
@SerializedName("errors")
List Related guide: Card payments with Sources
+ * Related guide: Card payments with Sources
*/
@Getter
@Setter
@@ -219,7 +219,7 @@ public class Card extends ApiResource
String last4;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/CashBalance.java b/src/main/java/com/stripe/model/CashBalance.java
index 9afc4a45b4e..1421ac2af88 100644
--- a/src/main/java/com/stripe/model/CashBalance.java
+++ b/src/main/java/com/stripe/model/CashBalance.java
@@ -28,7 +28,7 @@ public class CashBalance extends ApiResource {
/**
* A hash of all cash balances available to this customer. You cannot delete a customer with any
* cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit One of {@code confirm_card_data}, {@code do_not_try_again}, or {@code try_again_later}.
@@ -1042,7 +1042,7 @@ public static class Outcome extends StripeObject {
* Possible values are {@code approved_by_network}, {@code declined_by_network}, {@code
* not_sent_to_network}, and {@code reversed_after_approval}. The value {@code
* reversed_after_approval} indicates the payment was blocked by Stripe after bank
+ * href="https://docs.stripe.com/declines#blocked-payments">blocked by Stripe after bank
* authorization, and may temporarily appear as "pending" on a cardholder's statement.
*/
@SerializedName("network_status")
@@ -1055,7 +1055,7 @@ public static class Outcome extends StripeObject {
* elevated_risk_level}. Charges blocked because the payment is unlikely to be authorized have
* the value {@code low_probability_of_authorization}. Charges authorized, blocked, or placed in
* review by custom rules have the value {@code rule}. See understanding declines for more details.
+ * href="https://docs.stripe.com/declines">understanding declines for more details.
*/
@SerializedName("reason")
String reason;
@@ -1095,8 +1095,8 @@ public static class Outcome extends StripeObject {
/**
* Possible values are {@code authorized}, {@code manual_review}, {@code issuer_declined},
* {@code blocked}, and {@code invalid}. See understanding declines and Radar reviews for details.
+ * href="https://docs.stripe.com/declines">understanding declines and Radar reviews for details.
*/
@SerializedName("type")
String type;
@@ -1332,7 +1332,7 @@ public static class PaymentMethodDetails extends StripeObject {
/**
* The type of transaction-specific details of the payment method used in the payment. See PaymentMethod.type
+ * href="https://docs.stripe.com/api/payment_methods/object#payment_method_object-type">PaymentMethod.type
* for the full list of possible types. An additional hash is included on {@code
* payment_method_details} with a name matching this value. It contains information specific to
* the payment method.
@@ -1430,6 +1430,12 @@ public static class AcssDebit extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1463,14 +1469,14 @@ public static class AcssDebit extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Affirm extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -1653,6 +1659,12 @@ public static class AuBecsDebit extends StripeObject {
@SerializedName("bsb_number")
String bsbNumber;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1677,6 +1689,12 @@ public static class AuBecsDebit extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class BacsDebit extends StripeObject {
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1933,7 +1951,7 @@ public static class Card extends StripeObject {
* Installment details for this payment.
*
* For more information, see the installments integration guide.
+ * href="https://docs.stripe.com/payments/installments">installments integration guide.
*/
@SerializedName("installments")
Installments installments;
@@ -2554,9 +2572,9 @@ public static class CardPresent extends StripeObject {
String iin;
/**
- * Whether this PaymentIntent is
+ * Whether this PaymentIntent is
* eligible for incremental authorizations. Request support using request_incremental_authorization_support.
+ * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support">request_incremental_authorization_support.
*/
@SerializedName("incremental_authorization_supported")
Boolean incrementalAuthorizationSupported;
@@ -2954,9 +2972,10 @@ public static class IdBankTransfer extends StripeObject {
public static class Ideal extends StripeObject {
/**
* The customer's bank. Can be one of {@code abn_amro}, {@code asn_bank}, {@code bunq}, {@code
- * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code moneyou},
- * {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code revolut}, {@code
- * sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code yoursafe}.
+ * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code mollie},
+ * {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code
+ * revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code
+ * yoursafe}.
*/
@SerializedName("bank")
String bank;
@@ -2966,8 +2985,9 @@ public static class Ideal extends StripeObject {
*
* One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or
+ * {@code TRIONL2U}.
*/
@SerializedName("bic")
String bic;
@@ -3520,6 +3540,12 @@ public static class NzBankAccount extends StripeObject {
@SerializedName("branch_code")
String branchCode;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/** Last four digits of the bank account number. */
@SerializedName("last4")
String last4;
@@ -3611,14 +3637,14 @@ public static class Payco extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Paynow extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -3970,6 +3996,12 @@ public static class SepaDebit extends StripeObject {
@SerializedName("country")
String country;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -3983,9 +4015,9 @@ public static class SepaDebit extends StripeObject {
/**
* Find the ID of the mandate used for this payment under the payment_method_details.sepa_debit.mandate
+ * href="https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate">payment_method_details.sepa_debit.mandate
* property on the Charge. Use this mandate ID to retrieve the Mandate.
+ * href="https://docs.stripe.com/api/mandates/retrieve">retrieve the Mandate.
*/
@SerializedName("mandate")
String mandate;
@@ -4192,6 +4224,12 @@ public static class UsBankAccount extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -4261,14 +4299,14 @@ public static class WechatPay extends StripeObject {
String fingerprint;
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -4309,7 +4347,7 @@ public static class PresentmentDetails extends StripeObject {
}
/**
- * Options to configure Radar. See Radar
+ * Options to configure Radar. See Radar
* Session for more information.
*/
@Getter
@@ -4317,7 +4355,7 @@ public static class PresentmentDetails extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class RadarOptions extends StripeObject {
/**
- * A Radar Session is a snapshot of
+ * A Radar Session is a snapshot of
* the browser metadata and device details that help Radar make more accurate predictions on
* your payments.
*/
diff --git a/src/main/java/com/stripe/model/ConfirmationToken.java b/src/main/java/com/stripe/model/ConfirmationToken.java
index 69a59d2b5ed..e31bca2f1f2 100644
--- a/src/main/java/com/stripe/model/ConfirmationToken.java
+++ b/src/main/java/com/stripe/model/ConfirmationToken.java
@@ -23,8 +23,8 @@
* the ConfirmationToken are written onto the Intent.
*
* To learn more about how to use ConfirmationToken, visit the related guides: - Finalize payments on the
- * server - Build
+ * href="https://docs.stripe.com/payments/finalize-payments-on-the-server">Finalize payments on the
+ * server - Build
* two-step confirmation.
*/
@Getter
@@ -92,7 +92,7 @@ public class ConfirmationToken extends ApiResource implements HasId {
* Indicates that you intend to make future payments with this ConfirmationToken's payment method.
*
* The presence of this property will attach the payment method to
+ * href="https://docs.stripe.com/payments/save-during-payment">attach the payment method to
* the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required
* actions from the user are complete.
*
@@ -1020,9 +1020,9 @@ public static class CardPresent extends StripeObject {
String iin;
/**
- * Whether this PaymentIntent
+ * Whether this PaymentIntent
* is eligible for incremental authorizations. Request support using request_incremental_authorization_support.
+ * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support">request_incremental_authorization_support.
*/
@SerializedName("incremental_authorization_supported")
Boolean incrementalAuthorizationSupported;
@@ -1729,9 +1729,9 @@ public static class Ideal extends StripeObject {
/**
* The customer's bank, if provided. Can be one of {@code abn_amro}, {@code asn_bank}, {@code
* bunq}, {@code buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab},
- * {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code
- * revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code
- * yoursafe}.
+ * {@code mollie}, {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code
+ * regiobank}, {@code revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot},
+ * or {@code yoursafe}.
*/
@SerializedName("bank")
String bank;
@@ -1741,8 +1741,9 @@ public static class Ideal extends StripeObject {
*
* One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or
+ * {@code TRIONL2U}.
*/
@SerializedName("bic")
String bic;
diff --git a/src/main/java/com/stripe/model/Coupon.java b/src/main/java/com/stripe/model/Coupon.java
index 1de2af47ae8..7429253ab83 100644
--- a/src/main/java/com/stripe/model/Coupon.java
+++ b/src/main/java/com/stripe/model/Coupon.java
@@ -23,12 +23,12 @@
/**
* A coupon contains information about a percent-off or amount-off discount you might want to apply
* to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with
- * conventional one-off charges or payment intents.
+ * href="https://api.stripe.com#subscriptions">subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional
+ * one-off charges or payment intents.
*/
@Getter
@Setter
@@ -102,7 +102,7 @@ public class Coupon extends ApiResource implements HasId, MetadataStore Related guide: Credit
+ * Related guide: Credit
* notes
*/
@Getter
@@ -60,7 +60,7 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore If you care whether the customer has paid their most recent subscription invoice, use {@code
@@ -160,7 +164,7 @@ public class Customer extends ApiResource implements HasId, MetadataStore Related guide: Customer balance
+ * Related guide: Customer balance
*/
@Getter
@Setter
@@ -68,6 +68,7 @@ public class CustomerBalanceTransaction extends ApiResource
@Setter(lombok.AccessLevel.NONE)
ExpandableField One of {@code adjustment}, {@code applied_to_invoice}, {@code
diff --git a/src/main/java/com/stripe/model/CustomerCashBalanceTransaction.java b/src/main/java/com/stripe/model/CustomerCashBalanceTransaction.java
index cfc4a5bb56f..e2f606bfa66 100644
--- a/src/main/java/com/stripe/model/CustomerCashBalanceTransaction.java
+++ b/src/main/java/com/stripe/model/CustomerCashBalanceTransaction.java
@@ -41,12 +41,16 @@ public class CustomerCashBalanceTransaction extends StripeObject
@Setter(lombok.AccessLevel.NONE)
ExpandableField One of {@code adjusted_for_overdraft}, {@code applied_to_payment}, {@code funded}, {@code
@@ -132,7 +136,7 @@ public void setCustomerObject(Customer expandableObject) {
@EqualsAndHashCode(callSuper = false)
public static class AdjustedForOverdraft extends StripeObject {
/**
- * The Balance Transaction
+ * The Balance Transaction
* that corresponds to funds taken out of your Stripe balance.
*/
@SerializedName("balance_transaction")
@@ -141,7 +145,7 @@ public static class AdjustedForOverdraft extends StripeObject {
ExpandableField Related guide: Applying
+ * Related guide: Applying
* discounts to subscriptions
*/
@Getter
@@ -33,7 +33,7 @@ public class Discount extends StripeObject implements HasId {
@Setter(lombok.AccessLevel.NONE)
ExpandableField Related guide: Disputes and fraud
+ * Related guide: Disputes and fraud
*/
@Getter
@Setter
@@ -101,7 +101,7 @@ public class Dispute extends ApiResource
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -136,7 +136,7 @@ public class Dispute extends ApiResource
* debit_not_authorized}, {@code duplicate}, {@code fraudulent}, {@code general}, {@code
* incorrect_account_details}, {@code insufficient_funds}, {@code noncompliant}, {@code
* product_not_received}, {@code product_unacceptable}, {@code subscription_canceled}, or {@code
- * unrecognized}. Learn more about dispute
+ * unrecognized}. Learn more about dispute
* reasons.
*/
@SerializedName("reason")
@@ -902,7 +902,10 @@ public static class ShippingAddress extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO 3166-2).
+ */
@SerializedName("state")
String state;
}
@@ -990,7 +993,10 @@ public static class ShippingAddress extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO 3166-2).
+ */
@SerializedName("state")
String state;
}
diff --git a/src/main/java/com/stripe/model/EventDataClassLookup.java b/src/main/java/com/stripe/model/EventDataClassLookup.java
index b98ce6bd5db..c8b4e3fb17e 100644
--- a/src/main/java/com/stripe/model/EventDataClassLookup.java
+++ b/src/main/java/com/stripe/model/EventDataClassLookup.java
@@ -212,6 +212,10 @@ public final class EventDataClassLookup {
classLookup.put("reporting.report_run", com.stripe.model.reporting.ReportRun.class);
classLookup.put("reporting.report_type", com.stripe.model.reporting.ReportType.class);
+ classLookup.put("reserve.hold", com.stripe.model.reserve.Hold.class);
+ classLookup.put("reserve.plan", com.stripe.model.reserve.Plan.class);
+ classLookup.put("reserve.release", com.stripe.model.reserve.Release.class);
+
classLookup.put("scheduled_query_run", com.stripe.model.sigma.ScheduledQueryRun.class);
classLookup.put("tax.association", com.stripe.model.tax.Association.class);
diff --git a/src/main/java/com/stripe/model/ExchangeRate.java b/src/main/java/com/stripe/model/ExchangeRate.java
index 6c82ffc2ec4..0a6056e8da6 100644
--- a/src/main/java/com/stripe/model/ExchangeRate.java
+++ b/src/main/java/com/stripe/model/ExchangeRate.java
@@ -26,14 +26,14 @@
* are various reasons why you might want to know the current rate (for example, to dynamically
* price an item for a user with a default payment in a foreign currency).
*
- * Please refer to our Exchange Rates API guide
+ * Please refer to our Exchange Rates API guide
* for more details.
*
* [Note: this integration path is supported but no longer recommended] Additionally,
* you can guarantee that a charge is made with an exchange rate that you expect is current. To do
* so, you must pass in the exchange_rate to charges endpoints. If the value is no longer up to
* date, the charge won't go through. Please refer to our Using with charges guide for more details.
+ * href="https://docs.stripe.com/exchange-rates">Using with charges -----
*
diff --git a/src/main/java/com/stripe/model/FeeRefund.java b/src/main/java/com/stripe/model/FeeRefund.java
index fc8202ffe14..d219f35b9d5 100644
--- a/src/main/java/com/stripe/model/FeeRefund.java
+++ b/src/main/java/com/stripe/model/FeeRefund.java
@@ -21,7 +21,7 @@
* fee was originally collected.
*
* Related guide: Refunding
+ * href="https://docs.stripe.com/connect/destination-charges#refunding-app-fee">Refunding
* application fees
*/
@Getter
@@ -62,7 +62,7 @@ public class FeeRefund extends ApiResource
String id;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/File.java b/src/main/java/com/stripe/model/File.java
index f11567995b5..4565a6885c2 100644
--- a/src/main/java/com/stripe/model/File.java
+++ b/src/main/java/com/stripe/model/File.java
@@ -19,11 +19,11 @@
/**
* This object represents files hosted on Stripe's servers. You can upload files with the create file request (for example, when
- * uploading dispute evidence). Stripe also creates files independently (for example, the results of
- * a Sigma scheduled query).
+ * href="https://api.stripe.com#create_file">create file request (for example, when uploading
+ * dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).
*
- * Related guide: File upload guide
+ * Related guide: File upload guide
*/
@Getter
@Setter
@@ -47,8 +47,7 @@ public class File extends ApiResource implements HasId {
String id;
/**
- * A list of file links that point at this
- * file.
+ * A list of file links that point at this file.
*/
@SerializedName("links")
FileLinkCollection links;
@@ -62,7 +61,7 @@ public class File extends ApiResource implements HasId {
String object;
/**
- * The purpose of the uploaded
+ * The purpose of the uploaded
* file.
*
* One of {@code account_requirement}, {@code additional_verification}, {@code business_icon},
diff --git a/src/main/java/com/stripe/model/FileLink.java b/src/main/java/com/stripe/model/FileLink.java
index 33101ab8462..91bb8e94440 100644
--- a/src/main/java/com/stripe/model/FileLink.java
+++ b/src/main/java/com/stripe/model/FileLink.java
@@ -58,7 +58,7 @@ public class FileLink extends ApiResource implements HasId, MetadataStore They contain invoice items, and
- * proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
+ * 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
+ * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">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
@@ -61,9 +61,9 @@
* the customer's credit balance which is applied to the next invoice.
*
* More details on the customer's credit balance are here.
+ * href="https://docs.stripe.com/billing/customer/balance">here.
*
- * Related guide: Send invoices to
+ * Related guide: Send invoices to
* customers
*/
@Getter
@@ -153,7 +153,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStore One of {@code fixed}, or {@code maximum}.
+ */
+ @SerializedName("amount_type")
+ String amountType;
+
+ /**
+ * The purpose for which payments are made. Has a default value based on your merchant
+ * category code.
+ *
+ * One of {@code dependant_support}, {@code government}, {@code loan}, {@code
+ * mortgage}, {@code other}, {@code pension}, {@code personal}, {@code retail}, {@code
+ * salary}, {@code tax}, or {@code utility}.
+ */
+ @SerializedName("purpose")
+ String purpose;
+ }
+ }
+
/**
* For more details about Pix, please refer to the API
* Reference.
@@ -3290,6 +3344,7 @@ public static class TotalTax extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TaxRateDetails extends StripeObject {
+ /** ID of the tax rate. */
@SerializedName("tax_rate")
String taxRate;
}
diff --git a/src/main/java/com/stripe/model/InvoiceItem.java b/src/main/java/com/stripe/model/InvoiceItem.java
index e5c59c96e9c..be8a5a97fc2 100644
--- a/src/main/java/com/stripe/model/InvoiceItem.java
+++ b/src/main/java/com/stripe/model/InvoiceItem.java
@@ -24,21 +24,21 @@
/**
* Invoice Items represent the component lines of an invoice. When you create an invoice item with an
+ * href="https://docs.stripe.com/api/invoices">invoice. When you create an invoice item with an
* {@code invoice} field, it is attached to the specified invoice and included as an invoice line item within invoice.lines.
+ * href="https://docs.stripe.com/api/invoices/line_item">an invoice line item within invoice.lines.
*
* Invoice Items can be created before you are ready to actually send the invoice. This can be
* particularly useful when combined with a subscription. Sometimes you want to add a
+ * href="https://docs.stripe.com/api/subscriptions">subscription. Sometimes you want to add a
* charge or credit to a customer, but actually charge or credit the customer's card only at the end
* of a regular billing cycle. This is useful for combining several charges (to minimize
* per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
*
- * Related guides: Integrate with the
+ * Related guides: Integrate with the
* Invoicing API, Subscription
+ * href="https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items">Subscription
* Invoices.
*/
@Getter
@@ -59,13 +59,13 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStore Each line item is backed by either an invoice item or a subscription item.
+ * href="https://docs.stripe.com/api/invoiceitems">invoice item or a subscription item.
*/
@Getter
@Setter
@@ -90,7 +90,7 @@ public class InvoiceLineItem extends ApiResource implements HasId, MetadataStore
List Invoice Payments include the mapping between payment objects, such as Payment Intent, and
diff --git a/src/main/java/com/stripe/model/InvoiceRenderingTemplate.java b/src/main/java/com/stripe/model/InvoiceRenderingTemplate.java
index 86b262bd825..b3fd34a7b67 100644
--- a/src/main/java/com/stripe/model/InvoiceRenderingTemplate.java
+++ b/src/main/java/com/stripe/model/InvoiceRenderingTemplate.java
@@ -43,7 +43,7 @@ public class InvoiceRenderingTemplate extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/LineItem.java b/src/main/java/com/stripe/model/LineItem.java
index 278c2bd952c..d024c68613f 100644
--- a/src/main/java/com/stripe/model/LineItem.java
+++ b/src/main/java/com/stripe/model/LineItem.java
@@ -60,7 +60,7 @@ public class LineItem extends StripeObject implements HasId {
String id;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -151,11 +151,11 @@ public static class Discount extends StripeObject {
/**
* A discount represents the actual application of a coupon or promotion code. It contains
- * information about when the discount began, when it will end, and what it is applied to.
+ * href="https://api.stripe.com#coupons">coupon or promotion code. It contains information
+ * about when the discount began, when it will end, and what it is applied to.
*
- * Related guide: Applying
+ * Related guide: Applying
* discounts to subscriptions
*/
@SerializedName("discount")
diff --git a/src/main/java/com/stripe/model/LoginLink.java b/src/main/java/com/stripe/model/LoginLink.java
index 59ff1e1170f..09c1ece4f4d 100644
--- a/src/main/java/com/stripe/model/LoginLink.java
+++ b/src/main/java/com/stripe/model/LoginLink.java
@@ -17,9 +17,9 @@
/**
* Login Links are single-use URLs that takes an Express account to the login page for their Stripe
* dashboard. A Login Link differs from an Account Link in that it takes the user
+ * href="https://docs.stripe.com/api/account_links">Account Link Refer to our docs for creating and processing an
+ * href="https://docs.stripe.com/orders-beta/create-and-process">creating and processing an
* order to learn about how client_secret should be handled.
*/
@SerializedName("client_secret")
@@ -130,7 +130,7 @@ public class Order extends ApiResource implements HasId, MetadataStore Providing this parameter will attach the payment
+ * href="https://docs.stripe.com/payments/save-during-payment">attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
+ * href="https://docs.stripe.com/api/payment_methods/attach">attached to a Customer
* after the transaction completes.
*
* When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and network
* rules, such as SCA.
+ * href="https://docs.stripe.com/strong-customer-authentication">SCA.
*
* If {@code setup_future_usage} is already set and you are performing a request using
* a publishable key, you may only update the value from {@code on_session} to {@code
@@ -1080,17 +1080,17 @@ public static class Card extends StripeObject {
* Indicates that you intend to make future payments with the payment method.
*
* Providing this parameter will attach the payment
+ * href="https://docs.stripe.com/payments/save-during-payment">attach the payment
* method to the order's Customer, if present, after the order's PaymentIntent is
* confirmed and any required actions from the user are complete. If no Customer was
* provided, the payment method can still be attached to a Customer
+ * href="https://docs.stripe.com/api/payment_methods/attach">attached to a Customer
* after the transaction completes.
*
* When processing card payments, Stripe also uses {@code setup_future_usage} to
* dynamically optimize your payment flow and comply with regional legislation and network
* rules, such as SCA.
+ * href="https://docs.stripe.com/strong-customer-authentication">SCA.
*
* If {@code setup_future_usage} is already set and you are performing a request using
* a publishable key, you may only update the value from {@code on_session} to {@code
@@ -1974,12 +1974,12 @@ public static class Discount extends StripeObject {
/**
* A discount represents the actual application of a coupon or promotion code. It contains
- * information about when the discount began, when it will end, and what it is applied to.
+ * href="https://api.stripe.com#coupons">coupon or promotion code. It contains information
+ * about when the discount began, when it will end, and what it is applied to.
*
* Related guide: Applying discounts to
+ * href="https://docs.stripe.com/billing/subscriptions/discounts">Applying discounts to
* subscriptions
*/
@SerializedName("discount")
diff --git a/src/main/java/com/stripe/model/PaymentAttemptRecord.java b/src/main/java/com/stripe/model/PaymentAttemptRecord.java
index 8560e43ab63..23f43ac7c21 100644
--- a/src/main/java/com/stripe/model/PaymentAttemptRecord.java
+++ b/src/main/java/com/stripe/model/PaymentAttemptRecord.java
@@ -92,7 +92,7 @@ public class PaymentAttemptRecord extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -218,7 +218,7 @@ public static class Amount extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -240,7 +240,7 @@ public static class AmountAuthorized extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -262,7 +262,7 @@ public static class AmountCanceled extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -284,7 +284,7 @@ public static class AmountFailed extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -306,7 +306,7 @@ public static class AmountGuaranteed extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -328,7 +328,7 @@ public static class AmountRefunded extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -350,7 +350,7 @@ public static class AmountRequested extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -583,7 +583,7 @@ public static class PaymentMethodDetails extends StripeObject {
/**
* The type of transaction-specific details of the payment method used in the payment. See PaymentMethod.type
+ * href="https://docs.stripe.com/api/payment_methods/object#payment_method_object-type">PaymentMethod.type
* for the full list of possible types. An additional hash is included on {@code
* payment_method_details} with a name matching this value. It contains information specific to
* the payment method.
@@ -681,6 +681,12 @@ public static class AcssDebit extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -714,14 +720,14 @@ public static class AcssDebit extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Affirm extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -904,6 +910,12 @@ public static class AuBecsDebit extends StripeObject {
@SerializedName("bsb_number")
String bsbNumber;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -928,6 +940,12 @@ public static class AuBecsDebit extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class BacsDebit extends StripeObject {
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1104,7 +1122,10 @@ public static class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO 3166-2).
+ */
@SerializedName("state")
String state;
}
@@ -1144,6 +1165,10 @@ public static class Boleto extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Card extends StripeObject {
+ /** The authorization code of the payment. */
+ @SerializedName("authorization_code")
+ String authorizationCode;
+
/**
* Card brand. Can be {@code amex}, {@code cartes_bancaires}, {@code diners}, {@code
* discover}, {@code eftpos_au}, {@code jcb}, {@code link}, {@code mastercard}, {@code
@@ -1170,6 +1195,10 @@ public static class Card extends StripeObject {
@SerializedName("country")
String country;
+ /** A high-level description of the type of cards issued in this range. */
+ @SerializedName("description")
+ String description;
+
/** Two-digit number representing the card's expiration month. */
@SerializedName("exp_month")
Long expMonth;
@@ -1197,6 +1226,18 @@ public static class Card extends StripeObject {
@SerializedName("funding")
String funding;
+ /** Issuer identification number of the card. */
+ @SerializedName("iin")
+ String iin;
+
+ /** Installment details for this payment. */
+ @SerializedName("installments")
+ Installments installments;
+
+ /** The name of the card's issuing bank. */
+ @SerializedName("issuer")
+ String issuer;
+
/** The last four digits of the card. */
@SerializedName("last4")
String last4;
@@ -1214,6 +1255,14 @@ public static class Card extends StripeObject {
@SerializedName("network")
String network;
+ /** Advice code from the card network for the failed payment. */
+ @SerializedName("network_advice_code")
+ String networkAdviceCode;
+
+ /** Decline code from the card network for the failed payment. */
+ @SerializedName("network_decline_code")
+ String networkDeclineCode;
+
/**
* If this card has network token credentials, this contains the details of the network token
* credentials.
@@ -1230,6 +1279,13 @@ public static class Card extends StripeObject {
@SerializedName("network_transaction_id")
String networkTransactionId;
+ /**
+ * The transaction type that was passed for an off-session, Merchant-Initiated transaction,
+ * one of {@code recurring} or {@code unscheduled}.
+ */
+ @SerializedName("stored_credential_usage")
+ String storedCredentialUsage;
+
/** Populated if this transaction used 3D Secure authentication. */
@SerializedName("three_d_secure")
ThreeDSecure threeDSecure;
@@ -1256,6 +1312,48 @@ public static class Checks extends StripeObject {
String cvcCheck;
}
+ /**
+ * For more details about Installments, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Installments extends StripeObject {
+ @SerializedName("plan")
+ Plan plan;
+
+ /**
+ * For more details about Plan, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Plan extends StripeObject {
+ /**
+ * For {@code fixed_count} installment plans, this is the number of installment payments
+ * your customer will make to their credit card.
+ */
+ @SerializedName("count")
+ Long count;
+
+ /**
+ * For {@code fixed_count} installment plans, this is the interval between installment
+ * payments your customer will make to their credit card. One of {@code month}.
+ */
+ @SerializedName("interval")
+ String interval;
+
+ /**
+ * Type of installment plan, one of {@code fixed_count}, {@code revolving}, or {@code
+ * bonus}.
+ */
+ @SerializedName("type")
+ String type;
+ }
+ }
+
/**
* For more details about NetworkToken, please refer to the API Reference.
@@ -1451,9 +1549,9 @@ public static class CardPresent extends StripeObject {
String iin;
/**
- * Whether this PaymentIntent is
+ * Whether this PaymentIntent is
* eligible for incremental authorizations. Request support using request_incremental_authorization_support.
+ * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support">request_incremental_authorization_support.
*/
@SerializedName("incremental_authorization_supported")
Boolean incrementalAuthorizationSupported;
@@ -1871,9 +1969,10 @@ public static class IdBankTransfer extends StripeObject {
public static class Ideal extends StripeObject {
/**
* The customer's bank. Can be one of {@code abn_amro}, {@code asn_bank}, {@code bunq}, {@code
- * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code moneyou},
- * {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code revolut}, {@code
- * sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code yoursafe}.
+ * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code mollie},
+ * {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code
+ * revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code
+ * yoursafe}.
*/
@SerializedName("bank")
String bank;
@@ -1883,8 +1982,9 @@ public static class Ideal extends StripeObject {
*
* One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or
+ * {@code TRIONL2U}.
*/
@SerializedName("bic")
String bic;
@@ -2438,6 +2538,12 @@ public static class NzBankAccount extends StripeObject {
@SerializedName("branch_code")
String branchCode;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/** Last four digits of the bank account number. */
@SerializedName("last4")
String last4;
@@ -2529,14 +2635,14 @@ public static class Payco extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Paynow extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -2888,6 +2994,12 @@ public static class SepaDebit extends StripeObject {
@SerializedName("country")
String country;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -2901,9 +3013,9 @@ public static class SepaDebit extends StripeObject {
/**
* Find the ID of the mandate used for this payment under the payment_method_details.sepa_debit.mandate
+ * href="https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate">payment_method_details.sepa_debit.mandate
* property on the Charge. Use this mandate ID to retrieve the Mandate.
+ * href="https://docs.stripe.com/api/mandates/retrieve">retrieve the Mandate.
*/
@SerializedName("mandate")
String mandate;
@@ -3110,6 +3222,12 @@ public static class UsBankAccount extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -3179,14 +3297,14 @@ public static class WechatPay extends StripeObject {
String fingerprint;
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -3289,7 +3407,10 @@ public static class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO
+ * 3166-2).
+ */
@SerializedName("state")
String state;
}
diff --git a/src/main/java/com/stripe/model/PaymentIntent.java b/src/main/java/com/stripe/model/PaymentIntent.java
index 5a68515a626..fb53a6a6bc0 100644
--- a/src/main/java/com/stripe/model/PaymentIntent.java
+++ b/src/main/java/com/stripe/model/PaymentIntent.java
@@ -35,11 +35,11 @@
* particular session.
*
* A PaymentIntent transitions through multiple statuses throughout
- * its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately
- * creates at most one successful charge.
+ * href="https://stripe.com/payments/paymentintents/lifecycle">multiple statuses throughout its
+ * lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates
+ * at most one successful charge.
*
- * Related guide: Payment Intents
+ * Related guide: Payment Intents
* API
*/
@Getter
@@ -48,10 +48,10 @@
public class PaymentIntent extends ApiResource implements HasId, MetadataStore use case for
+ * PaymentIntents use case for
* connected accounts.
*/
@SerializedName("application_fee_amount")
Long applicationFeeAmount;
+ @SerializedName("async_workflows")
+ AsyncWorkflows asyncWorkflows;
+
/**
* Settings to configure compatible payment methods from the Stripe Dashboard.
@@ -128,7 +131,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore Refer to our docs to accept a payment and
+ * href="https://docs.stripe.com/payments/accept-a-payment?ui=elements">accept a payment Payment methods attached to other Customers cannot be used with this PaymentIntent.
*
* If setup_future_usage
+ * href="https://api.stripe.com#payment_intent_object-setup_future_usage">setup_future_usage
* is set and this PaymentIntent's payment method is not {@code card_present}, then the payment
* method attaches to the Customer after the PaymentIntent has been confirmed and any required
* actions from the user are complete. If the payment method is {@code card_present} and isn't a
@@ -174,12 +177,12 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore customer;
/**
- * ID of the Account this PaymentIntent belongs to, if one exists.
+ * ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.
*
* Payment methods attached to other Accounts cannot be used with this PaymentIntent.
*
* If setup_future_usage
+ * href="https://api.stripe.com#payment_intent_object-setup_future_usage">setup_future_usage
* is set and this PaymentIntent's payment method is not {@code card_present}, then the payment
* method attaches to the Account after the PaymentIntent has been confirmed and any required
* actions from the user are complete. If the payment method is {@code card_present} and isn't a
@@ -218,7 +221,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore Charge object created by
+ * ID of the latest Charge object created by
* this PaymentIntent. This property is {@code null} until PaymentIntent confirmation is
* attempted.
*/
@@ -235,10 +238,10 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore key-value pairs that you can attach
+ * 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. Learn more about storing
+ * href="https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata">storing
* information in metadata.
*/
@Getter(onMethod_ = {@Override})
@@ -261,9 +264,10 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore use case for
- * connected accounts for details.
+ * You can specify the settlement merchant as the connected account using the {@code on_behalf_of}
+ * attribute on the charge. See the PaymentIntents use case for connected accounts for
+ * details.
*/
@SerializedName("on_behalf_of")
@Getter(lombok.AccessLevel.NONE)
@@ -281,7 +285,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore payment method
+ * href="https://docs.stripe.com/api/payment_method_configurations">payment method
* configuration used for this PaymentIntent.
*/
@SerializedName("payment_method_configuration_details")
@@ -393,14 +397,14 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore status.
+ * href="https://docs.stripe.com/payments/intents#intent-statuses">status.
*/
@SerializedName("status")
String status;
/**
* The data that automatically creates a Transfer after the payment finalizes. Learn more about
- * the use case for connected
+ * the use case for connected
* accounts.
*/
@SerializedName("transfer_data")
@@ -408,7 +412,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore use case for connected
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected
* accounts.
*/
@SerializedName("transfer_group")
@@ -1711,7 +1715,7 @@ public PaymentIntent verifyMicrodeposits(
public static class AmountDetails extends StripeObject {
/**
* The total discount applied on the transaction represented in the smallest currency unit. An integer
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An integer
* greater than 0.
*
* This field is mutually exclusive with the {@code
@@ -1722,7 +1726,7 @@ public static class AmountDetails extends StripeObject {
/**
* A list of line items, each containing information about a product in the PaymentIntent. There
- * is a maximum of 100 line items.
+ * is a maximum of 200 line items.
*/
@SerializedName("line_items")
PaymentIntentAmountDetailsLineItemCollection lineItems;
@@ -1746,7 +1750,7 @@ public static class AmountDetails extends StripeObject {
public static class Shipping extends StripeObject {
/**
* If a physical good is being shipped, the cost of shipping represented in the smallest currency unit. An
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An
* integer greater than or equal to 0.
*/
@SerializedName("amount")
@@ -1777,7 +1781,7 @@ public static class Shipping extends StripeObject {
public static class Tax extends StripeObject {
/**
* The total amount of tax on the transaction represented in the smallest currency unit. Required
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. Required
* for L2 rates. An integer greater than or equal to 0.
*
* This field is mutually exclusive with the {@code
@@ -1801,6 +1805,43 @@ public static class Tip extends StripeObject {
}
}
+ /**
+ * For more details about AsyncWorkflows, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class AsyncWorkflows extends StripeObject {
+ @SerializedName("inputs")
+ Inputs inputs;
+
+ /**
+ * For more details about Inputs, please refer to the API
+ * Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Inputs extends StripeObject {
+ @SerializedName("tax")
+ Tax tax;
+
+ /**
+ * For more details about Tax, please refer to the API
+ * Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Tax extends StripeObject {
+ /** The TaxCalculation id */
+ @SerializedName("calculation")
+ String calculation;
+ }
+ }
+ }
+
/**
* For more details about AutomaticPaymentMethods, please refer to the API Reference.
@@ -1814,7 +1855,7 @@ public static class AutomaticPaymentMethods extends StripeObject {
*
* Redirect-based payment methods may require your customer to be redirected to a payment
* method's app or site for authentication or additional steps. To confirm this PaymentIntent,
+ * href="https://docs.stripe.com/api/payment_intents/confirm">confirm this PaymentIntent,
* you may be required to provide a {@code return_url} to redirect customers back to your site
* after they authenticate or complete the payment.
*
@@ -1858,7 +1899,7 @@ public static class Inputs extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Tax extends StripeObject {
- /** The TaxCalculation id */
+ /** The TaxCalculation id */
@SerializedName("calculation")
String calculation;
}
@@ -3936,7 +3977,7 @@ public static class Card extends StripeObject {
* Installment details for this payment.
*
* For more information, see the installments integration guide.
+ * href="https://docs.stripe.com/payments/installments">installments integration guide.
*/
@SerializedName("installments")
Installments installments;
@@ -3954,7 +3995,7 @@ public static class Card extends StripeObject {
/**
* Request ability to decrement the
+ * href="https://docs.stripe.com/payments/decremental-authorization">decrement the
* authorization for this PaymentIntent.
*
* One of {@code if_available}, or {@code never}.
@@ -3964,7 +4005,7 @@ public static class Card extends StripeObject {
/**
* Request ability to capture beyond the standard
+ * href="https://docs.stripe.com/payments/extended-authorization">capture beyond the standard
* authorization validity window for this PaymentIntent.
*
* One of {@code if_available}, or {@code never}.
@@ -3974,7 +4015,7 @@ public static class Card extends StripeObject {
/**
* Request ability to increment the
+ * href="https://docs.stripe.com/payments/incremental-authorization">increment the
* authorization for this PaymentIntent.
*
* One of {@code if_available}, or {@code never}.
@@ -3983,7 +4024,7 @@ public static class Card extends StripeObject {
String requestIncrementalAuthorization;
/**
- * Request ability to make multiple
+ * Request ability to make multiple
* captures for this PaymentIntent.
*
* One of {@code if_available}, or {@code never}.
@@ -3992,7 +4033,7 @@ public static class Card extends StripeObject {
String requestMulticapture;
/**
- * Request ability to overcapture
+ * Request ability to overcapture
* for this PaymentIntent.
*
* One of {@code if_available}, or {@code never}.
@@ -4011,11 +4052,11 @@ public static class Card extends StripeObject {
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your
* customers for authentication based on risk level and other requirements.
+ * href="https://docs.stripe.com/strong-customer-authentication">other requirements.
* However, if you wish to request 3D Secure based on logic from your own fraud engine,
* provide this option. If not provided, this value defaults to {@code automatic}. Read our
* guide on manually
+ * href="https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds">manually
* requesting 3D Secure for more information on how this configuration interacts with
* Radar and our SCA Engine.
*
@@ -4271,7 +4312,10 @@ public static class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO 3166-2).
+ */
@SerializedName("state")
String state;
}
@@ -4296,7 +4340,7 @@ public static class CardPresent extends StripeObject {
/**
* Request ability to capture this payment beyond the standard authorization
+ * href="https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity">authorization
* validity window.
*/
@SerializedName("request_extended_authorization")
@@ -4304,10 +4348,10 @@ public static class CardPresent extends StripeObject {
/**
* Request ability to increment
+ * href="https://docs.stripe.com/terminal/features/incremental-authorizations">increment
* this PaymentIntent if the combination of MCC and card brand is eligible. Check incremental_authorization_supported
- * in the Confirm response
+ * href="https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported">incremental_authorization_supported
+ * in the Confirm response
* to verify support.
*/
@SerializedName("request_incremental_authorization_support")
@@ -6380,7 +6424,7 @@ public static class TransferData extends StripeObject {
* The amount transferred to the destination account. This transfer will occur automatically
* after the payment succeeds. If no amount is specified, by default the entire payment amount
* is transferred to the destination account. The amount must be less than or equal to the amount,
+ * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount">amount,
* and must be a positive integer representing how much to transfer in the smallest currency
* unit (e.g., 100 cents to charge $1.00).
*/
@@ -6420,6 +6464,7 @@ public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(amountDetails, responseGetter);
trySetResponseGetter(application, responseGetter);
+ trySetResponseGetter(asyncWorkflows, responseGetter);
trySetResponseGetter(automaticPaymentMethods, responseGetter);
trySetResponseGetter(customer, responseGetter);
trySetResponseGetter(hooks, responseGetter);
diff --git a/src/main/java/com/stripe/model/PaymentIntentAmountDetailsLineItem.java b/src/main/java/com/stripe/model/PaymentIntentAmountDetailsLineItem.java
index 5b326a19054..0437e6385c0 100644
--- a/src/main/java/com/stripe/model/PaymentIntentAmountDetailsLineItem.java
+++ b/src/main/java/com/stripe/model/PaymentIntentAmountDetailsLineItem.java
@@ -21,7 +21,7 @@
public class PaymentIntentAmountDetailsLineItem extends ApiResource implements HasId {
/**
* The discount applied on this line item represented in the smallest currency unit. An integer
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An integer
* greater than 0.
*
* This field is mutually exclusive with the {@code amount_details[discount_amount]} field.
@@ -72,7 +72,7 @@ public class PaymentIntentAmountDetailsLineItem extends ApiResource implements H
/**
* The unit cost of the line item represented in the smallest currency unit. Required for
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. Required for
* L3 rates. An integer greater than or equal to 0.
*/
@SerializedName("unit_cost")
@@ -234,7 +234,7 @@ public static class Paypal extends StripeObject {
public static class Tax extends StripeObject {
/**
* The total amount of tax on the transaction represented in the smallest currency unit. Required
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. Required
* for L2 rates. An integer greater than or equal to 0.
*
* This field is mutually exclusive with the {@code
diff --git a/src/main/java/com/stripe/model/PaymentLink.java b/src/main/java/com/stripe/model/PaymentLink.java
index dcd309e9b9b..55261a8c76f 100644
--- a/src/main/java/com/stripe/model/PaymentLink.java
+++ b/src/main/java/com/stripe/model/PaymentLink.java
@@ -27,12 +27,12 @@
* payment link can be shared and used multiple times.
*
* When a customer opens a payment link it will open a new checkout session to render the payment
+ * href="https://docs.stripe.com/api/checkout/sessions">checkout session to render the payment
* page. You can use checkout
+ * href="https://docs.stripe.com/api/events/types#event_types-checkout.session.completed">checkout
* session events to track payments through payment links.
*
- * Related guide: Payment Links API
+ * Related guide: Payment Links API
*/
@Getter
@Setter
@@ -137,7 +137,7 @@ public class PaymentLink extends ApiResource implements HasId, MetadataStore Related guides: Payment Methods
- * and More Payment Scenarios.
+ * Related guides: Payment Methods
+ * and More Payment Scenarios.
*/
@Getter
@Setter
@@ -178,7 +178,7 @@ public class PaymentMethod extends ApiResource implements HasId, MetadataStore key-value pairs that you can attach
+ * 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.
*/
@@ -240,7 +240,7 @@ public class PaymentMethod extends ApiResource implements HasId, MetadataStore Radar
+ * Options to configure Radar. See Radar
* Session for more information.
*/
@SerializedName("radar_options")
@@ -603,22 +603,12 @@ public PaymentMethod detach(PaymentMethodDetachParams params, RequestOptions opt
return getResponseGetter().request(request, PaymentMethod.class);
}
- /**
- * Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods
- * attached to a Customer for payments, you should use the List a Customer’s
- * PaymentMethods API instead.
- */
+ /** Returns a list of all PaymentMethods. */
public static PaymentMethodCollection list(Map One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code
+ * TRIONL2U}.
*/
@SerializedName("bic")
String bic;
@@ -2488,7 +2470,7 @@ public static class Promptpay extends StripeObject {}
public static class Qris extends StripeObject {}
/**
- * Options to configure Radar. See Radar
+ * Options to configure Radar. See Radar
* Session for more information.
*/
@Getter
@@ -2496,7 +2478,7 @@ public static class Qris extends StripeObject {}
@EqualsAndHashCode(callSuper = false)
public static class RadarOptions extends StripeObject {
/**
- * A Radar Session is a snapshot of
+ * A Radar Session is a snapshot of
* the browser metadata and device details that help Radar make more accurate predictions on
* your payments.
*/
diff --git a/src/main/java/com/stripe/model/PaymentMethodConfiguration.java b/src/main/java/com/stripe/model/PaymentMethodConfiguration.java
index 73e5c3c2d20..0da6fc839cc 100644
--- a/src/main/java/com/stripe/model/PaymentMethodConfiguration.java
+++ b/src/main/java/com/stripe/model/PaymentMethodConfiguration.java
@@ -24,7 +24,7 @@
* different sets of payment methods for different scenarios.
*
* There are two types of PaymentMethodConfigurations. Which is used depends on the charge type:
+ * href="https://docs.stripe.com/connect/charges">charge type:
*
* Direct configurations apply to payments created on your account, including
* Connect destination charges, Connect separate charges and transfers, and payments not involving
@@ -41,11 +41,11 @@
* dashboard and are not available in this API.
*
* Related guides: - Payment Method
+ * href="https://docs.stripe.com/connect/payment-method-configurations">Payment Method
* Configurations API - Multiple configurations
+ * href="https://docs.stripe.com/payments/multiple-payment-method-configs">Multiple configurations
* on dynamic payment methods - Multiple
+ * href="https://docs.stripe.com/connect/multiple-payment-method-configurations">Multiple
* configurations for your Connect accounts
*/
@Getter
diff --git a/src/main/java/com/stripe/model/PaymentMethodDomain.java b/src/main/java/com/stripe/model/PaymentMethodDomain.java
index 41099bd2bdb..9343eb0023a 100644
--- a/src/main/java/com/stripe/model/PaymentMethodDomain.java
+++ b/src/main/java/com/stripe/model/PaymentMethodDomain.java
@@ -25,7 +25,7 @@
* shown.
*
* Related guide: Payment method
+ * href="https://docs.stripe.com/payments/payment-methods/pmd-registration">Payment method
* domains.
*/
@Getter
diff --git a/src/main/java/com/stripe/model/PaymentRecord.java b/src/main/java/com/stripe/model/PaymentRecord.java
index e40284f02b6..ea9154631a8 100644
--- a/src/main/java/com/stripe/model/PaymentRecord.java
+++ b/src/main/java/com/stripe/model/PaymentRecord.java
@@ -103,7 +103,7 @@ public class PaymentRecord extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -126,6 +126,14 @@ public class PaymentRecord extends ApiResource implements HasId {
@SerializedName("processor_details")
ProcessorDetails processorDetails;
+ /**
+ * Indicates who reported the payment.
+ *
+ * One of {@code self}, or {@code stripe}.
+ */
+ @SerializedName("reported_by")
+ String reportedBy;
+
/** Shipping information for this payment. */
@SerializedName("shipping_details")
ShippingDetails shippingDetails;
@@ -512,7 +520,7 @@ public static class Amount extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -534,7 +542,7 @@ public static class AmountAuthorized extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -556,7 +564,7 @@ public static class AmountCanceled extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -578,7 +586,7 @@ public static class AmountFailed extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -600,7 +608,7 @@ public static class AmountGuaranteed extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -622,7 +630,7 @@ public static class AmountRefunded extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -644,7 +652,7 @@ public static class AmountRequested extends StripeObject {
/**
* A positive integer representing the amount in the currency's minor unit. For example, {@code
+ * href="https://docs.stripe.com/currencies#zero-decimal">minor unit. For example, {@code
* 100} can represent 1 USD or 100 JPY.
*/
@SerializedName("value")
@@ -877,7 +885,7 @@ public static class PaymentMethodDetails extends StripeObject {
/**
* The type of transaction-specific details of the payment method used in the payment. See PaymentMethod.type
+ * href="https://docs.stripe.com/api/payment_methods/object#payment_method_object-type">PaymentMethod.type
* for the full list of possible types. An additional hash is included on {@code
* payment_method_details} with a name matching this value. It contains information specific to
* the payment method.
@@ -975,6 +983,12 @@ public static class AcssDebit extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1008,14 +1022,14 @@ public static class AcssDebit extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Affirm extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -1198,6 +1212,12 @@ public static class AuBecsDebit extends StripeObject {
@SerializedName("bsb_number")
String bsbNumber;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1222,6 +1242,12 @@ public static class AuBecsDebit extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class BacsDebit extends StripeObject {
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -1398,7 +1424,10 @@ public static class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO 3166-2).
+ */
@SerializedName("state")
String state;
}
@@ -1438,6 +1467,10 @@ public static class Boleto extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Card extends StripeObject {
+ /** The authorization code of the payment. */
+ @SerializedName("authorization_code")
+ String authorizationCode;
+
/**
* Card brand. Can be {@code amex}, {@code cartes_bancaires}, {@code diners}, {@code
* discover}, {@code eftpos_au}, {@code jcb}, {@code link}, {@code mastercard}, {@code
@@ -1464,6 +1497,10 @@ public static class Card extends StripeObject {
@SerializedName("country")
String country;
+ /** A high-level description of the type of cards issued in this range. */
+ @SerializedName("description")
+ String description;
+
/** Two-digit number representing the card's expiration month. */
@SerializedName("exp_month")
Long expMonth;
@@ -1491,6 +1528,18 @@ public static class Card extends StripeObject {
@SerializedName("funding")
String funding;
+ /** Issuer identification number of the card. */
+ @SerializedName("iin")
+ String iin;
+
+ /** Installment details for this payment. */
+ @SerializedName("installments")
+ Installments installments;
+
+ /** The name of the card's issuing bank. */
+ @SerializedName("issuer")
+ String issuer;
+
/** The last four digits of the card. */
@SerializedName("last4")
String last4;
@@ -1508,6 +1557,14 @@ public static class Card extends StripeObject {
@SerializedName("network")
String network;
+ /** Advice code from the card network for the failed payment. */
+ @SerializedName("network_advice_code")
+ String networkAdviceCode;
+
+ /** Decline code from the card network for the failed payment. */
+ @SerializedName("network_decline_code")
+ String networkDeclineCode;
+
/**
* If this card has network token credentials, this contains the details of the network token
* credentials.
@@ -1524,6 +1581,13 @@ public static class Card extends StripeObject {
@SerializedName("network_transaction_id")
String networkTransactionId;
+ /**
+ * The transaction type that was passed for an off-session, Merchant-Initiated transaction,
+ * one of {@code recurring} or {@code unscheduled}.
+ */
+ @SerializedName("stored_credential_usage")
+ String storedCredentialUsage;
+
/** Populated if this transaction used 3D Secure authentication. */
@SerializedName("three_d_secure")
ThreeDSecure threeDSecure;
@@ -1550,6 +1614,48 @@ public static class Checks extends StripeObject {
String cvcCheck;
}
+ /**
+ * For more details about Installments, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Installments extends StripeObject {
+ @SerializedName("plan")
+ Plan plan;
+
+ /**
+ * For more details about Plan, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Plan extends StripeObject {
+ /**
+ * For {@code fixed_count} installment plans, this is the number of installment payments
+ * your customer will make to their credit card.
+ */
+ @SerializedName("count")
+ Long count;
+
+ /**
+ * For {@code fixed_count} installment plans, this is the interval between installment
+ * payments your customer will make to their credit card. One of {@code month}.
+ */
+ @SerializedName("interval")
+ String interval;
+
+ /**
+ * Type of installment plan, one of {@code fixed_count}, {@code revolving}, or {@code
+ * bonus}.
+ */
+ @SerializedName("type")
+ String type;
+ }
+ }
+
/**
* For more details about NetworkToken, please refer to the API Reference.
@@ -1745,9 +1851,9 @@ public static class CardPresent extends StripeObject {
String iin;
/**
- * Whether this PaymentIntent is
+ * Whether this PaymentIntent is
* eligible for incremental authorizations. Request support using request_incremental_authorization_support.
+ * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support">request_incremental_authorization_support.
*/
@SerializedName("incremental_authorization_supported")
Boolean incrementalAuthorizationSupported;
@@ -2165,9 +2271,10 @@ public static class IdBankTransfer extends StripeObject {
public static class Ideal extends StripeObject {
/**
* The customer's bank. Can be one of {@code abn_amro}, {@code asn_bank}, {@code bunq}, {@code
- * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code moneyou},
- * {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code revolut}, {@code
- * sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code yoursafe}.
+ * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code mollie},
+ * {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code
+ * revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code
+ * yoursafe}.
*/
@SerializedName("bank")
String bank;
@@ -2177,8 +2284,9 @@ public static class Ideal extends StripeObject {
*
* One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or
+ * {@code TRIONL2U}.
*/
@SerializedName("bic")
String bic;
@@ -2731,6 +2839,12 @@ public static class NzBankAccount extends StripeObject {
@SerializedName("branch_code")
String branchCode;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/** Last four digits of the bank account number. */
@SerializedName("last4")
String last4;
@@ -2822,14 +2936,14 @@ public static class Payco extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Paynow extends StripeObject {
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -3181,6 +3295,12 @@ public static class SepaDebit extends StripeObject {
@SerializedName("country")
String country;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -3194,9 +3314,9 @@ public static class SepaDebit extends StripeObject {
/**
* Find the ID of the mandate used for this payment under the payment_method_details.sepa_debit.mandate
+ * href="https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate">payment_method_details.sepa_debit.mandate
* property on the Charge. Use this mandate ID to retrieve the Mandate.
+ * href="https://docs.stripe.com/api/mandates/retrieve">retrieve the Mandate.
*/
@SerializedName("mandate")
String mandate;
@@ -3403,6 +3523,12 @@ public static class UsBankAccount extends StripeObject {
@SerializedName("bank_name")
String bankName;
+ /**
+ * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+ */
+ @SerializedName("expected_debit_date")
+ String expectedDebitDate;
+
/**
* Uniquely identifies this particular bank account. You can use this attribute to check
* whether two bank accounts are the same.
@@ -3472,14 +3598,14 @@ public static class WechatPay extends StripeObject {
String fingerprint;
/**
- * ID of the location that this
+ * ID of the location that this
* transaction's reader is assigned to.
*/
@SerializedName("location")
String location;
/**
- * ID of the reader this
+ * ID of the reader this
* transaction was made on.
*/
@SerializedName("reader")
@@ -3582,7 +3708,10 @@ public static class Address extends StripeObject {
@SerializedName("postal_code")
String postalCode;
- /** State, county, province, or region. */
+ /**
+ * State, county, province, or region (ISO
+ * 3166-2).
+ */
@SerializedName("state")
String state;
}
diff --git a/src/main/java/com/stripe/model/Payout.java b/src/main/java/com/stripe/model/Payout.java
index 05b7d4ec829..a7015e9eefc 100644
--- a/src/main/java/com/stripe/model/Payout.java
+++ b/src/main/java/com/stripe/model/Payout.java
@@ -28,7 +28,7 @@
* href="https://stripe.com/docs/connect/manage-payout-schedule">varying schedules, depending on
* your country and industry.
*
- * Related guide: Receiving payouts
+ * Related guide: Receiving payouts
*/
@Getter
@Setter
@@ -42,7 +42,7 @@ public class Payout extends ApiResource implements MetadataStore One of {@code completed}, {@code in_progress}, or {@code not_applicable}.
diff --git a/src/main/java/com/stripe/model/Person.java b/src/main/java/com/stripe/model/Person.java
index 41fac02ab2e..8b01c08f3c5 100644
--- a/src/main/java/com/stripe/model/Person.java
+++ b/src/main/java/com/stripe/model/Person.java
@@ -109,7 +109,7 @@ public class Person extends ApiResource implements HasId, MetadataStore Plans define the base price, currency, and billing cycle for recurring purchases of products.
- * Products help you track inventory or
- * provisioning, and plans help you track pricing. Different physical goods or levels of service
- * should be represented by products, and pricing options should be represented by plans. This
- * approach lets you change prices without having to change your provisioning scheme.
+ * Products help you track inventory or provisioning,
+ * and plans help you track pricing. Different physical goods or levels of service should be
+ * represented by products, and pricing options should be represented by plans. This approach lets
+ * you change prices without having to change your provisioning scheme.
*
* For example, you might have a single "gold" product that has plans for $10/month,
* $100/year, €9/month, and €90/year.
*
* Related guides: Set up a
+ * href="https://docs.stripe.com/billing/subscriptions/set-up-subscription">Set up a
* subscription and more about products and prices.
+ * href="https://docs.stripe.com/products-prices/overview">products and prices.
*/
@Getter
@Setter
@@ -117,7 +117,7 @@ public class Plan extends ApiResource implements HasId, MetadataStore Related guides: Set up a
- * subscription, create an
- * invoice, and more about products
+ * href="https://docs.stripe.com/billing/subscriptions/set-up-subscription">Set up a
+ * subscription, create an
+ * invoice, and more about products
* and prices.
*/
@Getter
@@ -109,7 +109,7 @@ public class Price extends ApiResource implements HasId, MetadataStore Related guides: Set up a
- * subscription, share a Payment Link, accept
+ * href="https://docs.stripe.com/billing/subscriptions/set-up-subscription">Set up a
+ * subscription, share a Payment Link, accept
* payments with Checkout, and more about Products and Prices
+ * href="https://docs.stripe.com/products-prices/overview">Products and Prices
*/
@Getter
@Setter
@@ -48,7 +48,7 @@ public class Product extends ApiResource implements HasId, MetadataStore If you enable promotion codes in your customer portal
+ * href="https://docs.stripe.com/customer-management/configure-portal">customer portal
* configuration, then customers can redeem a code themselves when updating a subscription in
* the portal. Customers can also view the currently active promotion codes and coupons on each of
* their subscriptions in the portal.
@@ -51,13 +51,13 @@ public class PromotionCode extends ApiResource implements HasId, MetadataStore customer;
- /** The account that this promotion code can be used by. */
+ /** The account representing the customer who can use this promotion code. */
@SerializedName("customer_account")
String customerAccount;
@@ -82,7 +82,7 @@ public class PromotionCode extends ApiResource implements HasId, MetadataStore key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/Quote.java b/src/main/java/com/stripe/model/Quote.java
index 5268742f7dc..20271df6386 100644
--- a/src/main/java/com/stripe/model/Quote.java
+++ b/src/main/java/com/stripe/model/Quote.java
@@ -110,8 +110,8 @@ public class Quote extends ApiResource implements HasId, MetadataStore Related guide: Applying discounts to
+ * href="https://docs.stripe.com/billing/subscriptions/discounts">Applying discounts to
* subscriptions
*/
@SerializedName("discount")
@@ -1599,13 +1599,13 @@ public static class Discount extends StripeObject {
/**
* A discount represents the actual application of a coupon or promotion code. It contains
+ * href="https://api.stripe.com#coupons">coupon or promotion code. It contains
* information about when the discount began, when it will end, and what it is applied
* to.
*
* Related guide: Applying discounts to
+ * href="https://docs.stripe.com/billing/subscriptions/discounts">Applying discounts to
* subscriptions
*/
@SerializedName("discount")
@@ -2008,7 +2008,7 @@ public static class SubscriptionData extends StripeObject {
ExpandableField One of {@code always_invoice}, {@code create_prorations}, or {@code none}.
@@ -2271,8 +2271,8 @@ public static class SubscriptionDataOverride extends StripeObject {
String billingBehavior;
/**
- * The customer which this quote belongs to. A customer is required before finalizing the quote.
- * Once specified, it cannot be changed.
+ * The customer who received this quote. A customer is required to finalize the quote. Once
+ * specified, you can't change it.
*/
@SerializedName("customer")
String customer;
@@ -2295,7 +2295,7 @@ public static class SubscriptionDataOverride extends StripeObject {
/**
* Determines how to handle prorations when the
+ * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations when the
* quote is accepted.
*
* One of {@code always_invoice}, {@code create_prorations}, or {@code none}.
@@ -2565,12 +2565,12 @@ public static class Discount extends StripeObject {
/**
* A discount represents the actual application of a coupon or promotion code. It contains
- * information about when the discount began, when it will end, and what it is applied to.
+ * href="https://api.stripe.com#coupons">coupon or promotion code. It contains information
+ * about when the discount began, when it will end, and what it is applied to.
*
* Related guide: Applying discounts to
+ * href="https://docs.stripe.com/billing/subscriptions/discounts">Applying discounts to
* subscriptions
*/
@SerializedName("discount")
diff --git a/src/main/java/com/stripe/model/QuoteLine.java b/src/main/java/com/stripe/model/QuoteLine.java
index 4e85447bcd9..371937fbd56 100644
--- a/src/main/java/com/stripe/model/QuoteLine.java
+++ b/src/main/java/com/stripe/model/QuoteLine.java
@@ -280,7 +280,7 @@ public static class AddItem extends StripeObject {
List They contain invoice items, and
- * proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
+ * 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
+ * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">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
@@ -47,9 +47,9 @@
* the customer's credit balance which is applied to the next invoice.
*
* More details on the customer's credit balance are here.
+ * href="https://docs.stripe.com/billing/customer/balance">here.
*
- * Related guide: Send invoices to
+ * Related guide: Send invoices to
* customers
*/
@Getter
@@ -203,7 +203,7 @@ public class QuotePreviewInvoice extends ApiResource implements HasId {
@SerializedName("custom_fields")
List One of {@code fixed}, or {@code maximum}.
+ */
+ @SerializedName("amount_type")
+ String amountType;
+
+ /**
+ * The purpose for which payments are made. Has a default value based on your merchant
+ * category code.
+ *
+ * One of {@code dependant_support}, {@code government}, {@code loan}, {@code
+ * mortgage}, {@code other}, {@code pension}, {@code personal}, {@code retail}, {@code
+ * salary}, {@code tax}, or {@code utility}.
+ */
+ @SerializedName("purpose")
+ String purpose;
+ }
+ }
+
/**
* For more details about Pix, please refer to the API
* Reference.
@@ -2158,6 +2212,7 @@ public static class TotalTax extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class TaxRateDetails extends StripeObject {
+ /** ID of the tax rate. */
@SerializedName("tax_rate")
String taxRate;
}
diff --git a/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java b/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java
index 7c31549af0f..07c337d4798 100644
--- a/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java
+++ b/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java
@@ -113,7 +113,7 @@ public class QuotePreviewSubscriptionSchedule extends ApiResource implements Has
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -150,7 +150,7 @@ public class QuotePreviewSubscriptionSchedule extends ApiResource implements Has
* The present status of the subscription schedule. Possible values are {@code not_started},
* {@code active}, {@code completed}, {@code released}, and {@code canceled}. You can read more
* about the different states in our behavior guide.
+ * href="https://docs.stripe.com/billing/subscriptions/subscription-schedules">behavior guide.
*
* One of {@code active}, {@code canceled}, {@code completed}, {@code not_started}, or {@code
* released}.
@@ -395,7 +395,7 @@ public static class DefaultSettings extends StripeObject {
* billing cycle anchor of the subscription is set to the start of the phase when entering the
* phase. If {@code automatic} then the billing cycle anchor is automatically modified as needed
* when entering the phase. For more information, see the billing cycle documentation.
+ * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation.
*
* One of {@code automatic}, or {@code phase_start}.
*/
@@ -815,7 +815,7 @@ public static class Phase extends StripeObject {
* billing cycle anchor of the subscription is set to the start of the phase when entering the
* phase. If {@code automatic} then the billing cycle anchor is automatically modified as needed
* when entering the phase. For more information, see the billing cycle documentation.
+ * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation.
*
* One of {@code automatic}, or {@code phase_start}.
*/
@@ -896,7 +896,7 @@ public static class Phase extends StripeObject {
List Related guide: Refunds
+ * Related guide: Refunds
*/
@Getter
@Setter
@@ -97,7 +97,7 @@ public class Refund extends ApiResource implements MetadataStore Learn more about Radar and reviewing payments here.
+ * href="https://docs.stripe.com/radar/reviews">here.
*/
@Getter
@Setter
diff --git a/src/main/java/com/stripe/model/SetupAttempt.java b/src/main/java/com/stripe/model/SetupAttempt.java
index 97839922f86..86e67391664 100644
--- a/src/main/java/com/stripe/model/SetupAttempt.java
+++ b/src/main/java/com/stripe/model/SetupAttempt.java
@@ -27,7 +27,7 @@
public class SetupAttempt extends ApiResource implements HasId {
/**
* The value of application
+ * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application">application
* on the SetupIntent at the time of this confirmation.
*/
@SerializedName("application")
@@ -51,7 +51,7 @@ public class SetupAttempt extends ApiResource implements HasId {
/**
* The value of customer
+ * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer">customer
* on the SetupIntent at the time of this confirmation.
*/
@SerializedName("customer")
@@ -61,7 +61,7 @@ public class SetupAttempt extends ApiResource implements HasId {
/**
* The value of customer_account
+ * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account">customer_account
* on the SetupIntent at the time of this confirmation.
*/
@SerializedName("customer_account")
@@ -100,7 +100,7 @@ public class SetupAttempt extends ApiResource implements HasId {
/**
* The value of on_behalf_of
+ * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of">on_behalf_of
* on the SetupIntent at the time of this confirmation.
*/
@SerializedName("on_behalf_of")
@@ -136,7 +136,7 @@ public class SetupAttempt extends ApiResource implements HasId {
/**
* The value of usage on
+ * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage">usage on
* the SetupIntent at the time of this confirmation, one of {@code off_session} or {@code
* on_session}.
*/
@@ -840,9 +840,10 @@ public static class IdBankTransfer extends StripeObject {
public static class Ideal extends StripeObject {
/**
* The customer's bank. Can be one of {@code abn_amro}, {@code asn_bank}, {@code bunq}, {@code
- * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code moneyou},
- * {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code revolut}, {@code
- * sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code yoursafe}.
+ * buut}, {@code finom}, {@code handelsbanken}, {@code ing}, {@code knab}, {@code mollie},
+ * {@code moneyou}, {@code n26}, {@code nn}, {@code rabobank}, {@code regiobank}, {@code
+ * revolut}, {@code sns_bank}, {@code triodos_bank}, {@code van_lanschot}, or {@code
+ * yoursafe}.
*/
@SerializedName("bank")
String bank;
@@ -852,8 +853,9 @@ public static class Ideal extends StripeObject {
*
* One of {@code ABNANL2A}, {@code ASNBNL21}, {@code BITSNL2A}, {@code BUNQNL2A}, {@code
* BUUTNL2A}, {@code FNOMNL22}, {@code FVLBNL22}, {@code HANDNL2A}, {@code INGBNL2A}, {@code
- * KNABNL2H}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code RABONL2U}, {@code
- * RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or {@code TRIONL2U}.
+ * KNABNL2H}, {@code MLLENL2A}, {@code MOYONL21}, {@code NNBANL2G}, {@code NTSBDEB1}, {@code
+ * RABONL2U}, {@code RBRBNL21}, {@code REVOIE23}, {@code REVOLT21}, {@code SNSBNL2A}, or
+ * {@code TRIONL2U}.
*/
@SerializedName("bic")
String bic;
diff --git a/src/main/java/com/stripe/model/SetupIntent.java b/src/main/java/com/stripe/model/SetupIntent.java
index 3cf06bee3e5..9a0ddf2e0c6 100644
--- a/src/main/java/com/stripe/model/SetupIntent.java
+++ b/src/main/java/com/stripe/model/SetupIntent.java
@@ -26,7 +26,7 @@
* A SetupIntent guides you through the process of setting up and saving a customer's payment
* credentials for future payments. For example, you can use a SetupIntent to set up and save your
* customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.
+ * href="https://api.stripe.com#payment_intents">PaymentIntents to drive the payment flow.
*
* Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't
* maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent
@@ -40,13 +40,11 @@
* be run through Strong Customer
* Authentication during payment method collection to streamline later off-session payments. If you use the
- * SetupIntent with a Customer, it automatically
- * attaches the resulting payment method to that Customer after successful setup. We recommend using
- * SetupIntents or setup_future_usage
- * on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment
- * methods.
+ * SetupIntent with a Customer, it
+ * automatically attaches the resulting payment method to that Customer after successful setup. We
+ * recommend using SetupIntents or setup_future_usage on
+ * PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
*
* By using SetupIntents, you can reduce friction for your customers, even as regulations change
* over time.
@@ -166,7 +164,7 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStore Redirect-based payment methods may require your customer to be redirected to a payment
* method's app or site for authentication or additional steps. To confirm this SetupIntent, you
+ * href="https://docs.stripe.com/api/setup_intents/confirm">confirm this SetupIntent, you
* may be required to provide a {@code return_url} to redirect customers back to your site after
* they authenticate or complete the setup.
*
@@ -1222,11 +1220,11 @@ public static class Card extends StripeObject {
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your
* customers for authentication based on risk level and other requirements.
+ * href="https://docs.stripe.com/strong-customer-authentication">other requirements.
* However, if you wish to request 3D Secure based on logic from your own fraud engine,
* provide this option. If not provided, this value defaults to {@code automatic}. Read our
* guide on manually
+ * href="https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds">manually
* requesting 3D Secure for more information on how this configuration interacts with
* Radar and our SCA Engine.
*
diff --git a/src/main/java/com/stripe/model/ShippingRate.java b/src/main/java/com/stripe/model/ShippingRate.java
index 109b4ddb9e3..4615d03b48a 100644
--- a/src/main/java/com/stripe/model/ShippingRate.java
+++ b/src/main/java/com/stripe/model/ShippingRate.java
@@ -21,7 +21,7 @@
/**
* Shipping rates describe the price of shipping presented to your customers and applied to a
* purchase. For more information, see Charge for shipping.
+ * href="https://docs.stripe.com/payments/during-payment/charge-shipping">Charge for shipping.
*/
@Getter
@Setter
@@ -65,7 +65,7 @@ public class ShippingRate extends ApiResource implements HasId, MetadataStore Stripe doesn't recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API
+ * href="https://docs.stripe.com/api/sources">Sources API. We recommend that you adopt the PaymentMethods API. This newer API
* provides access to our latest features and payment method types.
*
- * Related guides: Sources API and Sources & Customers.
+ * Related guides: Sources API and Sources & Customers.
*/
@Getter
@Setter
@@ -140,7 +140,7 @@ public class Source extends ApiResource implements MetadataStore Stripe doesn't recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API
+ * href="https://docs.stripe.com/api/sources">Sources API. We recommend that you adopt the PaymentMethods API. This newer API
* provides access to our latest features and payment method types.
*
- * Related guides: Sources API and Sources & Customers.
+ * Related guides: Sources API and Sources & Customers.
*/
@SerializedName("source")
Source source;
diff --git a/src/main/java/com/stripe/model/StripeError.java b/src/main/java/com/stripe/model/StripeError.java
index 557dd25acde..8ef74da144f 100644
--- a/src/main/java/com/stripe/model/StripeError.java
+++ b/src/main/java/com/stripe/model/StripeError.java
@@ -12,7 +12,7 @@
public class StripeError extends StripeObject {
/**
* For card errors resulting from a card issuer decline, a short string indicating how to proceed with an
+ * href="https://docs.stripe.com/declines#retrying-issuer-declines">how to proceed with an
* error if they provide one.
*/
@SerializedName("advice_code")
@@ -24,12 +24,13 @@ public class StripeError extends StripeObject {
/**
* For some errors that could be handled programmatically, a short string indicating the error code reported.
+ * href="https://docs.stripe.com/error-codes">error code reported.
*
* One of {@code account_closed}, {@code account_country_invalid_address}, {@code
* account_error_country_change_requires_additional_steps}, {@code account_information_mismatch},
- * {@code account_invalid}, {@code account_number_invalid}, {@code acss_debit_session_incomplete},
- * {@code alipay_upgrade_required}, {@code amount_too_large}, {@code amount_too_small}, {@code
+ * {@code account_invalid}, {@code account_number_invalid}, {@code
+ * account_token_required_for_v2_account}, {@code acss_debit_session_incomplete}, {@code
+ * alipay_upgrade_required}, {@code amount_too_large}, {@code amount_too_small}, {@code
* api_key_expired}, {@code application_fees_not_allowed}, {@code authentication_required}, {@code
* balance_insufficient}, {@code balance_invalid_parameter}, {@code
* bank_account_bad_routing_numbers}, {@code bank_account_declined}, {@code bank_account_exists},
@@ -117,14 +118,14 @@ public class StripeError extends StripeObject {
/**
* For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the
+ * href="https://docs.stripe.com/declines#issuer-declines">card issuer's reason for the
* decline if they provide one.
*/
@SerializedName("decline_code")
String declineCode;
/**
- * A URL to more information about the error
+ * A URL to more information about the error
* code reported.
*/
@SerializedName("doc_url")
@@ -165,11 +166,11 @@ public class StripeError extends StripeObject {
* particular session.
*
* A PaymentIntent transitions through multiple statuses
- * throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and
- * ultimately creates at most one successful charge.
+ * href="https://stripe.com/payments/paymentintents/lifecycle">multiple statuses throughout
+ * its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately
+ * creates at most one successful charge.
*
- * Related guide: Payment Intents
+ * Related guide: Payment Intents
* API
*/
@SerializedName("payment_intent")
@@ -177,11 +178,11 @@ public class StripeError extends StripeObject {
/**
* PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments
+ * href="https://docs.stripe.com/payments/payment-intents">PaymentIntents Related guides: Payment
- * Methods and More Payment
+ * Related guides: Payment
+ * Methods and More Payment
* Scenarios.
*/
@SerializedName("payment_method")
@@ -202,8 +203,7 @@ public class StripeError extends StripeObject {
* A SetupIntent guides you through the process of setting up and saving a customer's payment
* credentials for future payments. For example, you can use a SetupIntent to set up and save your
* customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment
- * flow.
+ * href="https://api.stripe.com#payment_intents">PaymentIntents Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't
* maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent
@@ -217,11 +217,10 @@ public class StripeError extends StripeObject {
* to be run through Strong
* Customer Authentication during payment method collection to streamline later off-session payments. If you use the
- * SetupIntent with a Customer, it automatically
- * attaches the resulting payment method to that Customer after successful setup. We recommend
- * using SetupIntents or setup_future_usage
+ * SetupIntent with a Customer,
+ * it automatically attaches the resulting payment method to that Customer after successful setup.
+ * We recommend using SetupIntents or setup_future_usage
* on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment
* methods.
*
diff --git a/src/main/java/com/stripe/model/Subscription.java b/src/main/java/com/stripe/model/Subscription.java
index 5985d78778d..9db3a247993 100644
--- a/src/main/java/com/stripe/model/Subscription.java
+++ b/src/main/java/com/stripe/model/Subscription.java
@@ -30,7 +30,7 @@
/**
* Subscriptions allow you to charge a customer on a recurring basis.
*
- * Related guide: Creating
+ * Related guide: Creating
* subscriptions
*/
@Getter
@@ -65,7 +65,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStore If subscription {@code collection_method=charge_automatically}, it becomes {@code past_due}
@@ -1923,6 +1923,13 @@ public static class PaymentMethodOptions extends StripeObject {
@SerializedName("konbini")
Konbini konbini;
+ /**
+ * This sub-hash contains details about the PayTo payment method options to pass to invoices
+ * created by the subscription.
+ */
+ @SerializedName("payto")
+ Payto payto;
+
/**
* This sub-hash contains details about the Pix payment method options to pass to invoices
* created by the subscription.
@@ -2027,10 +2034,10 @@ public static class Card extends StripeObject {
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your
* customers for authentication based on risk level and other requirements.
+ * href="https://docs.stripe.com/strong-customer-authentication">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
+ * href="https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds">manually
* requesting 3D Secure for more information on how this configuration interacts with
* Radar and our SCA Engine.
*
@@ -2145,6 +2152,53 @@ public static class IdBankTransfer extends StripeObject {}
@EqualsAndHashCode(callSuper = false)
public static class Konbini extends StripeObject {}
+ /**
+ * For more details about Payto, please refer to the API
+ * Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class Payto extends StripeObject {
+ @SerializedName("mandate_options")
+ MandateOptions mandateOptions;
+
+ /**
+ * For more details about MandateOptions, please refer to the API Reference.
+ */
+ @Getter
+ @Setter
+ @EqualsAndHashCode(callSuper = false)
+ public static class MandateOptions extends StripeObject {
+ /**
+ * The maximum amount that can be collected in a single invoice. If you don't specify a
+ * maximum, then there is no limit.
+ */
+ @SerializedName("amount")
+ Long amount;
+
+ /**
+ * Only {@code maximum} is supported.
+ *
+ * One of {@code fixed}, or {@code maximum}.
+ */
+ @SerializedName("amount_type")
+ String amountType;
+
+ /**
+ * The purpose for which payments are made. Has a default value based on your merchant
+ * category code.
+ *
+ * One of {@code dependant_support}, {@code government}, {@code loan}, {@code
+ * mortgage}, {@code other}, {@code pension}, {@code personal}, {@code retail}, {@code
+ * salary}, {@code tax}, or {@code utility}.
+ */
+ @SerializedName("purpose")
+ String purpose;
+ }
+ }
+
/**
* For more details about Pix, please refer to the API
* Reference.
@@ -2386,7 +2440,7 @@ public static class PendingUpdate extends StripeObject {
* Indicates if a plan's {@code trial_period_days} should be applied to the subscription.
* Setting {@code trial_end} per subscription is preferred, and this defaults to {@code false}.
* Setting this flag to {@code true} together with {@code trial_end} is not allowed. See Using trial periods on
+ * href="https://docs.stripe.com/billing/subscriptions/trials">Using trial periods on
* subscriptions to learn more.
*/
@SerializedName("trial_from_plan")
diff --git a/src/main/java/com/stripe/model/SubscriptionItem.java b/src/main/java/com/stripe/model/SubscriptionItem.java
index e525396e6d4..93d42eac77e 100644
--- a/src/main/java/com/stripe/model/SubscriptionItem.java
+++ b/src/main/java/com/stripe/model/SubscriptionItem.java
@@ -70,7 +70,7 @@ public class SubscriptionItem extends ApiResource
String id;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -88,48 +88,48 @@ public class SubscriptionItem extends ApiResource
/**
* You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is
- * backwards compatible to simplify your migration.
+ * href="https://api.stripe.com#prices">Prices API. It replaces the Plans API and is backwards
+ * compatible to simplify your migration.
*
* Plans define the base price, currency, and billing cycle for recurring purchases of
- * products. Products help you track inventory
- * or provisioning, and plans help you track pricing. Different physical goods or levels of
- * service should be represented by products, and pricing options should be represented by plans.
- * This approach lets you change prices without having to change your provisioning scheme.
+ * products. Products help you track inventory or
+ * provisioning, and plans help you track pricing. Different physical goods or levels of service
+ * should be represented by products, and pricing options should be represented by plans. This
+ * approach lets you change prices without having to change your provisioning scheme.
*
* For example, you might have a single "gold" product that has plans for $10/month,
* $100/year, €9/month, and €90/year.
*
* Related guides: Set up a
+ * href="https://docs.stripe.com/billing/subscriptions/set-up-subscription">Set up a
* subscription and more about products and prices.
+ * href="https://docs.stripe.com/products-prices/overview">products and prices.
*/
@SerializedName("plan")
Plan plan;
/**
* Prices define the unit cost, currency, and (optional) billing cycle for both recurring and
- * one-time purchases of products. Products
- * help you track inventory or provisioning, and prices help you track payment terms. Different
- * physical goods or levels of service should be represented by products, and pricing options
- * should be represented by prices. This approach lets you change prices without having to change
- * your provisioning scheme.
+ * one-time purchases of products. Products help you
+ * track inventory or provisioning, and prices help you track payment terms. Different physical
+ * goods or levels of service should be represented by products, and pricing options should be
+ * represented by prices. This approach lets you change prices without having to change your
+ * provisioning scheme.
*
* For example, you might have a single "gold" product that has prices for $10/month,
* $100/year, and €9 once.
*
* Related guides: Set up a
- * subscription, create an
- * invoice, and more about products
+ * href="https://docs.stripe.com/billing/subscriptions/set-up-subscription">Set up a
+ * subscription, create an
+ * invoice, and more about products
* and prices.
*/
@SerializedName("price")
Price price;
/**
- * The quantity of the plan to
+ * The quantity of the plan to
* which the customer should be subscribed.
*/
@SerializedName("quantity")
diff --git a/src/main/java/com/stripe/model/SubscriptionSchedule.java b/src/main/java/com/stripe/model/SubscriptionSchedule.java
index 090e4a87ffd..38ef2cbdb2f 100644
--- a/src/main/java/com/stripe/model/SubscriptionSchedule.java
+++ b/src/main/java/com/stripe/model/SubscriptionSchedule.java
@@ -30,7 +30,7 @@
* predefining expected changes.
*
* Related guide: Subscription
+ * href="https://docs.stripe.com/billing/subscriptions/subscription-schedules">Subscription
* schedules
*/
@Getter
@@ -125,7 +125,7 @@ public class SubscriptionSchedule extends ApiResource
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -163,7 +163,7 @@ public class SubscriptionSchedule extends ApiResource
* The present status of the subscription schedule. Possible values are {@code not_started},
* {@code active}, {@code completed}, {@code released}, and {@code canceled}. You can read more
* about the different states in our behavior guide.
+ * href="https://docs.stripe.com/billing/subscriptions/subscription-schedules">behavior guide.
*
* One of {@code active}, {@code canceled}, {@code completed}, {@code not_started}, or {@code
* released}.
@@ -710,7 +710,7 @@ public static class DefaultSettings extends StripeObject {
* billing cycle anchor of the subscription is set to the start of the phase when entering the
* phase. If {@code automatic} then the billing cycle anchor is automatically modified as needed
* when entering the phase. For more information, see the billing cycle documentation.
+ * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation.
*
* One of {@code automatic}, or {@code phase_start}.
*/
@@ -1129,7 +1129,7 @@ public static class Phase extends StripeObject {
* billing cycle anchor of the subscription is set to the start of the phase when entering the
* phase. If {@code automatic} then the billing cycle anchor is automatically modified as needed
* when entering the phase. For more information, see the billing cycle documentation.
+ * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation.
*
* One of {@code automatic}, or {@code phase_start}.
*/
@@ -1210,7 +1210,7 @@ public static class Phase extends StripeObject {
List Related guides: Customer tax
+ * Related guides: Customer tax
* identification numbers, Account tax IDs
+ * href="https://docs.stripe.com/invoicing/connect#account-tax-ids">Account tax IDs You can't store or use tokens more than once. To store card or bank account information for
- * later use, create Customer objects or Customer objects or External accounts. Radar, our integrated solution for automatic fraud
+ * href="https://docs.stripe.com/radar">Radar, our integrated solution for automatic fraud
* protection, performs best with integrations that use client-side tokenization.
*/
@Getter
@@ -57,7 +57,7 @@ public class Token extends ApiResource implements HasId {
* You can store multiple cards on a customer in order to charge the customer later. You can also
* store multiple debit cards on a recipient in order to transfer to those cards later.
*
- * Related guide: Card payments with
+ * Related guide: Card payments with
* Sources
*/
@SerializedName("card")
diff --git a/src/main/java/com/stripe/model/Topup.java b/src/main/java/com/stripe/model/Topup.java
index f2abec9ee08..8565206b87c 100644
--- a/src/main/java/com/stripe/model/Topup.java
+++ b/src/main/java/com/stripe/model/Topup.java
@@ -23,7 +23,7 @@
* To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups,
* as well as list all top-ups. Top-ups are identified by a unique, random ID.
*
- * Related guide: Topping up your platform
+ * Related guide: Topping up your platform
* account
*/
@Getter
@@ -67,7 +67,7 @@ public class Topup extends ApiResource implements MetadataStore Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a
* card or bank account. This behavior has since been split out into a Payout object, with corresponding payout
+ * href="https://api.stripe.com#payout_object">Payout Related guide: Creating separate charges
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers">Creating separate charges
* and transfers
*/
@Getter
@@ -101,7 +101,7 @@ public class Transfer extends ApiResource
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -146,7 +146,7 @@ public class Transfer extends ApiResource
/**
* A string that identifies this transaction as part of a group. See the Connect
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect
* documentation for details.
*/
@SerializedName("transfer_group")
diff --git a/src/main/java/com/stripe/model/TransferReversal.java b/src/main/java/com/stripe/model/TransferReversal.java
index 4a1f80d230e..3bf0b89d5d4 100644
--- a/src/main/java/com/stripe/model/TransferReversal.java
+++ b/src/main/java/com/stripe/model/TransferReversal.java
@@ -16,7 +16,7 @@
import lombok.Setter;
/**
- * Stripe Connect platforms can reverse transfers made
+ * Stripe Connect platforms can reverse transfers made
* to a connected account, either entirely or partially, and can also specify whether to refund any
* related application fees. Transfer reversals add to the platform's balance and subtract from the
* destination account's balance.
@@ -24,11 +24,11 @@
* Reversing a transfer that was made for a destination charge is allowed only
* up to the amount of the charge. It is possible to reverse a transfer_group
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">transfer_group
* transfer only if the destination account has enough balance to cover the reversal.
*
* Related guide: Reverse
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers">Reverse
* transfers
*/
@Getter
@@ -69,7 +69,7 @@ public class TransferReversal extends ApiResource
String id;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/WebhookEndpoint.java b/src/main/java/com/stripe/model/WebhookEndpoint.java
index 78e5535b174..71157bb11f3 100644
--- a/src/main/java/com/stripe/model/WebhookEndpoint.java
+++ b/src/main/java/com/stripe/model/WebhookEndpoint.java
@@ -72,7 +72,7 @@ public class WebhookEndpoint extends ApiResource implements HasId, MetadataStore
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
diff --git a/src/main/java/com/stripe/model/apps/Secret.java b/src/main/java/com/stripe/model/apps/Secret.java
index b2c6d4619c8..66e91925646 100644
--- a/src/main/java/com/stripe/model/apps/Secret.java
+++ b/src/main/java/com/stripe/model/apps/Secret.java
@@ -35,7 +35,7 @@
* might have different permissions.
*
* Related guide: Store data between page
+ * href="https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects">Store data between page
* reloads
*/
@Getter
diff --git a/src/main/java/com/stripe/model/billing/Alert.java b/src/main/java/com/stripe/model/billing/Alert.java
index ca48a95d463..437bee7c5a4 100644
--- a/src/main/java/com/stripe/model/billing/Alert.java
+++ b/src/main/java/com/stripe/model/billing/Alert.java
@@ -76,7 +76,7 @@ public class Alert extends ApiResource implements HasId {
/**
* Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.
+ * href="https://docs.stripe.com/api/billing/meter">Billing Meter.
*/
@SerializedName("usage_threshold")
UsageThreshold usageThreshold;
diff --git a/src/main/java/com/stripe/model/billing/CreditGrant.java b/src/main/java/com/stripe/model/billing/CreditGrant.java
index 4fe4c4730ac..f7475e96231 100644
--- a/src/main/java/com/stripe/model/billing/CreditGrant.java
+++ b/src/main/java/com/stripe/model/billing/CreditGrant.java
@@ -64,7 +64,7 @@ public class CreditGrant extends ApiResource implements HasId, MetadataStore One of {@code now}, or {@code unchanged}.
+ */
+ @SerializedName("billing_cycle_anchor")
+ String billingCycleAnchor;
+
/**
* The types of subscription updates that are supported for items listed in the {@code
* products} attribute. When empty, subscriptions are not updateable.
@@ -567,7 +579,7 @@ public static class LoginPage extends StripeObject {
/**
* A shareable URL to the hosted portal login page. Your customers will be able to log in with
- * their email
+ * their email
* and receive a link to their customer portal.
*/
@SerializedName("url")
diff --git a/src/main/java/com/stripe/model/billingportal/Session.java b/src/main/java/com/stripe/model/billingportal/Session.java
index d9b72ff93cd..3a9810f7b2e 100644
--- a/src/main/java/com/stripe/model/billingportal/Session.java
+++ b/src/main/java/com/stripe/model/billingportal/Session.java
@@ -57,7 +57,7 @@ public class Session extends ApiResource implements HasId {
/**
* Information about a specific flow for the customer to go through. See the docs to learn more
+ * href="https://docs.stripe.com/customer-management/portal-deep-links">docs to learn more
* about using customer portal deep links and flows.
*/
@SerializedName("flow")
@@ -102,9 +102,9 @@ public class Session extends ApiResource implements HasId {
* The account for which the session was created on behalf of. When specified, only subscriptions
* and invoices with this {@code on_behalf_of} account appear in the portal. For more information,
* see the docs.
+ * href="https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant">docs.
* Use the Accounts
+ * href="https://docs.stripe.com/api/accounts/object#account_object-settings-branding">Accounts
* API to modify the {@code on_behalf_of} account's branding settings, which the portal
* displays.
*/
@@ -335,7 +335,7 @@ public static class SubscriptionUpdateConfirm extends StripeObject {
List One of {@code cash_advance}, {@code fixed_term_loan}, or {@code flex_loan}.
*/
diff --git a/src/main/java/com/stripe/model/capital/FinancingSummary.java b/src/main/java/com/stripe/model/capital/FinancingSummary.java
index c018644b6f4..5b2a15e9eee 100644
--- a/src/main/java/com/stripe/model/capital/FinancingSummary.java
+++ b/src/main/java/com/stripe/model/capital/FinancingSummary.java
@@ -18,8 +18,9 @@
import lombok.Setter;
/**
- * A financing object describes an account's current financing state. Used by Connect platforms to
- * read the state of Capital offered to their connected accounts.
+ * A financing summary object describes a connected account's financing status in real time. A
+ * financing status is either {@code accepted}, {@code delivered}, or {@code none}. You can read the
+ * status of your connected accounts.
*/
@Getter
@Setter
@@ -29,11 +30,16 @@ public class FinancingSummary extends ApiResource {
* Additional information about the financing summary. Describes currency, advance amount, fee
* amount, withhold rate, remaining amount, paid amount, current repayment interval, repayment
* start date, and advance payout date.
+ *
+ * Only present for financing offers with the {@code paid_out} status.
*/
@SerializedName("details")
Details details;
- /** The Financing Offer ID this Financing Summary corresponds to. */
+ /**
+ * The unique identifier of the Financing Offer object that corresponds to the Financing Summary
+ * object.
+ */
@SerializedName("financing_offer")
String financingOffer;
@@ -46,26 +52,24 @@ public class FinancingSummary extends ApiResource {
String object;
/**
- * Status of the Connected Account's financing. /v1/capital/financing_summary
- * will only return {@code details} for {@code paid_out} financing.
+ * The financing status of the connected account.
*
* One of {@code accepted}, {@code delivered}, or {@code none}.
*/
@SerializedName("status")
String status;
- /** Retrieve the financing state for the account that was authenticated in the request. */
+ /** Retrieve the financing summary object for the account. */
public static FinancingSummary retrieve() throws StripeException {
return retrieve((Map Once payment is successful, the Checkout Session will contain a reference to the Customer, and either the successful PaymentIntent or an active Subscription.
+ * href="https://docs.stripe.com/api/customers">Customer, and either the successful PaymentIntent or an active Subscription.
*
* You can create a Checkout Session on your server and redirect to its URL to begin Checkout.
*
- * Related guide: Checkout quickstart
+ * Related guide: Checkout quickstart
*/
@Getter
@Setter
@@ -115,7 +115,7 @@ public class Session extends ApiResource implements HasId, MetadataStore One of {@code always}, {@code if_required}, or {@code never}.
@@ -402,7 +402,7 @@ public class Session extends ApiResource implements HasId, MetadataStore Related guide: Applying discounts to
+ * href="https://docs.stripe.com/billing/subscriptions/discounts">Applying discounts to
* subscriptions
*/
@SerializedName("discount")
diff --git a/src/main/java/com/stripe/model/climate/Order.java b/src/main/java/com/stripe/model/climate/Order.java
index 0810b2d9b01..b96e8a38621 100644
--- a/src/main/java/com/stripe/model/climate/Order.java
+++ b/src/main/java/com/stripe/model/climate/Order.java
@@ -114,7 +114,7 @@ public class Order extends ApiResource implements HasId, MetadataStore Each VerificationReport contains a copy of any data collected by the user as well as reference
* IDs which can be used to access collected images through the FileUpload API. To configure and create
+ * href="https://docs.stripe.com/api/files">FileUpload API. To configure and create
* VerificationReports, use the VerificationSession API.
+ * href="https://docs.stripe.com/api/identity/verification_sessions">VerificationSession API.
*
* Related guide: Accessing verification
+ * href="https://docs.stripe.com/identity/verification-sessions#results">Accessing verification
* results.
*/
@Getter
@@ -206,7 +206,7 @@ public static class Document extends StripeObject {
ExpirationDate expirationDate;
/**
- * Array of File ids containing images for this
+ * Array of File ids containing images for this
* document.
*/
@SerializedName("files")
@@ -509,7 +509,7 @@ public static class Document extends StripeObject {
/**
* Collect an ID number and perform an ID number
+ * href="https://docs.stripe.com/identity/verification-checks?type=id-number">ID number
* check with the document’s extracted name and date of birth.
*/
@SerializedName("require_id_number")
@@ -524,9 +524,9 @@ public static class Document extends StripeObject {
/**
* Capture a face image and perform a selfie check
+ * href="https://docs.stripe.com/identity/verification-checks?type=selfie">selfie check
* comparing a photo ID and a picture of your user’s face. Learn more.
+ * href="https://docs.stripe.com/identity/selfie">Learn more.
*/
@SerializedName("require_matching_selfie")
Boolean requireMatchingSelfie;
@@ -594,7 +594,7 @@ public static class Errors extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class Selfie extends StripeObject {
/**
- * ID of the File holding the image of the
+ * ID of the File holding the image of the
* identity document used in this check.
*/
@SerializedName("document")
@@ -605,7 +605,7 @@ public static class Selfie extends StripeObject {
Errors error;
/**
- * ID of the File holding the image of the
+ * ID of the File holding the image of the
* selfie used in this check.
*/
@SerializedName("selfie")
diff --git a/src/main/java/com/stripe/model/identity/VerificationSession.java b/src/main/java/com/stripe/model/identity/VerificationSession.java
index 7547f8d709a..c685348a47c 100644
--- a/src/main/java/com/stripe/model/identity/VerificationSession.java
+++ b/src/main/java/com/stripe/model/identity/VerificationSession.java
@@ -37,7 +37,7 @@
* lifetime as it progresses through the verification flow. The VerificationSession contains the
* user's verified data after verification checks are complete.
*
- * Related guide: The
+ * Related guide: The
* Verification Sessions API
*/
@Getter
@@ -54,11 +54,11 @@ public class VerificationSession extends ApiResource
/**
* The short-lived client secret used by Stripe.js to show a verification modal inside your app.
+ * href="https://docs.stripe.com/js/identity/modal">show a verification modal One of {@code canceled}, {@code processing}, {@code requires_input}, or {@code verified}.
@@ -151,7 +151,7 @@ public class VerificationSession extends ApiResource
String status;
/**
- * The type of verification
+ * The type of verification
* check to be performed.
*
* One of {@code document}, {@code id_number}, or {@code verification_flow}.
@@ -163,7 +163,7 @@ public class VerificationSession extends ApiResource
* The short-lived URL that you use to redirect a user to Stripe to submit their identity
* information. This URL expires after 48 hours and can only be used once. Don’t store it, log it,
* send it in emails or expose it to anyone other than the user. Refer to our docs on verifying
+ * href="https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect">verifying
* identity documents to learn how to redirect users to Stripe.
*/
@SerializedName("url")
@@ -748,7 +748,7 @@ public static class Document extends StripeObject {
/**
* Collect an ID number and perform an ID number
+ * href="https://docs.stripe.com/identity/verification-checks?type=id-number">ID number
* check with the document’s extracted name and date of birth.
*/
@SerializedName("require_id_number")
@@ -763,9 +763,9 @@ public static class Document extends StripeObject {
/**
* Capture a face image and perform a selfie check
+ * href="https://docs.stripe.com/identity/verification-checks?type=selfie">selfie check
* comparing a photo ID and a picture of your user’s face. Learn more.
+ * href="https://docs.stripe.com/identity/selfie">Learn more.
*/
@SerializedName("require_matching_selfie")
Boolean requireMatchingSelfie;
diff --git a/src/main/java/com/stripe/model/issuing/Authorization.java b/src/main/java/com/stripe/model/issuing/Authorization.java
index d0caa8ab788..80c1efef7f7 100644
--- a/src/main/java/com/stripe/model/issuing/Authorization.java
+++ b/src/main/java/com/stripe/model/issuing/Authorization.java
@@ -34,12 +34,12 @@
import lombok.Setter;
/**
- * When an issued card is used to make a purchase, an
+ * When an issued card is used to make a purchase, an
* Issuing {@code Authorization} object is created. Authorizations must be
+ * href="https://docs.stripe.com/issuing/purchases/authorizations">Authorizations must be
* approved for the purchase to be completed successfully.
*
- * Related guide: Issued card
+ * Related guide: Issued card
* authorizations
*/
@Getter
@@ -58,7 +58,7 @@ public class Authorization extends ApiResource
/**
* Detailed breakdown of amount components. These amounts are denominated in {@code currency} and
- * in the smallest currency unit.
+ * in the smallest currency unit.
*/
@SerializedName("amount_details")
AmountDetails amountDetails;
@@ -81,7 +81,7 @@ public class Authorization extends ApiResource
List Related guide: How to
+ * href="https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder">How to
* create a cardholder
*/
@SerializedName("cardholder")
@@ -75,9 +75,9 @@ public class Card extends ApiResource implements HasId, MetadataStore Related guide: How to create
+ * href="https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder">How to create
* a cardholder
*/
@Getter
@@ -69,7 +69,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStore Follow the
+ * href="https://docs.stripe.com/issuing/credit/report-credit-decisions-and-manage-aans">Follow the
* guide to learn about your requirements as a platform.
*/
@Getter
@@ -84,7 +84,7 @@ public class CreditUnderwritingRecord extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -102,7 +102,7 @@ public class CreditUnderwritingRecord extends ApiResource implements HasId {
/**
* File containing regulatory reporting data for the decision. Required if you are subject to this
* reporting
+ * href="https://docs.stripe.com/issuing/credit/report-required-regulatory-data-for-credit-decisions">reporting
* requirement.
*/
@SerializedName("regulatory_reporting_file")
@@ -519,7 +519,7 @@ public static class ApplicationRejected extends StripeObject {
public static class CreditLimitApproved extends StripeObject {
/**
* Credit amount approved. An approved credit limit is required before you can set a amount in
- * the CreditPolicy API.
+ * the CreditPolicy API.
*/
@SerializedName("amount")
Long amount;
@@ -544,7 +544,7 @@ public static class CreditLimitDecreased extends StripeObject {
/**
* Credit amount approved after decrease. An approved credit limit is required before you can
* set a amount in the CreditPolicy API.
+ * href="https://docs.stripe.com/api/issuing/credit_policy">CreditPolicy API.
*/
@SerializedName("amount")
Long amount;
diff --git a/src/main/java/com/stripe/model/issuing/Dispute.java b/src/main/java/com/stripe/model/issuing/Dispute.java
index 6abb4b736cd..bc636afb9f9 100644
--- a/src/main/java/com/stripe/model/issuing/Dispute.java
+++ b/src/main/java/com/stripe/model/issuing/Dispute.java
@@ -27,10 +27,10 @@
import lombok.Setter;
/**
- * As a card issuer, you can dispute transactions that
+ * As a card issuer, you can dispute transactions that
* the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
*
- * Related guide: Issuing
+ * Related guide: Issuing
* disputes
*/
@Getter
@@ -40,7 +40,7 @@ public class Dispute extends ApiResource
implements MetadataStore Related guide: Issued card
+ * Related guide: Issued card
* transactions
*/
@Getter
@@ -42,7 +42,7 @@ public class Transaction extends ApiResource
implements MetadataStore Related guide: Early
+ * Related guide: Early
* fraud warnings
*/
@Getter
diff --git a/src/main/java/com/stripe/model/radar/ValueList.java b/src/main/java/com/stripe/model/radar/ValueList.java
index 88a9eb36714..cc1ad900b1c 100644
--- a/src/main/java/com/stripe/model/radar/ValueList.java
+++ b/src/main/java/com/stripe/model/radar/ValueList.java
@@ -23,7 +23,7 @@
/**
* Value lists allow you to group values together which can then be referenced in rules.
*
- * Related guide: Default
+ * Related guide: Default
* Stripe lists
*/
@Getter
@@ -71,7 +71,7 @@ public class ValueList extends ApiResource implements HasId, MetadataStore Related guide: Managing list
+ * Related guide: Managing list
* items
*/
@Getter
diff --git a/src/main/java/com/stripe/model/reporting/ReportRun.java b/src/main/java/com/stripe/model/reporting/ReportRun.java
index 171e05aed23..685b732a084 100644
--- a/src/main/java/com/stripe/model/reporting/ReportRun.java
+++ b/src/main/java/com/stripe/model/reporting/ReportRun.java
@@ -25,12 +25,12 @@
* The Report Run object represents an instance of a report type generated with specific run
* parameters. Once the object is created, Stripe begins processing the report. When the report has
* finished running, it will give you a reference to a file where you can retrieve your results. For
- * an overview, see API Access to
+ * an overview, see API Access to
* Reports.
*
* Note that certain report types can only be run based on your live-mode data (not test-mode
* data), and will error when queried without a live-mode API key.
+ * href="https://docs.stripe.com/keys#test-live-modes">live-mode API key Note that certain report types can only be run based on your live-mode data (not test-mode
* data), and will error when queried without a live-mode API key.
+ * href="https://docs.stripe.com/keys#test-live-modes">live-mode API key.
*/
@Getter
@Setter
@@ -54,7 +54,7 @@ public class ReportType extends ApiResource implements HasId {
List One of {@code application}, or {@code stripe}.
+ */
+ @SerializedName("created_by")
+ String createdBy;
+
+ /**
+ * Three-letter ISO currency code,
+ * in lowercase. Must be a supported currency.
+ */
+ @SerializedName("currency")
+ String currency;
+
+ /** Unique identifier for the object. */
+ @Getter(onMethod_ = {@Override})
+ @SerializedName("id")
+ String id;
+
+ /**
+ * Whether there are any funds available to release on this ReserveHold. Note that if the
+ * ReserveHold is in the process of being released, this could be false, even though the funds
+ * haven't been fully released yet.
+ */
+ @SerializedName("is_releasable")
+ Boolean isReleasable;
+
+ /**
+ * 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.
+ */
+ @SerializedName("metadata")
+ Map Equal to {@code reserve.hold}.
+ */
+ @SerializedName("object")
+ String object;
+
+ /**
+ * The reason for the ReserveHold.
+ *
+ * One of {@code charge}, or {@code standalone}.
+ */
+ @SerializedName("reason")
+ String reason;
+
+ @SerializedName("release_schedule")
+ ReleaseSchedule releaseSchedule;
+
+ /** The ReservePlan which produced this ReserveHold (i.e., resplan_123). */
+ @SerializedName("reserve_plan")
+ @Getter(lombok.AccessLevel.NONE)
+ @Setter(lombok.AccessLevel.NONE)
+ ExpandableField One of {@code application}, or {@code stripe}.
+ */
+ @SerializedName("created_by")
+ String createdBy;
+
+ /**
+ * Three-letter ISO currency code,
+ * in lowercase. Must be a supported currency. An
+ * unset currency indicates that the plan applies to all currencies.
+ */
+ @SerializedName("currency")
+ String currency;
+
+ /** Time at which the ReservePlan was disabled. */
+ @SerializedName("disabled_at")
+ Long disabledAt;
+
+ @SerializedName("fixed_release")
+ FixedRelease fixedRelease;
+
+ /** Unique identifier for the object. */
+ @Getter(onMethod_ = {@Override})
+ @SerializedName("id")
+ String id;
+
+ /**
+ * 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.
+ */
+ @SerializedName("metadata")
+ Map Equal to {@code reserve.plan}.
+ */
+ @SerializedName("object")
+ String object;
+
+ /** The percent of each Charge to reserve. */
+ @SerializedName("percent")
+ Long percent;
+
+ @SerializedName("rolling_release")
+ RollingRelease rollingRelease;
+
+ /**
+ * The current status of the ReservePlan. The ReservePlan only affects charges if it is {@code
+ * active}.
+ *
+ * One of {@code active}, {@code disabled}, or {@code expired}.
+ */
+ @SerializedName("status")
+ String status;
+
+ /**
+ * The type of the ReservePlan.
+ *
+ * One of {@code fixed_release}, or {@code rolling_release}.
+ */
+ @SerializedName("type")
+ String type;
+
+ /** Retrieve a ReservePlan. */
+ public static Plan retrieve(String id) throws StripeException {
+ return retrieve(id, (Map One of {@code application}, or {@code stripe}.
+ */
+ @SerializedName("created_by")
+ String createdBy;
+
+ /**
+ * Three-letter ISO currency code,
+ * in lowercase. Must be a supported currency.
+ */
+ @SerializedName("currency")
+ String currency;
+
+ /** Unique identifier for the object. */
+ @Getter(onMethod_ = {@Override})
+ @SerializedName("id")
+ String id;
+
+ /**
+ * 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.
+ */
+ @SerializedName("metadata")
+ Map Equal to {@code reserve.release}.
+ */
+ @SerializedName("object")
+ String object;
+
+ /**
+ * The reason for the ReserveRelease, indicating why the funds were released.
+ *
+ * One of {@code bulk_hold_expiry}, {@code hold_released_early}, {@code hold_reversed}, or
+ * {@code plan_disabled}.
+ */
+ @SerializedName("reason")
+ String reason;
+
+ /** The release timestamp of the funds. */
+ @SerializedName("released_at")
+ Long releasedAt;
+
+ /** The ReserveHold this ReserveRelease is associated with. */
+ @SerializedName("reserve_hold")
+ @Getter(lombok.AccessLevel.NONE)
+ @Setter(lombok.AccessLevel.NONE)
+ ExpandableField One of {@code dispute}, or {@code refund}.
+ */
+ @SerializedName("type")
+ String type;
+
+ /** Get ID of expandable {@code dispute} object. */
+ public String getDispute() {
+ return (this.dispute != null) ? this.dispute.getId() : null;
+ }
+
+ public void setDispute(String id) {
+ this.dispute = ApiResource.setExpandableFieldId(id, this.dispute);
+ }
+
+ /** Get expanded {@code dispute}. */
+ public Dispute getDisputeObject() {
+ return (this.dispute != null) ? this.dispute.getExpanded() : null;
+ }
+
+ public void setDisputeObject(Dispute expandableObject) {
+ this.dispute = new ExpandableField Related guide: Calculate tax in your custom
+ * Related guide: Calculate tax in your custom
* payment flow
*/
@Getter
@@ -32,7 +32,7 @@
public class Calculation extends ApiResource implements HasId {
/**
* Total amount after taxes in the smallest currency unit.
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit Stripe doesn't register on your behalf with the relevant authorities when you create a Tax
* {@code Registration} object. For more information on how to register to collect tax, see our guide.
+ * href="https://docs.stripe.com/tax/registering">our guide.
*
- * Related guide: Using the Registrations
+ * Related guide: Using the Registrations
* API
*/
@Getter
diff --git a/src/main/java/com/stripe/model/tax/Settings.java b/src/main/java/com/stripe/model/tax/Settings.java
index d26e2cb6c60..49b8a683e4d 100644
--- a/src/main/java/com/stripe/model/tax/Settings.java
+++ b/src/main/java/com/stripe/model/tax/Settings.java
@@ -22,7 +22,7 @@
/**
* You can use Tax {@code Settings} to manage configurations used by Stripe Tax calculations.
*
- * Related guide: Using the Settings API
+ * Related guide: Using the Settings API
*/
@Getter
@Setter
diff --git a/src/main/java/com/stripe/model/tax/Transaction.java b/src/main/java/com/stripe/model/tax/Transaction.java
index f67b062766f..adb88509e17 100644
--- a/src/main/java/com/stripe/model/tax/Transaction.java
+++ b/src/main/java/com/stripe/model/tax/Transaction.java
@@ -24,7 +24,7 @@
/**
* A Tax Transaction records the tax collected from or refunded to your customer.
*
- * Related guide: Calculate tax in
+ * Related guide: Calculate tax in
* your custom payment flow
*/
@Getter
@@ -43,7 +43,7 @@ public class Transaction extends ApiResource implements HasId {
String currency;
/**
- * The ID of an existing Customer used
+ * The ID of an existing Customer used
* for the resource.
*/
@SerializedName("customer")
@@ -69,7 +69,7 @@ public class Transaction extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -468,7 +468,7 @@ public static class Address extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class ShippingCost extends StripeObject {
/**
- * The shipping amount in the smallest
+ * The shipping amount in the smallest
* currency unit. If {@code tax_behavior=inclusive}, then this amount includes taxes.
* Otherwise, taxes were calculated on top of this amount.
*/
@@ -477,14 +477,14 @@ public static class ShippingCost extends StripeObject {
/**
* The amount of tax calculated for shipping, in the smallest currency unit.
+ * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit Related guide: Fleet management
+ * Related guide: Fleet management
*/
@Getter
@Setter
diff --git a/src/main/java/com/stripe/model/terminal/Location.java b/src/main/java/com/stripe/model/terminal/Location.java
index 95871681b0e..d8e2ec39dd6 100644
--- a/src/main/java/com/stripe/model/terminal/Location.java
+++ b/src/main/java/com/stripe/model/terminal/Location.java
@@ -25,7 +25,7 @@
/**
* A Location represents a grouping of readers.
*
- * Related guide: Fleet management
+ * Related guide: Fleet management
*/
@Getter
@Setter
@@ -73,7 +73,7 @@ public class Location extends ApiResource implements HasId, MetadataStore Related guide: Connecting
+ * Related guide: Connecting
* to a reader
*/
@Getter
@@ -84,7 +84,11 @@ public class Reader extends ApiResource implements HasId, MetadataStore Related guides: Payment
- * Methods and More
+ * Related guides: Payment
+ * Methods and More
* Payment Scenarios.
*/
@SerializedName("payment_method")
@@ -1347,7 +1351,7 @@ public static class RefundPayment extends StripeObject {
ExpandableField Related guide: Moving
@@ -73,7 +72,7 @@ public class InboundTransfer extends ApiResource implements HasId {
String financialAccount;
/**
- * A hosted
+ * A hosted
* transaction receipt URL that is provided when money movement is considered regulated under
* Stripe's money transmission licenses.
*/
@@ -96,7 +95,7 @@ public class InboundTransfer extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -449,7 +448,7 @@ public static class UsBankAccount extends StripeObject {
/**
* The network rails used. See the docs to learn more
+ * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more
* about money movement timelines for each network type.
*
* Equal to {@code ach}.
diff --git a/src/main/java/com/stripe/model/treasury/OutboundPayment.java b/src/main/java/com/stripe/model/treasury/OutboundPayment.java
index 1200a735a4a..f70ee34eda2 100644
--- a/src/main/java/com/stripe/model/treasury/OutboundPayment.java
+++ b/src/main/java/com/stripe/model/treasury/OutboundPayment.java
@@ -31,9 +31,9 @@
* Use OutboundPayments
* to send funds to another party's external bank account or FinancialAccount. To send money to an
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount. To send money to an
* account belonging to the same user, use an OutboundTransfer.
+ * href="https://api.stripe.com#outbound_transfers">OutboundTransfer.
*
* Simulate OutboundPayment state changes with the {@code
* /v1/test_helpers/treasury/outbound_payments} endpoints. These methods can only be called on test
@@ -67,7 +67,7 @@ public class OutboundPayment extends ApiResource implements HasId {
String currency;
/**
- * ID of the customer to whom an
+ * ID of the customer to whom an
* OutboundPayment is sent.
*/
@SerializedName("customer")
@@ -101,7 +101,7 @@ public class OutboundPayment extends ApiResource implements HasId {
String financialAccount;
/**
- * A hosted
+ * A hosted
* transaction receipt URL that is provided when money movement is considered regulated under
* Stripe's money transmission licenses.
*/
@@ -121,7 +121,7 @@ public class OutboundPayment extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -470,7 +470,7 @@ public static class UsBankAccount extends StripeObject {
/**
* The network rails used. See the docs to learn more
+ * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more
* about money movement timelines for each network type.
*
* One of {@code ach}, or {@code us_domestic_wire}.
diff --git a/src/main/java/com/stripe/model/treasury/OutboundTransfer.java b/src/main/java/com/stripe/model/treasury/OutboundTransfer.java
index b5542972278..39e7b4ada5e 100644
--- a/src/main/java/com/stripe/model/treasury/OutboundTransfer.java
+++ b/src/main/java/com/stripe/model/treasury/OutboundTransfer.java
@@ -30,11 +30,10 @@
/**
* Use OutboundTransfers
- * to transfer funds from a FinancialAccount to a PaymentMethod
- * belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send
- * funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+ * to transfer funds from a FinancialAccount
+ * to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds
+ * over ACH rails or through a domestic wire transfer to a user's own external bank account.
*
* Simulate OutboundTransfer state changes with the {@code
* /v1/test_helpers/treasury/outbound_transfers} endpoints. These methods can only be called on test
@@ -87,7 +86,7 @@ public class OutboundTransfer extends ApiResource implements HasId {
String financialAccount;
/**
- * A hosted
+ * A hosted
* transaction receipt URL that is provided when money movement is considered regulated under
* Stripe's money transmission licenses.
*/
@@ -107,7 +106,7 @@ public class OutboundTransfer extends ApiResource implements HasId {
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -464,7 +463,7 @@ public static class UsBankAccount extends StripeObject {
/**
* The network rails used. See the docs to learn more
+ * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more
* about money movement timelines for each network type.
*
* One of {@code ach}, or {@code us_domestic_wire}.
diff --git a/src/main/java/com/stripe/model/treasury/ReceivedCredit.java b/src/main/java/com/stripe/model/treasury/ReceivedCredit.java
index b1dbb471bca..717ef6341e1 100644
--- a/src/main/java/com/stripe/model/treasury/ReceivedCredit.java
+++ b/src/main/java/com/stripe/model/treasury/ReceivedCredit.java
@@ -24,8 +24,8 @@
/**
* ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH
- * or wire). These money movements are not initiated from the FinancialAccount.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount (for example, via ACH or
+ * wire). These money movements are not initiated from the FinancialAccount.
*/
@Getter
@Setter
@@ -65,7 +65,7 @@ public class ReceivedCredit extends ApiResource implements HasId {
String financialAccount;
/**
- * A hosted
+ * A hosted
* transaction receipt URL that is provided when money movement is considered regulated under
* Stripe's money transmission licenses.
*/
@@ -254,7 +254,7 @@ public static class InitiatingPaymentMethodDetails extends StripeObject {
/**
* Set when {@code type} is {@code issuing_card}. This is an Issuing Card ID.
+ * href="https://api.stripe.com#issuing_cards">Issuing Card ID.
*/
@SerializedName("issuing_card")
String issuingCard;
@@ -351,14 +351,14 @@ public static class LinkedFlows extends StripeObject {
/**
* Set if the ReceivedCredit was created due to an Issuing Authorization object.
+ * href="https://api.stripe.com#issuing_authorizations">Issuing Authorization object.
*/
@SerializedName("issuing_authorization")
String issuingAuthorization;
/**
* Set if the ReceivedCredit is also viewable as an Issuing transaction object.
+ * href="https://api.stripe.com#issuing_transactions">Issuing transaction object.
*/
@SerializedName("issuing_transaction")
String issuingTransaction;
@@ -390,10 +390,9 @@ public static class LinkedFlows extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class SourceFlowDetails extends StripeObject {
/**
- * You can reverse some ReceivedCredits depending on their
- * network and source flow. Reversing a ReceivedCredit leads to the creation of a new object
- * known as a CreditReversal.
+ * You can reverse some ReceivedCredits
+ * depending on their network and source flow. Reversing a ReceivedCredit leads to the
+ * creation of a new object known as a CreditReversal.
*/
@SerializedName("credit_reversal")
CreditReversal creditReversal;
@@ -402,9 +401,9 @@ public static class SourceFlowDetails extends StripeObject {
* Use OutboundPayments
* to send funds to another party's external bank account or FinancialAccount. To send money
- * to an account belonging to the same user, use an OutboundTransfer.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount. To send money to an
+ * account belonging to the same user, use an OutboundTransfer.
*
* Simulate OutboundPayment state changes with the {@code
* /v1/test_helpers/treasury/outbound_payments} endpoints. These methods can only be called on
@@ -421,10 +420,10 @@ public static class SourceFlowDetails extends StripeObject {
* Use OutboundTransfers
* to transfer funds from a FinancialAccount to a
- * PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can
- * send funds over ACH rails or through a domestic wire transfer to a user's own external bank
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount to a PaymentMethod
+ * belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send
+ * funds over ACH rails or through a domestic wire transfer to a user's own external bank
* account.
*
* Simulate OutboundTransfer state changes with the {@code
@@ -446,7 +445,7 @@ public static class SourceFlowDetails extends StripeObject {
* varying schedules,
* depending on your country and industry.
*
- * Related guide: Receiving payouts
+ * Related guide: Receiving payouts
*/
@SerializedName("payout")
Payout payout;
diff --git a/src/main/java/com/stripe/model/treasury/ReceivedDebit.java b/src/main/java/com/stripe/model/treasury/ReceivedDebit.java
index 3ffa7e32ed9..f8b78696221 100644
--- a/src/main/java/com/stripe/model/treasury/ReceivedDebit.java
+++ b/src/main/java/com/stripe/model/treasury/ReceivedDebit.java
@@ -23,8 +23,8 @@
/**
* ReceivedDebits represent funds pulled from a FinancialAccount. These are not
- * initiated from the FinancialAccount.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount. These are not initiated
+ * from the FinancialAccount.
*/
@Getter
@Setter
@@ -64,7 +64,7 @@ public class ReceivedDebit extends ApiResource implements HasId {
String financialAccount;
/**
- * A hosted
+ * A hosted
* transaction receipt URL that is provided when money movement is considered regulated under
* Stripe's money transmission licenses.
*/
@@ -253,7 +253,7 @@ public static class InitiatingPaymentMethodDetails extends StripeObject {
/**
* Set when {@code type} is {@code issuing_card}. This is an Issuing Card ID.
+ * href="https://api.stripe.com#issuing_cards">Issuing Card ID.
*/
@SerializedName("issuing_card")
String issuingCard;
@@ -354,21 +354,21 @@ public static class LinkedFlows extends StripeObject {
/**
* Set if the ReceivedDebit was created due to an Issuing Authorization object.
+ * href="https://api.stripe.com#issuing_authorizations">Issuing Authorization object.
*/
@SerializedName("issuing_authorization")
String issuingAuthorization;
/**
* Set if the ReceivedDebit is also viewable as an Issuing Dispute object.
+ * href="https://api.stripe.com#issuing_disputes">Issuing Dispute object.
*/
@SerializedName("issuing_transaction")
String issuingTransaction;
/**
* Set if the ReceivedDebit was created due to a Payout object.
+ * href="https://api.stripe.com#payouts">Payout object.
*/
@SerializedName("payout")
String payout;
diff --git a/src/main/java/com/stripe/model/treasury/Transaction.java b/src/main/java/com/stripe/model/treasury/Transaction.java
index 77ee23e8a5b..155204693f2 100644
--- a/src/main/java/com/stripe/model/treasury/Transaction.java
+++ b/src/main/java/com/stripe/model/treasury/Transaction.java
@@ -21,7 +21,7 @@
/**
* Transactions represent changes to a FinancialAccount's balance.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount's balance.
*/
@Getter
@Setter
@@ -211,16 +211,15 @@ public static class BalanceImpact extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class FlowDetails extends StripeObject {
/**
- * You can reverse some ReceivedCredits depending on their
- * network and source flow. Reversing a ReceivedCredit leads to the creation of a new object
- * known as a CreditReversal.
+ * You can reverse some ReceivedCredits
+ * depending on their network and source flow. Reversing a ReceivedCredit leads to the creation
+ * of a new object known as a CreditReversal.
*/
@SerializedName("credit_reversal")
CreditReversal creditReversal;
/**
- * You can reverse some ReceivedDebits
+ * You can reverse some ReceivedDebits
* depending on their network and source flow. Reversing a ReceivedDebit leads to the creation
* of a new object known as a DebitReversal.
*/
@@ -230,9 +229,8 @@ public static class FlowDetails extends StripeObject {
/**
* Use InboundTransfers
- * to add funds to your FinancialAccount via a
- * PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+ * to add funds to your FinancialAccount
+ * via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
*
* Related guide: Moving
@@ -242,12 +240,12 @@ public static class FlowDetails extends StripeObject {
InboundTransfer inboundTransfer;
/**
- * When an issued card is used to make a purchase,
+ * When an issued card is used to make a purchase,
* an Issuing {@code Authorization} object is created. Authorizations must be
+ * href="https://docs.stripe.com/issuing/purchases/authorizations">Authorizations must be
* approved for the purchase to be completed successfully.
*
- * Related guide: Issued
+ * Related guide: Issued
* card authorizations
*/
@SerializedName("issuing_authorization")
@@ -257,9 +255,9 @@ public static class FlowDetails extends StripeObject {
* Use OutboundPayments
* to send funds to another party's external bank account or FinancialAccount. To send money to
- * an account belonging to the same user, use an OutboundTransfer.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount Simulate OutboundPayment state changes with the {@code
* /v1/test_helpers/treasury/outbound_payments} endpoints. These methods can only be called on
@@ -276,10 +274,10 @@ public static class FlowDetails extends StripeObject {
* Use OutboundTransfers
* to transfer funds from a FinancialAccount to a PaymentMethod
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount to a PaymentMethod
* belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can
- * send funds over ACH rails or through a domestic wire transfer to a user's own external bank
+ * href="https://api.stripe.com#outbound_payments">OutboundPayments instead. You can send
+ * funds over ACH rails or through a domestic wire transfer to a user's own external bank
* account.
*
* Simulate OutboundTransfer state changes with the {@code
@@ -295,15 +293,15 @@ public static class FlowDetails extends StripeObject {
/**
* ReceivedCredits represent funds sent to a FinancialAccount (for example, via
- * ACH or wire). These money movements are not initiated from the FinancialAccount.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount (for example, via ACH
+ * or wire). These money movements are not initiated from the FinancialAccount.
*/
@SerializedName("received_credit")
ReceivedCredit receivedCredit;
/**
* ReceivedDebits represent funds pulled from a FinancialAccount. These are not
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount. These are not
* initiated from the FinancialAccount.
*/
@SerializedName("received_debit")
diff --git a/src/main/java/com/stripe/model/treasury/TransactionEntry.java b/src/main/java/com/stripe/model/treasury/TransactionEntry.java
index f490062112b..aa06ab900fc 100644
--- a/src/main/java/com/stripe/model/treasury/TransactionEntry.java
+++ b/src/main/java/com/stripe/model/treasury/TransactionEntry.java
@@ -22,7 +22,7 @@
/**
* TransactionEntries represent individual units of money movements within a single Transaction.
+ * href="https://api.stripe.com#transactions">Transaction.
*/
@Getter
@Setter
@@ -232,16 +232,15 @@ public static class BalanceImpact extends StripeObject {
@EqualsAndHashCode(callSuper = false)
public static class FlowDetails extends StripeObject {
/**
- * You can reverse some ReceivedCredits depending on their
- * network and source flow. Reversing a ReceivedCredit leads to the creation of a new object
- * known as a CreditReversal.
+ * You can reverse some ReceivedCredits
+ * depending on their network and source flow. Reversing a ReceivedCredit leads to the creation
+ * of a new object known as a CreditReversal.
*/
@SerializedName("credit_reversal")
CreditReversal creditReversal;
/**
- * You can reverse some ReceivedDebits
+ * You can reverse some ReceivedDebits
* depending on their network and source flow. Reversing a ReceivedDebit leads to the creation
* of a new object known as a DebitReversal.
*/
@@ -251,9 +250,8 @@ public static class FlowDetails extends StripeObject {
/**
* Use InboundTransfers
- * to add funds to your FinancialAccount via a
- * PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+ * to add funds to your FinancialAccount
+ * via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
*
* Related guide: Moving
@@ -263,12 +261,12 @@ public static class FlowDetails extends StripeObject {
InboundTransfer inboundTransfer;
/**
- * When an issued card is used to make a purchase,
+ * When an issued card is used to make a purchase,
* an Issuing {@code Authorization} object is created. Authorizations must be
+ * href="https://docs.stripe.com/issuing/purchases/authorizations">Authorizations must be
* approved for the purchase to be completed successfully.
*
- * Related guide: Issued
+ * Related guide: Issued
* card authorizations
*/
@SerializedName("issuing_authorization")
@@ -278,9 +276,9 @@ public static class FlowDetails extends StripeObject {
* Use OutboundPayments
* to send funds to another party's external bank account or FinancialAccount. To send money to
- * an account belonging to the same user, use an OutboundTransfer.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount Simulate OutboundPayment state changes with the {@code
* /v1/test_helpers/treasury/outbound_payments} endpoints. These methods can only be called on
@@ -297,10 +295,10 @@ public static class FlowDetails extends StripeObject {
* Use OutboundTransfers
* to transfer funds from a FinancialAccount to a PaymentMethod
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount to a PaymentMethod
* belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can
- * send funds over ACH rails or through a domestic wire transfer to a user's own external bank
+ * href="https://api.stripe.com#outbound_payments">OutboundPayments instead. You can send
+ * funds over ACH rails or through a domestic wire transfer to a user's own external bank
* account.
*
* Simulate OutboundTransfer state changes with the {@code
@@ -316,15 +314,15 @@ public static class FlowDetails extends StripeObject {
/**
* ReceivedCredits represent funds sent to a FinancialAccount (for example, via
- * ACH or wire). These money movements are not initiated from the FinancialAccount.
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount (for example, via ACH
+ * or wire). These money movements are not initiated from the FinancialAccount.
*/
@SerializedName("received_credit")
ReceivedCredit receivedCredit;
/**
* ReceivedDebits represent funds pulled from a FinancialAccount. These are not
+ * href="https://api.stripe.com#financial_accounts">FinancialAccount. These are not
* initiated from the FinancialAccount.
*/
@SerializedName("received_debit")
diff --git a/src/main/java/com/stripe/model/v2/EventDataClassLookup.java b/src/main/java/com/stripe/model/v2/EventDataClassLookup.java
index adb0680cdec..96e332b98f9 100644
--- a/src/main/java/com/stripe/model/v2/EventDataClassLookup.java
+++ b/src/main/java/com/stripe/model/v2/EventDataClassLookup.java
@@ -228,6 +228,9 @@ public final class EventDataClassLookup {
eventClassLookup.put(
"v2.money_management.outbound_transfer.updated",
com.stripe.events.V2MoneyManagementOutboundTransferUpdatedEvent.class);
+ eventClassLookup.put(
+ "v2.money_management.payout_method.created",
+ com.stripe.events.V2MoneyManagementPayoutMethodCreatedEvent.class);
eventClassLookup.put(
"v2.money_management.payout_method.updated",
com.stripe.events.V2MoneyManagementPayoutMethodUpdatedEvent.class);
diff --git a/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java b/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java
index 370db1c3f8d..65801bfa2e2 100644
--- a/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java
+++ b/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java
@@ -161,6 +161,9 @@ public final class EventNotificationClassLookup {
eventClassLookup.put(
"v2.money_management.outbound_transfer.updated",
com.stripe.events.V2MoneyManagementOutboundTransferUpdatedEventNotification.class);
+ eventClassLookup.put(
+ "v2.money_management.payout_method.created",
+ com.stripe.events.V2MoneyManagementPayoutMethodCreatedEventNotification.class);
eventClassLookup.put(
"v2.money_management.payout_method.updated",
com.stripe.events.V2MoneyManagementPayoutMethodUpdatedEventNotification.class);
diff --git a/src/main/java/com/stripe/model/v2/FinancialAddressGeneratedMicrodeposits.java b/src/main/java/com/stripe/model/v2/FinancialAddressGeneratedMicrodeposits.java
index b6e3a90d259..7bd4e6f46f4 100644
--- a/src/main/java/com/stripe/model/v2/FinancialAddressGeneratedMicrodeposits.java
+++ b/src/main/java/com/stripe/model/v2/FinancialAddressGeneratedMicrodeposits.java
@@ -3,7 +3,6 @@
import com.google.gson.annotations.SerializedName;
import com.stripe.model.StripeObject;
-import com.stripe.v2.Amount;
import java.util.List;
import lombok.EqualsAndHashCode;
import lombok.Getter;
@@ -15,7 +14,7 @@
public class FinancialAddressGeneratedMicrodeposits extends StripeObject {
/** The amounts of the microdeposits that were generated. */
@SerializedName("amounts")
- List One of {@code exempt}, {@code none}, or {@code reverse}.
*/
@@ -218,17 +221,16 @@ public static class AutomaticIndirectTax extends StripeObject {
String ipAddress;
/**
- * The identified
- * tax location of the customer. Will only be rendered if the {@code automatic_indirect_tax}
- * feature is requested and {@code active}.
+ * The customer account's identified tax location, derived from {@code location_source}.
+ * Only rendered if the {@code automatic_indirect_tax} feature is requested and {@code
+ * active}.
*/
@SerializedName("location")
Location location;
/**
- * The data source used to identify the customer's tax location. Will only be used for
- * automatic tax calculation on the customer's Invoices and Subscriptions.
+ * Data source used to identify the customer account's tax location. Defaults to {@code
+ * identity_address}. Used for automatic indirect tax calculation.
*
* One of {@code identity_address}, {@code ip_address}, {@code payment_method}, or {@code
* shipping_address}.
@@ -237,10 +239,9 @@ public static class AutomaticIndirectTax extends StripeObject {
String locationSource;
/**
- * The identified
- * tax location of the customer. Will only be rendered if the {@code automatic_indirect_tax}
- * feature is requested and {@code active}.
+ * The customer account's identified tax location, derived from {@code location_source}.
+ * Only rendered if the {@code automatic_indirect_tax} feature is requested and {@code
+ * active}.
*/
@Getter
@Setter
@@ -256,26 +257,23 @@ public static class Location extends StripeObject {
}
}
- /**
- * Billing settings - default settings used for this customer in Billing flows such as
- * Invoices and Subscriptions.
- */
+ /** Default Billing settings for the customer account, used in Invoices and Subscriptions. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Billing extends StripeObject {
/**
- * ID of a payment method that’s attached to the customer, to be used as the customer’s
- * default payment method for invoices and subscriptions.
+ * ID of a PaymentMethod attached to the customer account to use as the default for invoices
+ * and subscriptions.
*/
@SerializedName("default_payment_method")
String defaultPaymentMethod;
- /** Default settings used on invoices for this customer. */
+ /** Default invoice settings for the customer account. */
@SerializedName("invoice")
Invoice invoice;
- /** Default settings used on invoices for this customer. */
+ /** Default invoice settings for the customer account. */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
@@ -287,22 +285,22 @@ public static class Invoice extends StripeObject {
@SerializedName("custom_fields")
List One of {@code exclude_tax}, or {@code include_inclusive_tax}.
*/
@SerializedName("amount_tax_display")
String amountTaxDisplay;
@@ -369,10 +368,6 @@ public static class Capabilities extends StripeObject {
@Setter
@EqualsAndHashCode(callSuper = false)
public static class AutomaticIndirectTax extends StripeObject {
- /** Whether the Capability has been requested. */
- @SerializedName("requested")
- Boolean requested;
-
/**
* The status of the Capability.
*
@@ -382,8 +377,8 @@ public static class AutomaticIndirectTax extends StripeObject {
String status;
/**
- * Additional details regarding the status of the Capability. {@code status_details} will
- * be empty if the Capability's status is {@code active}.
+ * Additional details about the capability's status. This value is empty when {@code
+ * status} is {@code active}.
*/
@SerializedName("status_details")
List {
String currency;
/**
- * The customer which this quote belongs to. A customer is required before finalizing the quote.
- * Once specified, it cannot be changed.
+ * The customer who received this quote. A customer is required to finalize the quote. Once
+ * specified, you can't change it.
*/
@SerializedName("customer")
@Getter(lombok.AccessLevel.NONE)
@@ -119,8 +119,8 @@ public class Quote extends ApiResource implements HasId, MetadataStore
{
ExpandableField
{
/**
* Details of the quote that was cloned. See the cloning documentation for more details.
+ * href="https://docs.stripe.com/quotes/clone">cloning documentation for more details.
*/
@SerializedName("from_quote")
FromQuote fromQuote;
@@ -193,7 +193,7 @@ public class Quote extends ApiResource implements HasId, MetadataStore
{
Boolean livemode;
/**
- * Set of key-value pairs that you can attach
+ * 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.
*/
@@ -203,7 +203,7 @@ public class Quote extends ApiResource implements HasId, MetadataStore
{
/**
* A unique number that identifies this particular quote. This number is assigned once the quote
- * is finalized.
+ * is finalized.
*/
@SerializedName("number")
String number;
@@ -1460,13 +1460,13 @@ public static class Discount extends StripeObject {
/**
* A discount represents the actual application of a coupon or promotion code. It contains
+ * href="https://api.stripe.com#coupons">coupon or promotion code. It contains
* information about when the discount began, when it will end, and what it is applied
* to.
*
*