diff --git a/API_VERSION b/API_VERSION index 33ba6981527..e48768f4a01 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -ffe4efab9b5dec59fea6b69a94f4b024fa7cf992 \ No newline at end of file +3602014a6583f6c0fbfdde3c575839ac7d0b4e9c \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 3c718cc2c37..4e4ca8e5b78 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2132 \ No newline at end of file +v2141 \ No newline at end of file diff --git a/src/main/java/com/stripe/ApiVersion.java b/src/main/java/com/stripe/ApiVersion.java index b71201060b4..6296456d824 100644 --- a/src/main/java/com/stripe/ApiVersion.java +++ b/src/main/java/com/stripe/ApiVersion.java @@ -2,5 +2,5 @@ package com.stripe; final class ApiVersion { - public static final String CURRENT = "2025-11-17.preview"; + public static final String CURRENT = "2025-12-15.preview"; } diff --git a/src/main/java/com/stripe/StripeClient.java b/src/main/java/com/stripe/StripeClient.java index e63f9192dc8..db693313ca1 100644 --- a/src/main/java/com/stripe/StripeClient.java +++ b/src/main/java/com/stripe/StripeClient.java @@ -875,6 +875,18 @@ public com.stripe.service.SetupIntentService setupIntents() { return new com.stripe.service.SetupIntentService(this.getResponseGetter()); } + /** + * @deprecated StripeClient.sharedPayment() is deprecated, use StripeClient.v1().sharedPayment() + * instead. All functionality under it has been copied over to + * StripeClient.v1().sharedPayment(). See migration + * guide for more on this and tips on migrating to the new v1 namespace. + */ + @Deprecated + public com.stripe.service.SharedPaymentService sharedPayment() { + return new com.stripe.service.SharedPaymentService(this.getResponseGetter()); + } + /** * @deprecated StripeClient.shippingRates() is deprecated, use StripeClient.v1().shippingRates() * instead. All functionality under it has been copied over to diff --git a/src/main/java/com/stripe/events/V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.java b/src/main/java/com/stripe/events/V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.java index 130cb035924..63914bc8350 100644 --- a/src/main/java/com/stripe/events/V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.java +++ b/src/main/java/com/stripe/events/V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.java @@ -22,9 +22,10 @@ public static final class EventData { /** * Open Enum. The capability which had its status updated. * - *

One of {@code bank_accounts.local}, {@code bank_accounts.wire}, {@code cards}, {@code - * crypto_wallets_v2}, {@code stripe_balance.payouts}, {@code stripe_balance.stripe_transfers}, - * or {@code stripe.transfers}. + *

One of {@code bank_accounts.instant}, {@code bank_accounts.local}, {@code + * bank_accounts.wire}, {@code cards}, {@code crypto_wallets_v2}, {@code + * stripe_balance.payouts}, {@code stripe_balance.stripe_transfers}, or {@code + * stripe.transfers}. */ @SerializedName("updated_capability") String updatedCapability; diff --git a/src/main/java/com/stripe/events/V2CoreHealthApiErrorFiringEvent.java b/src/main/java/com/stripe/events/V2CoreHealthApiErrorFiringEvent.java index 2066064ece8..41c0f6c1644 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthApiErrorFiringEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthApiErrorFiringEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -55,6 +56,21 @@ public static final class Impact { /** The percentage of impacted requests. */ @SerializedName("impacted_requests_percentage") String impactedRequestsPercentage; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthApiErrorResolvedEvent.java b/src/main/java/com/stripe/events/V2CoreHealthApiErrorResolvedEvent.java index 556c96dc9fc..30f6e50b6a5 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthApiErrorResolvedEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthApiErrorResolvedEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -55,6 +56,22 @@ public static final class Impact { /** The percentage of impacted requests. */ @SerializedName("impacted_requests_percentage") String impactedRequestsPercentage; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List + topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthApiLatencyFiringEvent.java b/src/main/java/com/stripe/events/V2CoreHealthApiLatencyFiringEvent.java index 0e7d4bf8785..5c9315292c0 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthApiLatencyFiringEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthApiLatencyFiringEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -52,6 +53,22 @@ public static final class Impact { /** The percentage of impacted requests. */ @SerializedName("impacted_requests_percentage") String impactedRequestsPercentage; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List + topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthApiLatencyResolvedEvent.java b/src/main/java/com/stripe/events/V2CoreHealthApiLatencyResolvedEvent.java index 45285bff8e0..c5fdc1be9b4 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthApiLatencyResolvedEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthApiLatencyResolvedEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -52,6 +53,22 @@ public static final class Impact { /** The percentage of impacted requests. */ @SerializedName("impacted_requests_percentage") String impactedRequestsPercentage; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List + topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorFiringEvent.java b/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorFiringEvent.java index 9dfb2996ae7..47faae41703 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorFiringEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorFiringEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -63,6 +64,22 @@ public static final class Impact { */ @SerializedName("payment_method_type") String paymentMethodType; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List + topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorResolvedEvent.java b/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorResolvedEvent.java index cc20d8348da..e3b993529d5 100644 --- a/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorResolvedEvent.java +++ b/src/main/java/com/stripe/events/V2CoreHealthPaymentMethodErrorResolvedEvent.java @@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.v2.core.Event; import java.time.Instant; +import java.util.List; import lombok.Getter; import lombok.Setter; @@ -63,6 +64,22 @@ public static final class Impact { */ @SerializedName("payment_method_type") String paymentMethodType; + /** The top impacted connected accounts (only for platforms). */ + @SerializedName("top_impacted_accounts") + List + topImpactedAccounts; + + public static final class TopImpactedAccount { + /** The account ID of the impacted connected account. */ + @SerializedName("account") + String account; + /** The number of impacted requests. */ + @SerializedName("impacted_requests") + Long impactedRequests; + /** The percentage of impacted requests. */ + @SerializedName("impacted_requests_percentage") + String impactedRequestsPercentage; + } } } } diff --git a/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEvent.java b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEvent.java new file mode 100644 index 00000000000..d65594f23bf --- /dev/null +++ b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEvent.java @@ -0,0 +1,41 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.v2.core.Event; +import java.time.Instant; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2CoreHealthSepaDebitDelayedFiringEvent extends Event { + /** Data for the v2.core.health.sepa_debit_delayed.firing event. */ + @SerializedName("data") + V2CoreHealthSepaDebitDelayedFiringEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The grouping key for the alert. */ + @SerializedName("grouping_key") + String groupingKey; + /** The user impact. */ + @SerializedName("impact") + Impact impact; + /** The time when impact on the user experience was first detected. */ + @SerializedName("started_at") + Instant startedAt; + /** A short description of the alert. */ + @SerializedName("summary") + String summary; + + public static final class Impact { + /** The number of impacted payments. */ + @SerializedName("impacted_payments") + Long impactedPayments; + /** The percentage of impacted payments. */ + @SerializedName("impacted_payments_percentage") + String impactedPaymentsPercentage; + } + } +} diff --git a/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEventNotification.java b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEventNotification.java new file mode 100644 index 00000000000..d371ae255b6 --- /dev/null +++ b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedFiringEventNotification.java @@ -0,0 +1,13 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.EventNotification; + +public final class V2CoreHealthSepaDebitDelayedFiringEventNotification extends EventNotification { + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2CoreHealthSepaDebitDelayedFiringEvent fetchEvent() throws StripeException { + return (V2CoreHealthSepaDebitDelayedFiringEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEvent.java b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEvent.java new file mode 100644 index 00000000000..3c4011c51f3 --- /dev/null +++ b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEvent.java @@ -0,0 +1,44 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.v2.core.Event; +import java.time.Instant; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2CoreHealthSepaDebitDelayedResolvedEvent extends Event { + /** Data for the v2.core.health.sepa_debit_delayed.resolved event. */ + @SerializedName("data") + V2CoreHealthSepaDebitDelayedResolvedEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The grouping key for the alert. */ + @SerializedName("grouping_key") + String groupingKey; + /** The user impact. */ + @SerializedName("impact") + Impact impact; + /** The time when the user experience has returned to expected levels. */ + @SerializedName("resolved_at") + Instant resolvedAt; + /** The time when impact on the user experience was first detected. */ + @SerializedName("started_at") + Instant startedAt; + /** A short description of the alert. */ + @SerializedName("summary") + String summary; + + public static final class Impact { + /** The number of impacted payments. */ + @SerializedName("impacted_payments") + Long impactedPayments; + /** The percentage of impacted payments. */ + @SerializedName("impacted_payments_percentage") + String impactedPaymentsPercentage; + } + } +} diff --git a/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEventNotification.java b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEventNotification.java new file mode 100644 index 00000000000..a4e728a9d9d --- /dev/null +++ b/src/main/java/com/stripe/events/V2CoreHealthSepaDebitDelayedResolvedEventNotification.java @@ -0,0 +1,13 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.EventNotification; + +public final class V2CoreHealthSepaDebitDelayedResolvedEventNotification extends EventNotification { + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2CoreHealthSepaDebitDelayedResolvedEvent fetchEvent() throws StripeException { + return (V2CoreHealthSepaDebitDelayedResolvedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEvent.java b/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEvent.java new file mode 100644 index 00000000000..e525aa3a66a --- /dev/null +++ b/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.moneymanagement.PayoutMethod; +import lombok.Getter; + +@Getter +public final class V2MoneyManagementPayoutMethodCreatedEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public PayoutMethod fetchRelatedObject() throws StripeException { + return (PayoutMethod) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEventNotification.java b/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEventNotification.java new file mode 100644 index 00000000000..f87fcec8e09 --- /dev/null +++ b/src/main/java/com/stripe/events/V2MoneyManagementPayoutMethodCreatedEventNotification.java @@ -0,0 +1,27 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.moneymanagement.PayoutMethod; +import lombok.Getter; + +@Getter +public final class V2MoneyManagementPayoutMethodCreatedEventNotification extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public PayoutMethod fetchRelatedObject() throws StripeException { + return (PayoutMethod) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2MoneyManagementPayoutMethodCreatedEvent fetchEvent() throws StripeException { + return (V2MoneyManagementPayoutMethodCreatedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEvent.java new file mode 100644 index 00000000000..1dda4e97f92 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentCanceledEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEventNotification.java new file mode 100644 index 00000000000..2c063e32e81 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCanceledEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentCanceledEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentCanceledEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentCanceledEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEvent.java new file mode 100644 index 00000000000..3919af782fb --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentCreatedEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEventNotification.java new file mode 100644 index 00000000000..2dc89eb9cda --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentCreatedEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentCreatedEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentCreatedEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentCreatedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEvent.java new file mode 100644 index 00000000000..1993dfb3cf3 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEvent.java @@ -0,0 +1,45 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentErroredEvent extends Event { + /** Data for the v2.payments.settlement_allocation_intent.errored event. */ + @SerializedName("data") + V2PaymentsSettlementAllocationIntentErroredEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** Stripe doc link to debug the issue. */ + @SerializedName("doc_url") + String docUrl; + /** User Message detailing the reason code and possible resolution . */ + @SerializedName("message") + String message; + /** + * Open Enum. The {@code errored} status reason. + * + *

Equal to {@code amount_mismatch}. + */ + @SerializedName("reason_code") + String reasonCode; + } + + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEventNotification.java new file mode 100644 index 00000000000..7febb2f3153 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentErroredEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentErroredEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentErroredEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentErroredEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent.java new file mode 100644 index 00000000000..5684c2b54cc --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEventNotification.java new file mode 100644 index 00000000000..b8f88d2b0f6 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentFundsNotReceivedEventNotification.java @@ -0,0 +1,29 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentFundsNotReceivedEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent fetchEvent() + throws StripeException { + return (V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEvent.java new file mode 100644 index 00000000000..3c3ff3537aa --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentMatchedEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEventNotification.java new file mode 100644 index 00000000000..3aa52cc0b15 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentMatchedEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentMatchedEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentMatchedEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentMatchedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEvent.java new file mode 100644 index 00000000000..a51791418f0 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.v2.core.Event; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentNotFoundEvent extends Event { + /** Data for the v2.payments.settlement_allocation_intent.not_found event. */ + @SerializedName("data") + V2PaymentsSettlementAllocationIntentNotFoundEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The ID of the ReceivedCredit. */ + @SerializedName("received_credit_id") + String receivedCreditId; + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEventNotification.java new file mode 100644 index 00000000000..1151fdfec69 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentNotFoundEventNotification.java @@ -0,0 +1,14 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.EventNotification; + +public final class V2PaymentsSettlementAllocationIntentNotFoundEventNotification + extends EventNotification { + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentNotFoundEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentNotFoundEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEvent.java new file mode 100644 index 00000000000..64b0b641aba --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSettledEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEventNotification.java new file mode 100644 index 00000000000..62622206496 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSettledEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSettledEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentSettledEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentSettledEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEvent.java new file mode 100644 index 00000000000..790fe8dce08 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEvent.java @@ -0,0 +1,35 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitCanceledEvent extends Event { + /** Data for the v2.payments.settlement_allocation_intent_split.canceled event. */ + @SerializedName("data") + V2PaymentsSettlementAllocationIntentSplitCanceledEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The ID of the SettlementAllocationIntent this split belongs to. */ + @SerializedName("settlement_allocation_intent_id") + String settlementAllocationIntentId; + } + + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification.java new file mode 100644 index 00000000000..176cb8236e2 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification.java @@ -0,0 +1,29 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentSplitCanceledEvent fetchEvent() + throws StripeException { + return (V2PaymentsSettlementAllocationIntentSplitCanceledEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEvent.java new file mode 100644 index 00000000000..0cd91e04c2d --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEvent.java @@ -0,0 +1,35 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitCreatedEvent extends Event { + /** Data for the v2.payments.settlement_allocation_intent_split.created event. */ + @SerializedName("data") + V2PaymentsSettlementAllocationIntentSplitCreatedEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The ID of the SettlementAllocationIntent this split belongs to. */ + @SerializedName("settlement_allocation_intent_id") + String settlementAllocationIntentId; + } + + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEventNotification.java new file mode 100644 index 00000000000..26ce3861a89 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitCreatedEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitCreatedEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentSplitCreatedEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentSplitCreatedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEvent.java new file mode 100644 index 00000000000..2de9b7551c4 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEvent.java @@ -0,0 +1,35 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; +import lombok.Setter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitSettledEvent extends Event { + /** Data for the v2.payments.settlement_allocation_intent_split.settled event. */ + @SerializedName("data") + V2PaymentsSettlementAllocationIntentSplitSettledEvent.EventData data; + + @Getter + @Setter + public static final class EventData { + /** The ID of the SettlementAllocationIntent this split belongs to. */ + @SerializedName("settlement_allocation_intent_id") + String settlementAllocationIntentId; + } + + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEventNotification.java new file mode 100644 index 00000000000..e9deaef3c05 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSplitSettledEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSplitSettledEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntentSplit fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntentSplit) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentSplitSettledEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentSplitSettledEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEvent.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEvent.java new file mode 100644 index 00000000000..f3b5f6138db --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEvent.java @@ -0,0 +1,22 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSubmittedEvent extends Event { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } +} diff --git a/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEventNotification.java b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEventNotification.java new file mode 100644 index 00000000000..2db09518e22 --- /dev/null +++ b/src/main/java/com/stripe/events/V2PaymentsSettlementAllocationIntentSubmittedEventNotification.java @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec +package com.stripe.events; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.core.Event.RelatedObject; +import com.stripe.model.v2.core.EventNotification; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import lombok.Getter; + +@Getter +public final class V2PaymentsSettlementAllocationIntentSubmittedEventNotification + extends EventNotification { + @SerializedName("related_object") + + /** Object containing the reference to API resource relevant to the event. */ + RelatedObject relatedObject; + + /** Retrieves the related object from the API. Make an API request on every call. */ + public SettlementAllocationIntent fetchRelatedObject() throws StripeException { + return (SettlementAllocationIntent) super.fetchRelatedObject(this.relatedObject); + } + /** Retrieve the corresponding full event from the Stripe API. */ + @Override + public V2PaymentsSettlementAllocationIntentSubmittedEvent fetchEvent() throws StripeException { + return (V2PaymentsSettlementAllocationIntentSubmittedEvent) super.fetchEvent(); + } +} diff --git a/src/main/java/com/stripe/exception/ControlledByAlternateResourceException.java b/src/main/java/com/stripe/exception/ControlledByAlternateResourceException.java new file mode 100644 index 00000000000..a21b9f0eb35 --- /dev/null +++ b/src/main/java/com/stripe/exception/ControlledByAlternateResourceException.java @@ -0,0 +1,37 @@ +// File generated from our OpenAPI spec +package com.stripe.exception; + +import com.google.gson.JsonObject; +import com.stripe.model.StripeError; +import com.stripe.model.StripeObject; +import com.stripe.net.StripeResponseGetter; + +/** + * Returned when the PayoutMethod object is controlled by an alternate resource so cannot be + * archived. + */ +public final class ControlledByAlternateResourceException extends ApiException { + private static final long serialVersionUID = 2L; + + private ControlledByAlternateResourceException( + String message, String requestId, String code, Integer statusCode, Throwable e) { + super(message, requestId, code, statusCode, e); + } + + static ControlledByAlternateResourceException parse( + JsonObject body, int statusCode, String requestId, StripeResponseGetter responseGetter) { + ControlledByAlternateResourceException.ControlledByAlternateResourceError error = + (ControlledByAlternateResourceException.ControlledByAlternateResourceError) + StripeObject.deserializeStripeObject( + body, + ControlledByAlternateResourceException.ControlledByAlternateResourceError.class, + responseGetter); + ControlledByAlternateResourceException exception = + new ControlledByAlternateResourceException( + error.getMessage(), requestId, error.getCode(), statusCode, null); + exception.setStripeError(error); + return exception; + } + + public static class ControlledByAlternateResourceError extends StripeError {} +} diff --git a/src/main/java/com/stripe/exception/StripeException.java b/src/main/java/com/stripe/exception/StripeException.java index ebd21d25afb..b2cb5f2ba44 100644 --- a/src/main/java/com/stripe/exception/StripeException.java +++ b/src/main/java/com/stripe/exception/StripeException.java @@ -119,6 +119,9 @@ public static StripeException parseV2Exception( case "blocked_by_stripe": return com.stripe.exception.BlockedByStripeException.parse( body, statusCode, requestId, responseGetter); + case "controlled_by_alternate_resource": + return com.stripe.exception.ControlledByAlternateResourceException.parse( + body, statusCode, requestId, responseGetter); case "controlled_by_dashboard": return com.stripe.exception.ControlledByDashboardException.parse( body, statusCode, requestId, responseGetter); diff --git a/src/main/java/com/stripe/model/Account.java b/src/main/java/com/stripe/model/Account.java index 9d26571ce02..fa6e270f309 100644 --- a/src/main/java/com/stripe/model/Account.java +++ b/src/main/java/com/stripe/model/Account.java @@ -143,7 +143,7 @@ public class Account extends ApiResource implements MetadataStore, Paym Person individual; /** - * 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. */ @@ -1547,7 +1547,7 @@ public static class Company extends StripeObject { /** * Whether the company's directors have been provided. This Boolean will be {@code true} if * you've manually indicated that all directors are provided via the + * href="https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided">the * {@code directors_provided} parameter. */ @SerializedName("directors_provided") @@ -1563,7 +1563,7 @@ public static class Company extends StripeObject { /** * Whether the company's executives have been provided. This Boolean will be {@code true} if * you've manually indicated that all executives are provided via the + * href="https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided">the * {@code executives_provided} parameter, or if Stripe determined that sufficient executives * were provided. */ @@ -1610,7 +1610,7 @@ public static class Company extends StripeObject { /** * Whether the company's owners have been provided. This Boolean will be {@code true} if you've * manually indicated that all owners are provided via the + * href="https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided">the * {@code owners_provided} parameter, or if Stripe determined that sufficient owners were * provided. Stripe determines ownership requirements using both the number of owners provided * and their total percent ownership (calculated by adding the {@code percent_ownership} of each @@ -1659,7 +1659,7 @@ public static class Company extends StripeObject { * for accounts where controller.requirement_collection * is {@code stripe}. See Business + * href="https://docs.stripe.com/connect/identity-verification#business-structure">Business * structure for more details. * *

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 alternatives; @@ -2135,7 +2138,7 @@ public static class FutureRequirements extends StripeObject { Long currentDeadline; /** - * Fields that need to be collected to keep the account enabled. If not collected by {@code + * Fields that need to be resolved to keep the account enabled. If not resolved by {@code * future_requirements[current_deadline]}, these fields will transition to the main {@code * requirements} hash. */ @@ -2156,8 +2159,8 @@ public static class FutureRequirements 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 errors; @@ -2170,20 +2173,19 @@ public static class FutureRequirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by {@code requirements.current_deadline}. These fields need to - * be collected to enable the capability on the account. New fields will never appear here; - * {@code future_requirements.past_due} will always be a subset of {@code - * requirements.past_due}. + * Fields that haven't been resolved by {@code requirements.current_deadline}. These fields need + * to be resolved to enable the capability on the account. {@code future_requirements.past_due} + * is a subset of {@code requirements.past_due}. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due} or {@code currently_due}. Fields might appear in {@code - * eventually_due} or {@code currently_due} and in {@code pending_verification} if verification - * fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -2196,12 +2198,12 @@ public static class FutureRequirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") @@ -2307,7 +2309,7 @@ public static class Errors extends StripeObject { public static class Groups extends StripeObject { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ @SerializedName("payments_pricing") @@ -2323,8 +2325,11 @@ public static class Groups extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Requirements 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 alternatives; @@ -2338,8 +2343,8 @@ public static class Requirements extends StripeObject { Long currentDeadline; /** - * Fields that need to be collected to keep the account enabled. If not collected by {@code - * current_deadline}, these fields appear in {@code past_due} as well, and the account is + * Fields that need to be resolved to keep the account enabled. If not resolved by {@code + * current_deadline}, these fields will appear in {@code past_due} as well, and the account is * disabled. */ @SerializedName("currently_due") @@ -2347,7 +2352,7 @@ public static class Requirements extends StripeObject { /** * If the account is disabled, this enum describes why. Learn more about handling + * href="https://docs.stripe.com/connect/handling-api-verification">Learn more about handling * verification issues. * *

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 errors; @@ -2375,18 +2380,18 @@ public static class Requirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by {@code current_deadline}. These fields need to be collected - * to enable the account. + * Fields that haven't been resolved by {@code current_deadline}. These fields need to be + * resolved to enable the account. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due}, {@code currently_due}, or {@code past_due}. Fields - * might appear in {@code eventually_due}, {@code currently_due}, or {@code past_due} and in - * {@code pending_verification} if verification fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -2399,12 +2404,12 @@ public static class Requirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") @@ -2516,7 +2521,7 @@ public static class RiskControls extends StripeObject { /** * Represents the rejected reason of the account. Empty if account is not rejected, or rejected - * by Stripe. Please see this page for more + * by Stripe. Please see this page for more * details * *

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 bc337f43a66..00b1c0ce956 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 13c4ab51652..8940f616480 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 available; diff --git a/src/main/java/com/stripe/model/BalanceSettings.java b/src/main/java/com/stripe/model/BalanceSettings.java index 70c1f411113..2856810b8de 100644 --- a/src/main/java/com/stripe/model/BalanceSettings.java +++ b/src/main/java/com/stripe/model/BalanceSettings.java @@ -173,7 +173,7 @@ public static class Payouts extends StripeObject { /** * Details on when funds from charges are available, and when they are paid out to an external * account. See our Setting Bank and + * href="https://docs.stripe.com/connect/bank-transfers#payout-information">Setting Bank and * Debit Card Payouts documentation for details. */ @SerializedName("schedule") diff --git a/src/main/java/com/stripe/model/BalanceTransaction.java b/src/main/java/com/stripe/model/BalanceTransaction.java index 405ae20ba35..3d4063c691b 100644 --- a/src/main/java/com/stripe/model/BalanceTransaction.java +++ b/src/main/java/com/stripe/model/BalanceTransaction.java @@ -22,7 +22,7 @@ * Balance transactions represent funds moving through your Stripe account. Stripe creates them for * every type of transaction that enters or leaves your Stripe account balance. * - *

Related guide: Balance + *

Related guide: Balance * transaction types */ @Getter diff --git a/src/main/java/com/stripe/model/BalanceTransfer.java b/src/main/java/com/stripe/model/BalanceTransfer.java index e2b5cdcf2dc..b747d36a0c2 100644 --- a/src/main/java/com/stripe/model/BalanceTransfer.java +++ b/src/main/java/com/stripe/model/BalanceTransfer.java @@ -18,8 +18,8 @@ /** * Balance transfers represent funds moving between balance types on your Stripe account. They * currently support moving funds between your Stripe balance and your Issuing balance and between your Allocated Funds balance and your + * href="https://docs.stripe.com/issuing">Issuing balance and between your Allocated Funds balance and your * Stripe balance. */ @Getter @@ -46,7 +46,7 @@ public class BalanceTransfer extends ApiResource implements HasId { DestinationBalance destinationBalance; /** - * A hosted + * A hosted * transaction receipt URL that is provided when money movement is considered regulated under * Stripe's money transmission licenses. */ @@ -66,7 +66,7 @@ public class BalanceTransfer 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/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 params, RequestOptions options) @EqualsAndHashCode(callSuper = false) public static class FutureRequirements extends StripeObject { /** - * Fields that need to be collected to keep the external account enabled. If not collected by - * {@code current_deadline}, these fields appear in {@code past_due} as well, and the account is - * disabled. + * Fields that need to be resolved to keep the external account enabled. If not resolved by + * {@code current_deadline}, these fields will appear in {@code past_due} as well, and the + * account is disabled. */ @SerializedName("currently_due") List currentlyDue; /** - * 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 errors; /** - * Fields that weren't collected by {@code current_deadline}. These fields need to be collected - * to enable the external account. + * Fields that haven't been resolved by {@code current_deadline}. These fields need to be + * resolved to enable the external account. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due}, {@code currently_due}, or {@code past_due}. Fields - * might appear in {@code eventually_due}, {@code currently_due}, or {@code past_due} and in - * {@code pending_verification} if verification fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -643,33 +643,33 @@ public static class Errors extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Requirements extends StripeObject { /** - * Fields that need to be collected to keep the external account enabled. If not collected by - * {@code current_deadline}, these fields appear in {@code past_due} as well, and the account is - * disabled. + * Fields that need to be resolved to keep the external account enabled. If not resolved by + * {@code current_deadline}, these fields will appear in {@code past_due} as well, and the + * account is disabled. */ @SerializedName("currently_due") List currentlyDue; /** - * 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 errors; /** - * Fields that weren't collected by {@code current_deadline}. These fields need to be collected - * to enable the external account. + * Fields that haven't been resolved by {@code current_deadline}. These fields need to be + * resolved to enable the external account. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due}, {@code currently_due}, or {@code past_due}. Fields - * might appear in {@code eventually_due}, {@code currently_due}, or {@code past_due} and in - * {@code pending_verification} if verification fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; diff --git a/src/main/java/com/stripe/model/Capability.java b/src/main/java/com/stripe/model/Capability.java index d7bf55d6cb2..119b3b5de09 100644 --- a/src/main/java/com/stripe/model/Capability.java +++ b/src/main/java/com/stripe/model/Capability.java @@ -19,7 +19,7 @@ /** * This is an object representing a capability for a Stripe account. * - *

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 alternatives; @@ -162,7 +165,7 @@ public static class FutureRequirements extends StripeObject { Long currentDeadline; /** - * Fields that need to be collected to keep the capability enabled. If not collected by {@code + * Fields that need to be resolved to keep the capability enabled. If not resolved by {@code * future_requirements[current_deadline]}, these fields will transition to the main {@code * requirements} hash. */ @@ -183,8 +186,8 @@ public static class FutureRequirements 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 errors; @@ -197,20 +200,19 @@ public static class FutureRequirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by {@code requirements.current_deadline}. These fields need to - * be collected to enable the capability on the account. New fields will never appear here; - * {@code future_requirements.past_due} will always be a subset of {@code - * requirements.past_due}. + * Fields that haven't been resolved by {@code requirements.current_deadline}. These fields need + * to be resolved to enable the capability on the account. {@code future_requirements.past_due} + * is a subset of {@code requirements.past_due}. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due} or {@code currently_due}. Fields might appear in {@code - * eventually_due} or {@code currently_due} and in {@code pending_verification} if verification - * fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -223,12 +225,12 @@ public static class FutureRequirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") @@ -333,8 +335,11 @@ public static class Errors extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Requirements 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 alternatives; @@ -350,16 +355,16 @@ public static class Requirements extends StripeObject { Long currentDeadline; /** - * Fields that need to be collected to keep the capability enabled. If not collected by {@code - * current_deadline}, these fields appear in {@code past_due} as well, and the capability is - * disabled. + * Fields that need to be resolved to keep the capability enabled. If not resolved by {@code + * current_deadline}, these fields will appear in {@code past_due} as well, and the capability + * is disabled. */ @SerializedName("currently_due") List currentlyDue; /** * Description of why the capability is disabled. Learn more about handling + * href="https://docs.stripe.com/connect/handling-api-verification">Learn more about handling * verification issues. * *

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 errors; @@ -385,18 +390,18 @@ public static class Requirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by {@code current_deadline}. These fields need to be collected - * to enable the capability on the account. + * Fields that haven't been resolved by {@code current_deadline}. These fields need to be + * resolved to enable the capability on the account. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due}, {@code currently_due}, or {@code past_due}. Fields - * might appear in {@code eventually_due}, {@code currently_due}, or {@code past_due} and in - * {@code pending_verification} if verification fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -409,12 +414,12 @@ public static class Requirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") diff --git a/src/main/java/com/stripe/model/Card.java b/src/main/java/com/stripe/model/Card.java index 804f1fd56e9..2957bbac149 100644 --- a/src/main/java/com/stripe/model/Card.java +++ b/src/main/java/com/stripe/model/Card.java @@ -21,7 +21,7 @@ * 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 Sources + *

Related guide: Card payments with Sources */ @Getter @Setter @@ -222,7 +222,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. */ @SerializedName("available") Map available; @@ -37,7 +37,7 @@ public class CashBalance extends ApiResource { @SerializedName("customer") String customer; - /** The ID of the account whose cash balance this object represents. */ + /** The ID of an Account representing a customer whose cash balance this object represents. */ @SerializedName("customer_account") String customerAccount; diff --git a/src/main/java/com/stripe/model/Charge.java b/src/main/java/com/stripe/model/Charge.java index da17a62dccd..0252c6ab450 100644 --- a/src/main/java/com/stripe/model/Charge.java +++ b/src/main/java/com/stripe/model/Charge.java @@ -24,7 +24,7 @@ /** * The {@code Charge} object represents a single attempt to move money into your Stripe account. * PaymentIntent confirmation is the most common way to create Charges, but Account Debits may also create Charges. + * href="https://docs.stripe.com/connect/account-debits">Account Debits may also create Charges. * Some legacy payment flows create Charges directly, which is not recommended for new integrations. */ @Getter @@ -37,10 +37,10 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * Amount intended to be collected by this payment. A positive integer representing how much to - * charge in the smallest currency + * charge in the smallest currency * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The * minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -69,7 +69,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * The application fee (if any) for the charge. See the Connect + * href="https://docs.stripe.com/connect/direct-charges#collect-fees">See the Connect * documentation for details. */ @SerializedName("application_fee") @@ -79,7 +79,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * The amount of the application fee (if any) requested for the charge. See the Connect + * href="https://docs.stripe.com/connect/direct-charges#collect-fees">See the Connect * documentation for details. */ @SerializedName("application_fee_amount") @@ -153,7 +153,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * Error code explaining reason for charge failure if available (see the errors section for a list of codes). + * href="https://docs.stripe.com/error-codes">the errors section for a list of codes). */ @SerializedName("failure_code") String failureCode; @@ -182,7 +182,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc 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. */ @@ -200,7 +200,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * The account (if any) the charge was made on behalf of without triggering an automatic transfer. - * See the Connect + * See the Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -210,7 +210,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * Details about whether the payment was accepted, and why. See understanding declines for details. + * href="https://docs.stripe.com/declines">understanding declines for details. */ @SerializedName("outcome") Outcome outcome; @@ -237,7 +237,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc PresentmentDetails presentmentDetails; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -343,7 +343,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. See the + * destination charge. See the * Connect documentation for details. */ @SerializedName("transfer_data") @@ -351,7 +351,7 @@ public class Charge extends ApiResource implements MetadataStore, Balanc /** * 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") @@ -1020,7 +1020,7 @@ public static class LineItem extends StripeObject { public static class Outcome extends StripeObject { /** * An enumerated value providing a more detailed explanation on how to proceed with an + * href="https://docs.stripe.com/declines#retrying-issuer-declines">how to proceed with an * error. * *

One of {@code confirm_card_data}, {@code do_not_try_again}, or {@code try_again_later}. @@ -1046,7 +1046,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") @@ -1059,7 +1059,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; @@ -1099,8 +1099,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; @@ -1336,7 +1336,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. @@ -1434,6 +1434,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. @@ -1467,14 +1473,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") @@ -1657,6 +1663,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. @@ -1681,6 +1693,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. @@ -1940,7 +1958,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; @@ -2574,9 +2592,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; @@ -2974,9 +2992,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; @@ -2986,8 +3005,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; @@ -3540,6 +3560,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; @@ -3631,14 +3657,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") @@ -3990,6 +4016,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. @@ -4003,9 +4035,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; @@ -4212,6 +4244,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. @@ -4281,14 +4319,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") @@ -4329,7 +4367,7 @@ public static class PresentmentDetails extends StripeObject { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @Getter @@ -4337,7 +4375,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 9eea2e8f321..579a7e33452 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. * @@ -1040,9 +1040,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; @@ -1749,9 +1749,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; @@ -1761,8 +1761,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 Long maxRedemptions; /** - * 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/CreditNote.java b/src/main/java/com/stripe/model/CreditNote.java index 3d4fb10eb12..a1394ad15cd 100644 --- a/src/main/java/com/stripe/model/CreditNote.java +++ b/src/main/java/com/stripe/model/CreditNote.java @@ -25,7 +25,7 @@ /** * Issue a credit note to adjust an invoice's amount after the invoice is finalized. * - *

Related guide: Credit + *

Related guide: Credit * notes */ @Getter @@ -60,7 +60,7 @@ public class CreditNote extends ApiResource implements HasId, MetadataStore customer; - /** ID of the account. */ + /** ID of the account representing the customer. */ @SerializedName("customer_account") String customerAccount; @@ -116,7 +116,7 @@ public class CreditNote 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. */ @@ -182,7 +182,7 @@ public class CreditNote extends ApiResource implements HasId, MetadataStorevoiding credit notes. + * href="https://docs.stripe.com/billing/invoices/credit-notes#voiding">voiding credit notes. */ @SerializedName("status") String status; @@ -947,6 +947,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/CreditNoteLineItem.java b/src/main/java/com/stripe/model/CreditNoteLineItem.java index 954a3ceef73..47f125c4f75 100644 --- a/src/main/java/com/stripe/model/CreditNoteLineItem.java +++ b/src/main/java/com/stripe/model/CreditNoteLineItem.java @@ -269,6 +269,7 @@ public static class Tax 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/Customer.java b/src/main/java/com/stripe/model/Customer.java index 8918954d5b8..efdf01ffd71 100644 --- a/src/main/java/com/stripe/model/Customer.java +++ b/src/main/java/com/stripe/model/Customer.java @@ -29,8 +29,8 @@ /** * This object represents a customer of your business. Use it to create recurring charges, save payment and contact + * href="https://docs.stripe.com/invoicing/customer">create recurring charges, save payment and contact * information, and track payments that belong to the same customer. */ @Getter @@ -47,7 +47,7 @@ public class Customer extends ApiResource implements HasId, MetadataStoreinvoice_credit_balance. + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance">invoice_credit_balance. */ @SerializedName("balance") Long balance; @@ -76,6 +76,10 @@ public class Customer extends ApiResource implements HasId, MetadataStoreIf you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * field instead. */ @SerializedName("default_source") @@ -101,7 +105,7 @@ public class Customer extends ApiResource implements HasId, MetadataStoreIf an invoice becomes uncollectible by dunning, {@code delinquent} + * href="https://docs.stripe.com/billing/automatic-collection">dunning, {@code delinquent} * doesn't reset to {@code false}. * *

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, 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. */ diff --git a/src/main/java/com/stripe/model/CustomerBalanceTransaction.java b/src/main/java/com/stripe/model/CustomerBalanceTransaction.java index d31ace73af9..27854402469 100644 --- a/src/main/java/com/stripe/model/CustomerBalanceTransaction.java +++ b/src/main/java/com/stripe/model/CustomerBalanceTransaction.java @@ -18,14 +18,14 @@ /** * Each customer has a Balance value, + * href="https://docs.stripe.com/api/customers/object#customer_object-balance">Balance value, * which denotes a debit or credit that's automatically applied to their next invoice upon * finalization. You may modify the value directly by using the update customer API, or by creating a + * href="https://docs.stripe.com/api/customers/update">update customer API, or by creating a * Customer Balance Transaction, which increments or decrements the customer's {@code balance} by * the specified {@code amount}. * - *

Related guide: Customer balance + *

Related guide: Customer balance */ @Getter @Setter @@ -68,6 +68,7 @@ public class CustomerBalanceTransaction extends ApiResource @Setter(lombok.AccessLevel.NONE) ExpandableField customer; + /** The ID of an Account representing a customer that the transaction belongs to. */ @SerializedName("customer_account") String customerAccount; @@ -102,7 +103,7 @@ public class CustomerBalanceTransaction 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. */ @@ -124,7 +125,7 @@ public class CustomerBalanceTransaction extends ApiResource * {@code unspent_receiver_credit}, {@code unapplied_from_invoice}, {@code * checkout_session_subscription_payment}, or {@code * checkout_session_subscription_payment_canceled}. See the Customer Balance page to + * href="https://docs.stripe.com/billing/customer/balance#types">Customer Balance page to * learn more about transaction types. * *

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 customer; + /** + * The ID of an Account representing a customer whose available cash balance changed as a result + * of this transaction. + */ @SerializedName("customer_account") String customerAccount; /** * The total available cash balance for the specified currency after this transaction was applied. - * Represented in the smallest currency + * Represented in the smallest currency * unit. */ @SerializedName("ending_balance") @@ -69,7 +73,7 @@ public class CustomerCashBalanceTransaction extends StripeObject /** * The amount by which the cash balance changed, represented in the smallest currency unit. A positive + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. A positive * value represents funds being added to the cash balance, a negative value represents funds being * removed from the cash balance. */ @@ -92,7 +96,7 @@ public class CustomerCashBalanceTransaction extends StripeObject /** * The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn + * href="https://docs.stripe.com/payments/customer-balance#types">Customer Balance to learn * more about these types. * *

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 balanceTransaction; /** - * The Cash Balance + * The Cash Balance * Transaction that brought the customer balance negative, triggering the clawback of funds. */ @SerializedName("linked_transaction") @@ -198,7 +202,7 @@ public void setLinkedTransactionObject(CustomerCashBalanceTransaction expandable @EqualsAndHashCode(callSuper = false) public static class AppliedToPayment extends StripeObject { /** - * The Payment Intent that + * The Payment Intent that * funds were applied to. */ @SerializedName("payment_intent") @@ -367,7 +371,7 @@ public static class UsBankTransfer extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class RefundedFromPayment extends StripeObject { /** - * The Refund that moved these funds + * The Refund that moved these funds * into the customer's cash balance. */ @SerializedName("refund") @@ -403,7 +407,7 @@ public void setRefundObject(Refund expandableObject) { @EqualsAndHashCode(callSuper = false) public static class TransferredToBalance extends StripeObject { /** - * The Balance Transaction + * The Balance Transaction * that corresponds to funds transferred to your Stripe balance. */ @SerializedName("balance_transaction") @@ -440,7 +444,7 @@ public void setBalanceTransactionObject(BalanceTransaction expandableObject) { @EqualsAndHashCode(callSuper = false) public static class UnappliedFromPayment extends StripeObject { /** - * The Payment Intent that + * The Payment Intent that * funds were unapplied from. */ @SerializedName("payment_intent") diff --git a/src/main/java/com/stripe/model/Discount.java b/src/main/java/com/stripe/model/Discount.java index b69e6dc3545..6b71a8bdab2 100644 --- a/src/main/java/com/stripe/model/Discount.java +++ b/src/main/java/com/stripe/model/Discount.java @@ -9,11 +9,11 @@ /** * 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 */ @Getter @@ -33,7 +33,7 @@ public class Discount extends StripeObject implements HasId { @Setter(lombok.AccessLevel.NONE) ExpandableField customer; - /** The ID of the account associated with this discount. */ + /** The ID of the account representing the customer associated with this discount. */ @SerializedName("customer_account") String customerAccount; diff --git a/src/main/java/com/stripe/model/Dispute.java b/src/main/java/com/stripe/model/Dispute.java index a5dbd0f7613..f5960a8e47b 100644 --- a/src/main/java/com/stripe/model/Dispute.java +++ b/src/main/java/com/stripe/model/Dispute.java @@ -24,7 +24,7 @@ * you have the opportunity to respond to the dispute with evidence that shows that the charge is * legitimate. * - *

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 d2253d4d078..61c1a6c2400 100644 --- a/src/main/java/com/stripe/model/EventDataClassLookup.java +++ b/src/main/java/com/stripe/model/EventDataClassLookup.java @@ -227,6 +227,9 @@ public final class EventDataClassLookup { classLookup.put("scheduled_query_run", com.stripe.model.sigma.ScheduledQueryRun.class); + classLookup.put( + "shared_payment.granted_token", com.stripe.model.sharedpayment.GrantedToken.class); + classLookup.put("tax.association", com.stripe.model.tax.Association.class); classLookup.put("tax.calculation", com.stripe.model.tax.Calculation.class); classLookup.put("tax.calculation_line_item", com.stripe.model.tax.CalculationLineItem.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 guide for more details. * *

----- * 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, 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. */ diff --git a/src/main/java/com/stripe/model/FundingInstructions.java b/src/main/java/com/stripe/model/FundingInstructions.java index 64d9d2573d5..b9064c39f6b 100644 --- a/src/main/java/com/stripe/model/FundingInstructions.java +++ b/src/main/java/com/stripe/model/FundingInstructions.java @@ -9,11 +9,11 @@ /** * Each customer has a {@code balance} + * href="https://docs.stripe.com/api/customers/object#customer_object-balance">{@code balance} * that is automatically applied to future invoices and payments using the {@code customer_balance} * payment method. Customers can fund this balance by initiating a bank transfer to any account in * the {@code financial_addresses} field. Related guide: Customer balance + * href="https://docs.stripe.com/payments/customer-balance/funding-instructions">Customer balance * funding instructions */ @Getter diff --git a/src/main/java/com/stripe/model/Invoice.java b/src/main/java/com/stripe/model/Invoice.java index b28b10901bb..fab1459ab0a 100644 --- a/src/main/java/com/stripe/model/Invoice.java +++ b/src/main/java/com/stripe/model/Invoice.java @@ -37,12 +37,12 @@ * Invoices are statements of amounts owed by a customer, and are either generated one-off, or * generated periodically from a subscription. * - *

They contain invoice items, and - * proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). + *

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, MetadataStoreautomatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. If {@code false}, the invoice's state doesn't automatically * advance without an explicit action. */ @@ -223,13 +223,13 @@ public class Invoice extends ApiResource implements HasId, MetadataStore customFields; - /** The ID of the customer who will be billed. */ + /** The ID of the customer to bill. */ @SerializedName("customer") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) ExpandableField customer; - /** The ID of the account who will be billed. */ + /** The ID of the account representing the customer to bill. */ @SerializedName("customer_account") String customerAccount; @@ -363,7 +363,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStorerevision documentation for more + * href="https://docs.stripe.com/invoicing/invoice-revisions">revision documentation for more * details. */ @SerializedName("from_invoice") @@ -425,7 +425,7 @@ public class Invoice 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. */ @@ -458,7 +458,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStoreInvoices with Connect + * See the Invoices with Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -540,7 +540,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStoreLearn more + * href="https://docs.stripe.com/billing/invoices/workflow#workflow-overview">Learn more */ @SerializedName("status") String status; @@ -604,7 +604,7 @@ public class Invoice extends ApiResource implements HasId, MetadataStorebeen exhausted. This field + * href="https://docs.stripe.com/billing/webhooks#understand">been exhausted. This field * tracks the time when webhooks for this invoice were successfully delivered. If the invoice had * no webhooks to deliver, this will be set while the invoice is being created. */ @@ -2090,7 +2090,7 @@ public static class AutomaticTax extends StripeObject { /** * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice * items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ @SerializedName("enabled") @@ -2393,7 +2393,7 @@ public static class ScheduleDetails extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class SubscriptionDetails extends StripeObject { /** - * Set of key-value pairs defined as + * Set of key-value pairs defined as * subscription metadata when an invoice is created. Becomes an immutable snapshot of the * subscription metadata at the time of invoice finalization. Note: This attribute is * populated only for invoices created on or after June 29, 2023. @@ -2404,7 +2404,7 @@ public static class SubscriptionDetails extends StripeObject { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -2543,6 +2543,13 @@ public static class PaymentMethodOptions extends StripeObject { @SerializedName("konbini") Konbini konbini; + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + @SerializedName("payto") + Payto payto; + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -2640,10 +2647,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. * @@ -2743,6 +2750,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. @@ -3307,6 +3361,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 861247d2afe..16b304014b2 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 customer; - /** The ID of the account who will be billed when this invoice item is billed. */ + /** The ID of the account to bill for this invoice item. */ @SerializedName("customer_account") String customerAccount; @@ -118,7 +118,7 @@ public class InvoiceItem extends ApiResource implements HasId, MetadataStore> margins; /** - * 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/InvoiceLineItem.java b/src/main/java/com/stripe/model/InvoiceLineItem.java index 4fdf1868382..4baa7b8685e 100644 --- a/src/main/java/com/stripe/model/InvoiceLineItem.java +++ b/src/main/java/com/stripe/model/InvoiceLineItem.java @@ -21,12 +21,12 @@ /** * Invoice Line Items represent the individual lines within an invoice and only exist within the context of an + * href="https://docs.stripe.com/api/invoices">invoice and only exist within the context of an * invoice. * *

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> margins; /** - * 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. Note that for line items with {@code type=subscription}, {@code metadata} * reflects the current metadata from the subscription associated with the line item, unless the @@ -884,6 +884,7 @@ public static class Tax 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/InvoicePayment.java b/src/main/java/com/stripe/model/InvoicePayment.java index 46165f99bc2..bdf9d3d56f6 100644 --- a/src/main/java/com/stripe/model/InvoicePayment.java +++ b/src/main/java/com/stripe/model/InvoicePayment.java @@ -19,7 +19,7 @@ /** * Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in * two ways: 1. By expanding the {@code payments} field on the Invoice resource. 2. By using the Invoice Payment + * href="https://api.stripe.com#invoice">Invoice resource. 2. By using the Invoice Payment * retrieve and list endpoints. * *

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 in that it takes the user * directly to their Express + * href="https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link">Express * dashboard for the specified account */ @Getter diff --git a/src/main/java/com/stripe/model/Margin.java b/src/main/java/com/stripe/model/Margin.java index ec7775436b8..ef61b44fe6f 100644 --- a/src/main/java/com/stripe/model/Margin.java +++ b/src/main/java/com/stripe/model/Margin.java @@ -50,7 +50,7 @@ public class Margin 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/Order.java b/src/main/java/com/stripe/model/Order.java index 1bdf75695db..b36d949f04b 100644 --- a/src/main/java/com/stripe/model/Order.java +++ b/src/main/java/com/stripe/model/Order.java @@ -36,7 +36,7 @@ public class Order extends ApiResource implements HasId, MetadataStore { /** * Order cost before any discounts or taxes are applied. A positive integer representing the - * subtotal of the order in the smallest + * subtotal of the order in the smallest * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal * currency). */ @@ -45,10 +45,10 @@ public class Order extends ApiResource implements HasId, MetadataStore { /** * Total order cost after discounts and taxes are applied. A positive integer representing the - * cost of the order in the smallest + * cost of the order in the smallest * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal * currency). To submit an order, the total must be either 0 or at least $0.50 USD or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. */ @SerializedName("amount_total") @@ -75,7 +75,7 @@ public class Order extends ApiResource implements HasId, MetadataStore { * Make sure that you have TLS enabled on any page that includes the client secret. * *

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 { 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. */ @@ -742,7 +742,7 @@ public static class Settings extends StripeObject { PaymentMethodOptions paymentMethodOptions; /** - * The list of payment + * The list of payment * method types to provide to the order's PaymentIntent. Do not include this attribute if * you prefer to manage your payment methods from the Stripe Dashboard. @@ -961,17 +961,17 @@ public static class AfterpayClearpay 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 @@ -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 ddfa277e09c..650f181e444 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 @@ -52,10 +52,10 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

smallest currency + * to charge in the smallest currency * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The * minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -83,12 +83,15 @@ 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. @@ -132,7 +135,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 and * learn about how {@code client_secret} should be handled. */ @SerializedName("client_secret") @@ -164,7 +167,7 @@ public class PaymentIntent extends ApiResource implements HasId, MetadataStore

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 @@ -178,12 +181,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 @@ -222,7 +225,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. */ @@ -239,10 +242,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}) @@ -265,9 +268,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) @@ -285,7 +289,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") @@ -364,6 +368,10 @@ 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") @@ -419,7 +427,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") @@ -1735,7 +1743,7 @@ public static class AllocatedFunds extends StripeObject { 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 @@ -1770,7 +1778,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") @@ -1801,7 +1809,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 @@ -1825,6 +1833,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. @@ -1838,7 +1883,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. * @@ -1882,7 +1927,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; } @@ -3988,7 +4033,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; @@ -4006,7 +4051,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}. @@ -4016,7 +4061,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}. @@ -4026,7 +4071,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}. @@ -4035,7 +4080,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}. @@ -4044,7 +4089,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}. @@ -4063,11 +4108,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. * @@ -4323,7 +4368,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; } @@ -4348,7 +4396,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") @@ -4356,10 +4404,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") @@ -6445,7 +6493,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). */ @@ -6486,6 +6534,7 @@ public void setResponseGetter(StripeResponseGetter responseGetter) { trySetResponseGetter(allocatedFunds, 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, 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. */ @@ -909,7 +909,7 @@ public static class InvoiceData extends StripeObject { Issuer issuer; /** - * Set of key-value pairs that you can + * 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. */ @@ -1165,8 +1165,8 @@ public static class PaymentIntentData extends StripeObject { String description; /** - * Set of key-value pairs that will set - * metadata on Payment Intents + * Set of key-value pairs that will set + * metadata on Payment Intents * generated from this payment link. */ @SerializedName("metadata") @@ -1198,7 +1198,7 @@ public static class PaymentIntentData extends StripeObject { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts for details. */ @SerializedName("transfer_group") @@ -1328,8 +1328,8 @@ public static class SubscriptionData extends StripeObject { InvoiceSettings invoiceSettings; /** - * Set of key-value pairs that will set - * metadata on Subscriptions generated + * Set of key-value pairs that will set + * metadata on Subscriptions generated * from this payment link. */ @SerializedName("metadata") diff --git a/src/main/java/com/stripe/model/PaymentMethod.java b/src/main/java/com/stripe/model/PaymentMethod.java index 463896be774..35319fcc9c9 100644 --- a/src/main/java/com/stripe/model/PaymentMethod.java +++ b/src/main/java/com/stripe/model/PaymentMethod.java @@ -24,11 +24,11 @@ /** * PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or + * href="https://docs.stripe.com/payments/payment-intents">PaymentIntents to collect payments or * save them to Customer objects to store instrument details for future payments. * - *

Related guides: Payment Methods - * and More Payment Scenarios. + *

Related guides: Payment Methods + * and More Payment Scenarios. */ @Getter @Setter @@ -179,7 +179,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. */ @@ -241,7 +241,7 @@ public class PaymentMethod extends ApiResource implements HasId, MetadataStore

Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -653,22 +653,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 params) throws StripeException { return list(params, (RequestOptions) null); } - /** - * 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 params, RequestOptions options) throws StripeException { String path = "/v1/payment_methods"; @@ -677,23 +667,13 @@ public static PaymentMethodCollection list(Map params, RequestOp return getGlobalResponseGetter().request(request, PaymentMethodCollection.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(PaymentMethodListParams params) throws StripeException { return list(params, (RequestOptions) null); } - /** - * 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(PaymentMethodListParams params, RequestOptions options) throws StripeException { String path = "/v1/payment_methods"; @@ -1337,9 +1317,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; @@ -2078,8 +2058,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}. + * 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; @@ -2089,8 +2070,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; @@ -2558,7 +2540,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 @@ -2566,7 +2548,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, Balanc /** * The application fee (if any) for the payout. See the Connect + * href="https://docs.stripe.com/connect/instant-payouts#monetization-and-fees">See the Connect * documentation for details. */ @SerializedName("application_fee") @@ -52,7 +52,7 @@ public class Payout extends ApiResource implements MetadataStore, Balanc /** * The amount of the application fee (if any) requested for the payout. See the Connect + * href="https://docs.stripe.com/connect/instant-payouts#monetization-and-fees">See the Connect * documentation for details. */ @SerializedName("application_fee_amount") @@ -67,7 +67,7 @@ public class Payout extends ApiResource implements MetadataStore, Balanc /** * Returns {@code true} if the payout is created by an automated payout schedule and {@code + * href="https://docs.stripe.com/payouts#payout-schedule">automated payout schedule and {@code * false} if it's requested manually. */ @SerializedName("automatic") @@ -113,7 +113,7 @@ public class Payout extends ApiResource implements MetadataStore, Balanc /** * Error code that provides a reason for a payout failure, if available. View our list of failure codes. + * href="https://docs.stripe.com/api#payout_failures">list of failure codes. */ @SerializedName("failure_code") String failureCode; @@ -135,7 +135,7 @@ public class Payout extends ApiResource implements MetadataStore, Balanc 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. */ @@ -172,7 +172,7 @@ public class Payout extends ApiResource implements MetadataStore, Balanc /** * If {@code completed}, you can use the Balance + * href="https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout">Balance * Transactions API to list all balance transactions that are paid out in this payout. * *

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 2e3dc67859d..51d75f095fe 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 /** * Information about the upcoming new + * href="https://docs.stripe.com/connect/custom-accounts/future-requirements">upcoming new * requirements for this person, including what information needs to be collected, and by * when. */ @@ -167,7 +167,7 @@ public class Person extends ApiResource implements HasId, MetadataStore String maidenName; /** - * 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. */ @@ -466,25 +466,28 @@ public static class Dob 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 alternatives; /** - * Fields that need to be collected to keep the person's account enabled. If not collected by - * the account's {@code future_requirements[current_deadline]}, these fields will transition to - * the main {@code requirements} hash, and may immediately become {@code past_due}, but the - * account may also be given a grace period depending on the account's enablement state prior to + * Fields that need to be resolved to keep the person's account enabled. If not resolved by the + * account's {@code future_requirements[current_deadline]}, these fields will transition to the + * main {@code requirements} hash, and may immediately become {@code past_due}, but the account + * may also be given a grace period depending on the account's enablement state prior to * transition. */ @SerializedName("currently_due") List currentlyDue; /** - * 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 errors; @@ -498,20 +501,19 @@ public static class FutureRequirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by the account's {@code requirements.current_deadline}. These - * fields need to be collected to enable the person's account. New fields will never appear - * here; {@code future_requirements.past_due} will always be a subset of {@code - * requirements.past_due}. + * Fields that haven't been resolved by the account's {@code requirements.current_deadline}. + * These fields need to be resolved to enable the person's account. {@code + * future_requirements.past_due} is a subset of {@code requirements.past_due}. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due} or {@code currently_due}. Fields might appear in {@code - * eventually_due} or {@code currently_due} and in {@code pending_verification} if verification - * fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -524,12 +526,12 @@ public static class FutureRequirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") @@ -688,23 +690,26 @@ public static class Relationship extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Requirements 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 alternatives; /** - * Fields that need to be collected to keep the person's account enabled. If not collected by - * the account's {@code current_deadline}, these fields appear in {@code past_due} as well, and + * Fields that need to be resolved to keep the person's account enabled. If not resolved by the + * account's {@code current_deadline}, these fields will appear in {@code past_due} as well, and * the account is disabled. */ @SerializedName("currently_due") List currentlyDue; /** - * 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 errors; @@ -717,18 +722,18 @@ public static class Requirements extends StripeObject { List eventuallyDue; /** - * Fields that weren't collected by the account's {@code current_deadline}. These fields need to - * be collected to enable the person's account. + * Fields that haven't been resolved by {@code current_deadline}. These fields need to be + * resolved to enable the person's account. */ @SerializedName("past_due") List pastDue; /** - * Fields that might become required depending on the results of verification or review. It's an - * empty array unless an asynchronous verification is pending. If verification fails, these - * fields move to {@code eventually_due}, {@code currently_due}, or {@code past_due}. Fields - * might appear in {@code eventually_due}, {@code currently_due}, or {@code past_due} and in - * {@code pending_verification} if verification fails but another verification is still pending. + * Fields that are being reviewed, or might become required depending on the results of a + * review. If the review fails, these fields can move to {@code eventually_due}, {@code + * currently_due}, {@code past_due} or {@code alternatives}. Fields might appear in {@code + * eventually_due}, {@code currently_due}, {@code past_due} or {@code alternatives} and in + * {@code pending_verification} if one verification fails but another is still pending. */ @SerializedName("pending_verification") List pendingVerification; @@ -741,12 +746,12 @@ public static class Requirements extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Alternative extends StripeObject { - /** Fields that can be provided to satisfy all fields in {@code original_fields_due}. */ + /** Fields that can be provided to resolve all fields in {@code original_fields_due}. */ @SerializedName("alternative_fields_due") List alternativeFieldsDue; /** - * Fields that are due and can be satisfied by providing all fields in {@code + * Fields that are due and can be resolved by providing all fields in {@code * alternative_fields_due}. */ @SerializedName("original_fields_due") @@ -977,7 +982,7 @@ public static class Verification extends StripeObject { /** * The state of verification for the person. Possible values are {@code unverified}, {@code * pending}, or {@code verified}. Please refer guide to handle + * href="https://docs.stripe.com/connect/handling-api-verification">guide to handle * verification updates. */ @SerializedName("status") @@ -992,7 +997,7 @@ public static class Verification extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument extends StripeObject { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @@ -1022,7 +1027,7 @@ public static class AdditionalDocument extends StripeObject { String detailsCode; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") @@ -1076,7 +1081,7 @@ public void setFrontObject(File expandableObject) { @EqualsAndHashCode(callSuper = false) public static class Document extends StripeObject { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @@ -1106,7 +1111,7 @@ public static class Document extends StripeObject { String detailsCode; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") diff --git a/src/main/java/com/stripe/model/Plan.java b/src/main/java/com/stripe/model/Plan.java index b6e8398d43e..99a23a59c21 100644 --- a/src/main/java/com/stripe/model/Plan.java +++ b/src/main/java/com/stripe/model/Plan.java @@ -22,22 +22,22 @@ /** * 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 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 { 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. */ @@ -173,7 +173,7 @@ public class Plan extends ApiResource implements HasId, MetadataStore { /** * Default number of trial days when subscribing a customer to this plan using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ @SerializedName("trial_period_days") diff --git a/src/main/java/com/stripe/model/Price.java b/src/main/java/com/stripe/model/Price.java index dd40da8fff8..3441e837841 100644 --- a/src/main/java/com/stripe/model/Price.java +++ b/src/main/java/com/stripe/model/Price.java @@ -23,8 +23,8 @@ /** * 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 + * 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. @@ -33,9 +33,9 @@ * $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. */ @Getter @@ -109,7 +109,7 @@ public class Price extends ApiResource implements HasId, MetadataStore { String lookupKey; /** - * 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. */ @@ -145,7 +145,7 @@ public class Price extends ApiResource implements HasId, MetadataStore { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -476,7 +476,7 @@ public static class CurrencyOption extends StripeObject { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -642,7 +642,7 @@ public static class Recurring extends StripeObject { /** * Default number of trial days when subscribing a customer to this price using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ @SerializedName("trial_period_days") diff --git a/src/main/java/com/stripe/model/Product.java b/src/main/java/com/stripe/model/Product.java index b79fc69a748..62d297b6471 100644 --- a/src/main/java/com/stripe/model/Product.java +++ b/src/main/java/com/stripe/model/Product.java @@ -25,15 +25,15 @@ * Products describe the specific goods or services you offer to your customers. For example, you * might offer a Standard and Premium version of your goods or service; each version would be a * separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, - * Checkout, and Subscriptions. + * href="https://api.stripe.com#prices">Prices to configure pricing in Payment Links, Checkout, + * and Subscriptions. * *

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, MetadataStorePrice object that is the default + * The ID of the Price object that is the default * price for this product. */ @SerializedName("default_price") @@ -86,13 +86,13 @@ public class Product extends ApiResource implements HasId, MetadataStorepricing tables. + * href="https://docs.stripe.com/payments/checkout/pricing-table">pricing tables. */ @SerializedName("marketing_features") List marketingFeatures; /** - * 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. */ @@ -128,7 +128,7 @@ public class Product extends ApiResource implements HasId, MetadataStoretax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") @Getter(lombok.AccessLevel.NONE) @Setter(lombok.AccessLevel.NONE) diff --git a/src/main/java/com/stripe/model/PromotionCode.java b/src/main/java/com/stripe/model/PromotionCode.java index 51ec9aefd2e..5761b50a8b5 100644 --- a/src/main/java/com/stripe/model/PromotionCode.java +++ b/src/main/java/com/stripe/model/PromotionCode.java @@ -23,7 +23,7 @@ * create multiple codes for a single promotion. * *

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 e50fe47af9c..2ced9d071e7 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 { 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 customer; /** - * The account which this quote belongs to. A customer or account is required before finalizing - * the quote. Once specified, it cannot be changed. + * The account representing the customer who received this quote. A customer or account is + * required to finalize the quote. Once specified, you can't change it. */ @SerializedName("customer_account") String customerAccount; @@ -150,7 +150,7 @@ public class Quote extends ApiResource implements HasId, MetadataStore { /** * 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. * *

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") @@ -2015,7 +2015,7 @@ public static class SubscriptionData extends StripeObject { ExpandableField fromSubscription; /** - * Set of key-value pairs that will set + * Set of key-value pairs that will set * metadata on the subscription or subscription schedule when the quote is accepted. If a * recurring price is included in {@code line_items}, this field will be passed to the resulting * subscription's {@code metadata} field. If {@code subscription_data.effective_date} is used, @@ -2048,7 +2048,7 @@ public static class SubscriptionData 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}. @@ -2471,8 +2471,8 @@ public static class SubscriptionDataOverride extends StripeObject { List billingSchedules; /** - * 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; @@ -2508,7 +2508,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}. @@ -2951,12 +2951,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 c6dad65ddd8..db539204a3e 100644 --- a/src/main/java/com/stripe/model/QuoteLine.java +++ b/src/main/java/com/stripe/model/QuoteLine.java @@ -293,7 +293,7 @@ public static class AddItem extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to an item. Metadata on this item will update the underlying subscription item's * {@code metadata} when the phase is entered. */ @@ -744,7 +744,7 @@ public static class SetItem extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to an item. Metadata on this item will update the underlying subscription item's * {@code metadata} when the phase is entered. */ @@ -1075,7 +1075,7 @@ public static class SetPauseCollection extends StripeObject { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("set") diff --git a/src/main/java/com/stripe/model/QuotePreviewInvoice.java b/src/main/java/com/stripe/model/QuotePreviewInvoice.java index c2b924604fa..3089f04e337 100644 --- a/src/main/java/com/stripe/model/QuotePreviewInvoice.java +++ b/src/main/java/com/stripe/model/QuotePreviewInvoice.java @@ -23,12 +23,12 @@ * Invoices are statements of amounts owed by a customer, and are either generated one-off, or * generated periodically from a subscription. * - *

They contain invoice items, and - * proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). + *

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 customFields; - /** The ID of the account who will be billed. */ + /** The ID of the account representing the customer to bill. */ @SerializedName("customer_account") String customerAccount; @@ -333,7 +333,7 @@ public class QuotePreviewInvoice extends ApiResource implements HasId { /** * Details of the invoice that was cloned. See the revision documentation for more + * href="https://docs.stripe.com/invoicing/invoice-revisions">revision documentation for more * details. */ @SerializedName("from_invoice") @@ -381,7 +381,7 @@ public class QuotePreviewInvoice 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. */ @@ -413,7 +413,7 @@ public class QuotePreviewInvoice extends ApiResource implements HasId { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -495,7 +495,7 @@ public class QuotePreviewInvoice extends ApiResource implements HasId { /** * The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code * uncollectible}, or {@code void}. Learn more + * href="https://docs.stripe.com/billing/invoices/workflow#workflow-overview">Learn more */ @SerializedName("status") String status; @@ -564,7 +564,7 @@ public class QuotePreviewInvoice extends ApiResource implements HasId { /** * Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all * webhook delivery attempts have been exhausted. This field + * href="https://docs.stripe.com/billing/webhooks#understand">been exhausted. This field * tracks the time when webhooks for this invoice were successfully delivered. If the invoice had * no webhooks to deliver, this will be set while the invoice is being created. */ @@ -958,7 +958,7 @@ public static class AutomaticTax extends StripeObject { /** * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice * items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ @SerializedName("enabled") @@ -1261,7 +1261,7 @@ public static class ScheduleDetails extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class SubscriptionDetails extends StripeObject { /** - * Set of key-value pairs defined as + * Set of key-value pairs defined as * subscription metadata when an invoice is created. Becomes an immutable snapshot of the * subscription metadata at the time of invoice finalization. Note: This attribute is * populated only for invoices created on or after June 29, 2023. @@ -1272,7 +1272,7 @@ public static class SubscriptionDetails extends StripeObject { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -1411,6 +1411,13 @@ public static class PaymentMethodOptions extends StripeObject { @SerializedName("konbini") Konbini konbini; + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + @SerializedName("payto") + Payto payto; + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -1508,10 +1515,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. * @@ -1611,6 +1618,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. @@ -2175,6 +2229,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 3d70f7c696c..0bc5b44a6a9 100644 --- a/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java +++ b/src/main/java/com/stripe/model/QuotePreviewSubscriptionSchedule.java @@ -123,7 +123,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. */ @@ -160,7 +160,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}. @@ -558,7 +558,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}. */ @@ -991,7 +991,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}. */ @@ -1085,7 +1085,7 @@ public static class Phase extends StripeObject { List items; /** - * Set of key-value pairs that you can attach + * Set of key-value pairs that you can attach * to a phase. Metadata on a schedule's phase will update the underlying subscription's {@code * metadata} when the phase is entered. Updating the underlying subscription's {@code metadata} * directly will not affect the current phase's {@code metadata}. @@ -1105,7 +1105,7 @@ public static class Phase extends StripeObject { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -1198,7 +1198,7 @@ public static class AddInvoiceItem extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * 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. */ @@ -1754,7 +1754,7 @@ public static class Item extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to an item. Metadata on this item will update the underlying subscription item's * {@code metadata} when the phase is entered. */ diff --git a/src/main/java/com/stripe/model/Refund.java b/src/main/java/com/stripe/model/Refund.java index 025ed8e0215..910c65334c0 100644 --- a/src/main/java/com/stripe/model/Refund.java +++ b/src/main/java/com/stripe/model/Refund.java @@ -24,7 +24,7 @@ * Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are * refunded to the credit or debit card that's initially charged. * - *

Related guide: Refunds + *

Related guide: Refunds */ @Getter @Setter @@ -97,7 +97,7 @@ public class Refund extends ApiResource implements MetadataStore, Balanc String instructionsEmail; /** - * 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. */ @@ -161,7 +161,7 @@ public class Refund extends ApiResource implements MetadataStore, Balanc /** * Status of the refund. This can be {@code pending}, {@code requires_action}, {@code succeeded}, * {@code failed}, or {@code canceled}. Learn more about failed refunds. + * href="https://docs.stripe.com/refunds#failed-refunds">failed refunds. */ @SerializedName("status") String status; diff --git a/src/main/java/com/stripe/model/Review.java b/src/main/java/com/stripe/model/Review.java index 63ccdff6082..c3487280d94 100644 --- a/src/main/java/com/stripe/model/Review.java +++ b/src/main/java/com/stripe/model/Review.java @@ -22,7 +22,7 @@ * Reviews can be used to supplement automated fraud detection with human expertise. * *

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 423dc17f10a..18eda135558 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 mandate; /** - * 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. */ @@ -208,7 +206,7 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStorepayment method + * href="https://docs.stripe.com/api/payment_method_configurations">payment method * configuration used for this Setup Intent. */ @SerializedName("payment_method_configuration_details") @@ -236,7 +234,7 @@ public class SetupIntent extends ApiResource implements HasId, MetadataStore singleUseMandate; /** - * Status of this + * Status of this * SetupIntent, one of {@code requires_payment_method}, {@code requires_confirmation}, {@code * requires_action}, {@code processing}, {@code canceled}, or {@code succeeded}. */ @@ -855,7 +853,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 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. * @@ -1225,11 +1223,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, 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. */ @@ -89,7 +89,7 @@ public class ShippingRate extends ApiResource implements HasId, MetadataStoretax code ID. The Shipping tax code + * A tax code ID. The Shipping tax code * is {@code txcd_92010001}. */ @SerializedName("tax_code") diff --git a/src/main/java/com/stripe/model/Source.java b/src/main/java/com/stripe/model/Source.java index ac8dd992a5c..ba0f0b3c964 100644 --- a/src/main/java/com/stripe/model/Source.java +++ b/src/main/java/com/stripe/model/Source.java @@ -27,12 +27,12 @@ * object: once chargeable, they can be charged, or can be attached to customers. * *

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, Paymen 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. */ @@ -214,7 +214,7 @@ public class Source extends ApiResource implements MetadataStore, Paymen * klarna}, {@code p24}, {@code sepa_debit}, {@code sofort}, {@code three_d_secure}, or {@code * wechat}. An additional hash is included on the source with a name matching this value. It * contains additional information specific to the payment method used. + * href="https://docs.stripe.com/sources">payment method used. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/SourceMandateNotification.java b/src/main/java/com/stripe/model/SourceMandateNotification.java index 92eda62925a..6a1c794cbb3 100644 --- a/src/main/java/com/stripe/model/SourceMandateNotification.java +++ b/src/main/java/com/stripe/model/SourceMandateNotification.java @@ -69,12 +69,12 @@ public class SourceMandateNotification extends StripeObject implements HasId { * object: once chargeable, they can be charged, or can be attached to customers. * *

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 to collect payments * or save them to Customer objects to store instrument details for future payments. * - *

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 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 @@ -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 684e88f9d54..8ff6648628c 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, MetadataStorebilling cycle dates. It sets the + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle dates. It sets the * day of week for {@code week} intervals, the day of month for {@code month} and {@code year} * intervals, and the month of year for {@code year} intervals. The timestamp is in UTC format. */ @@ -143,7 +143,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStore customer; - /** ID of the account who owns the subscription. */ + /** ID of the account representing the customer who owns the subscription. */ @SerializedName("customer_account") String customerAccount; @@ -158,9 +158,9 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreinvoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_payment_method") @Getter(lombok.AccessLevel.NONE) @@ -172,9 +172,9 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreinvoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_source") @Getter(lombok.AccessLevel.NONE) @@ -238,7 +238,7 @@ public class Subscription 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. */ @@ -264,7 +264,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreConnect documentation for + * href="https://docs.stripe.com/connect/subscriptions#on-behalf-of">Connect documentation for * details. */ @SerializedName("on_behalf_of") @@ -275,7 +275,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStorepausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -287,18 +287,18 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreCreate an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") PendingInvoiceItemInterval pendingInvoiceItemInterval; /** - * You can use this SetupIntent to collect + * You can use this SetupIntent to collect * user authentication when creating a subscription without immediate payment or updating a * subscription's payment method, allowing you to optimize for off-session payments. Learn more in * the SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2">SCA * Migration Guide. */ @SerializedName("pending_setup_intent") @@ -307,7 +307,7 @@ public class Subscription extends ApiResource implements HasId, MetadataStore pendingSetupIntent; /** - * If specified, pending + * If specified, pending * updates that will be applied to the subscription once the {@code latest_invoice} has been * paid. */ @@ -346,11 +346,11 @@ public class Subscription extends ApiResource implements HasId, MetadataStoreA subscription can only enter a {@code paused} status when + * href="https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment">when * a trial ends without a payment method. A {@code paused} subscription doesn't generate * invoices and can be resumed after your customer adds their payment method. The {@code paused} * status is different from pausing collection, + * href="https://docs.stripe.com/billing/subscriptions/pause-payment">pausing collection, * which still generates invoices and leaves the subscription's status unchanged. * *

If subscription {@code collection_method=charge_automatically}, it becomes {@code past_due} @@ -1953,6 +1953,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. @@ -2057,10 +2064,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. * @@ -2175,6 +2182,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. @@ -2416,7 +2470,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 a8e5a103ab7..553863129f2 100644 --- a/src/main/java/com/stripe/model/SubscriptionItem.java +++ b/src/main/java/com/stripe/model/SubscriptionItem.java @@ -74,7 +74,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. */ @@ -92,48 +92,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 75ba60e99f9..f2eb8b2afd7 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 @@ -135,7 +135,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. */ @@ -173,7 +173,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}. @@ -873,7 +873,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}. */ @@ -1305,7 +1305,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}. */ @@ -1399,7 +1399,7 @@ public static class Phase extends StripeObject { List items; /** - * Set of key-value pairs that you can attach + * Set of key-value pairs that you can attach * to a phase. Metadata on a schedule's phase will update the underlying subscription's {@code * metadata} when the phase is entered. Updating the underlying subscription's {@code metadata} * directly will not affect the current phase's {@code metadata}. @@ -1419,7 +1419,7 @@ public static class Phase extends StripeObject { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -1512,7 +1512,7 @@ public static class AddInvoiceItem extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * 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. */ @@ -2068,7 +2068,7 @@ public static class Item extends StripeObject { List discounts; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to an item. Metadata on this item will update the underlying subscription item's * {@code metadata} when the phase is entered. */ diff --git a/src/main/java/com/stripe/model/TaxId.java b/src/main/java/com/stripe/model/TaxId.java index 97ad2a9aa8c..ad63f053471 100644 --- a/src/main/java/com/stripe/model/TaxId.java +++ b/src/main/java/com/stripe/model/TaxId.java @@ -19,12 +19,12 @@ /** * You can add one or multiple tax IDs to a customer or account. Customer and account tax + * href="https://docs.stripe.com/api/customers">customer or account. Customer and account tax * IDs get displayed on related invoices and credit notes. * - *

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 */ @Getter @Setter @@ -44,7 +44,7 @@ public class TaxId extends ApiResource implements HasId { @Setter(lombok.AccessLevel.NONE) ExpandableField customer; - /** ID of the account. */ + /** ID of the Account representing the customer. */ @SerializedName("customer_account") String customerAccount; @@ -309,7 +309,9 @@ public static class Owner extends StripeObject { @Setter(lombok.AccessLevel.NONE) ExpandableField customer; - /** The account being referenced when {@code type} is {@code customer}. */ + /** + * The Account representing the customer being referenced when {@code type} is {@code customer}. + */ @SerializedName("customer_account") String customerAccount; diff --git a/src/main/java/com/stripe/model/TaxRate.java b/src/main/java/com/stripe/model/TaxRate.java index 88e2a3cde12..af094958079 100644 --- a/src/main/java/com/stripe/model/TaxRate.java +++ b/src/main/java/com/stripe/model/TaxRate.java @@ -115,7 +115,7 @@ public class TaxRate 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. */ diff --git a/src/main/java/com/stripe/model/Token.java b/src/main/java/com/stripe/model/Token.java index c1814270bcd..d603a09e5da 100644 --- a/src/main/java/com/stripe/model/Token.java +++ b/src/main/java/com/stripe/model/Token.java @@ -20,7 +20,7 @@ * Tokenization is the process Stripe uses to collect sensitive card or bank account details, or * personally identifiable information (PII), directly from your customers in a secure manner. A * token representing this information is returned to your server to use. Use our recommended payments integrations to perform this + * href="https://docs.stripe.com/payments">recommended payments integrations to perform this * process on the client-side. This guarantees that no sensitive card data touches your server, and * allows your integration to operate in a PCI-compliant way. * @@ -31,9 +31,9 @@ * Stripe, so we can't determine how it's handled or stored. * *

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, BalanceT /** * Error code explaining reason for top-up failure if available (see the errors section for a list of codes). + * href="https://docs.stripe.com/api#errors">the errors section for a list of codes). */ @SerializedName("failure_code") String failureCode; @@ -89,7 +89,7 @@ public class Topup extends ApiResource implements MetadataStore, BalanceT 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/Transfer.java b/src/main/java/com/stripe/model/Transfer.java index 8d6539754a0..32996fd2fbf 100644 --- a/src/main/java/com/stripe/model/Transfer.java +++ b/src/main/java/com/stripe/model/Transfer.java @@ -24,12 +24,12 @@ * *

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 object, with corresponding payout * endpoints. For more information, read about the transfer/payout split. + * href="https://docs.stripe.com/transfer-payout-split">transfer/payout split. * *

Related guide: Creating separate charges + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">Creating separate charges * and transfers */ @Getter @@ -109,7 +109,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. */ @@ -154,7 +154,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 f96d63971d1..ba6d7135e17 100644 --- a/src/main/java/com/stripe/model/billing/Alert.java +++ b/src/main/java/com/stripe/model/billing/Alert.java @@ -81,7 +81,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; @@ -447,7 +447,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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/billing/CreditBalanceSummary.java b/src/main/java/com/stripe/model/billing/CreditBalanceSummary.java index f26373f9a76..12671a71a7b 100644 --- a/src/main/java/com/stripe/model/billing/CreditBalanceSummary.java +++ b/src/main/java/com/stripe/model/billing/CreditBalanceSummary.java @@ -195,7 +195,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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. */ @@ -301,7 +301,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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/billing/CreditBalanceTransaction.java b/src/main/java/com/stripe/model/billing/CreditBalanceTransaction.java index a3460e16a2e..3f0971a9858 100644 --- a/src/main/java/com/stripe/model/billing/CreditBalanceTransaction.java +++ b/src/main/java/com/stripe/model/billing/CreditBalanceTransaction.java @@ -293,7 +293,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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. */ @@ -463,7 +463,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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/billing/CreditGrant.java b/src/main/java/com/stripe/model/billing/CreditGrant.java index 693ff0dfc34..9c91e991836 100644 --- a/src/main/java/com/stripe/model/billing/CreditGrant.java +++ b/src/main/java/com/stripe/model/billing/CreditGrant.java @@ -65,7 +65,7 @@ public class CreditGrant extends ApiResource implements HasId, MetadataStore customer; - /** ID of the account receiving the billing credits. */ + /** ID of the account representing the customer receiving the billing credits. */ @SerializedName("customer_account") String customerAccount; @@ -90,7 +90,7 @@ public class CreditGrant 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. */ @@ -472,7 +472,7 @@ public static class CustomPricingUnitDetails extends StripeObject implements Has String lookupKey; /** - * Set of key-value pairs that you can + * 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/billing/MeterEvent.java b/src/main/java/com/stripe/model/billing/MeterEvent.java index bd6e5919402..548211f561f 100644 --- a/src/main/java/com/stripe/model/billing/MeterEvent.java +++ b/src/main/java/com/stripe/model/billing/MeterEvent.java @@ -54,7 +54,7 @@ public class MeterEvent extends ApiResource { * The payload of the event. This contains the fields corresponding to a meter's {@code * customer_mapping.event_payload_key} (default is {@code stripe_customer_id}) and {@code * value_settings.event_payload_key} (default is {@code value}). Read more about the payload. + * href="https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes">payload. */ @SerializedName("payload") Map payload; diff --git a/src/main/java/com/stripe/model/billingportal/Configuration.java b/src/main/java/com/stripe/model/billingportal/Configuration.java index 0b40cf7943f..39265c25e8a 100644 --- a/src/main/java/com/stripe/model/billingportal/Configuration.java +++ b/src/main/java/com/stripe/model/billingportal/Configuration.java @@ -53,7 +53,7 @@ public class Configuration extends ApiResource implements HasId, MetadataStoreoverriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ @SerializedName("default_return_url") @@ -86,7 +86,7 @@ public class Configuration 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. */ @@ -434,6 +434,18 @@ public static class CancellationReason extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SubscriptionUpdate extends StripeObject { + /** + * Determines the value to use for the billing cycle anchor on subscription updates. Valid + * values are {@code now} or {@code unchanged}, and the default value is {@code unchanged}. + * Setting the value to {@code now} resets the subscription's billing cycle anchor to the + * current time (in UTC). For more information, see the billing cycle documentation. + * + *

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 discounts; /** - * The subscription item to be + * The subscription item to be * updated through this flow. Currently, only up to one may be specified and subscriptions * with multiple items are not updatable. */ @@ -373,7 +373,7 @@ public static class Discount extends StripeObject { public static class Item extends StripeObject implements HasId { /** * The ID of the subscription + * href="https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id">subscription * item to be updated. */ @Getter(onMethod_ = {@Override}) @@ -383,14 +383,14 @@ public static class Item extends StripeObject implements HasId { /** * The price the customer should subscribe to through this flow. The price must also be * included in the configuration's {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products">{@code * features.subscription_update.products}. */ @SerializedName("price") String price; /** - * Quantity for this item + * Quantity for this item * that the customer should subscribe to through this flow. */ @SerializedName("quantity") diff --git a/src/main/java/com/stripe/model/capital/FinancingOffer.java b/src/main/java/com/stripe/model/capital/FinancingOffer.java index 17204f2c466..e73728ad64d 100644 --- a/src/main/java/com/stripe/model/capital/FinancingOffer.java +++ b/src/main/java/com/stripe/model/capital/FinancingOffer.java @@ -77,7 +77,7 @@ public class FinancingOffer 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. */ @@ -127,7 +127,7 @@ public class FinancingOffer extends ApiResource implements HasId { /** * See financing_type. + * href="https://docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type">financing_type. * *

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) null, (RequestOptions) null); } - /** 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(RequestOptions options) throws StripeException { return retrieve((Map) null, options); } - /** 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(Map params, RequestOptions options) throws StripeException { String path = "/v1/capital/financing_summary"; @@ -74,7 +78,7 @@ public static FinancingSummary retrieve(Map params, RequestOptio return getGlobalResponseGetter().request(request, FinancingSummary.class); } - /** 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( FinancingSummaryRetrieveParams params, RequestOptions options) throws StripeException { String path = "/v1/capital/financing_summary"; diff --git a/src/main/java/com/stripe/model/checkout/Session.java b/src/main/java/com/stripe/model/checkout/Session.java index c0e0b1bc823..da681481858 100644 --- a/src/main/java/com/stripe/model/checkout/Session.java +++ b/src/main/java/com/stripe/model/checkout/Session.java @@ -42,18 +42,18 @@ /** * A Checkout Session represents your customer's session as they pay for one-time purchases or - * subscriptions through Checkout or Payment Links. We recommend creating a + * subscriptions through Checkout or Payment Links. We recommend creating a * new Session each time your customer attempts to pay. * *

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 @@ -118,7 +118,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreinitCheckout on your + * secret with initCheckout on your * front end. */ @SerializedName("client_secret") @@ -265,7 +265,7 @@ public class Session 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. */ @@ -307,7 +307,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreexpire the Checkout Session + * href="https://docs.stripe.com/api/checkout/sessions/expire">expire the Checkout Session * instead. */ @SerializedName("payment_intent") @@ -379,7 +379,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreredirect + * href="https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form">redirect * behavior of embedded sessions. Defaults to {@code always}. * *

One of {@code always}, {@code if_required}, or {@code never}. @@ -405,7 +405,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreexpire the Checkout Session + * href="https://docs.stripe.com/api/checkout/sessions/expire">expire the Checkout Session * instead. */ @SerializedName("setup_intent") @@ -444,7 +444,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreSubscription for Checkout + * The ID of the Subscription for Checkout * Sessions in {@code subscription} mode. */ @SerializedName("subscription") @@ -477,7 +477,7 @@ public class Session extends ApiResource implements HasId, MetadataStoreCustom Domains, the URL + * href="https://docs.stripe.com/payments/checkout/custom-domains">Custom Domains, the URL * will use your subdomain. Otherwise, it’ll use {@code checkout.stripe.com.} This value is only * present when the session is active. */ @@ -1857,7 +1857,7 @@ public static class InvoiceData extends StripeObject { Issuer issuer; /** - * Set of key-value pairs that you can + * 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. */ @@ -2782,11 +2782,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. * @@ -4606,12 +4606,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/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 { 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/delegatedcheckout/RequestedSession.java b/src/main/java/com/stripe/model/delegatedcheckout/RequestedSession.java index 28b50658cd7..d2fb89cb3d5 100644 --- a/src/main/java/com/stripe/model/delegatedcheckout/RequestedSession.java +++ b/src/main/java/com/stripe/model/delegatedcheckout/RequestedSession.java @@ -77,7 +77,7 @@ public class RequestedSession 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. */ @@ -555,6 +555,9 @@ public static class LineItemDetail extends StripeObject { @SerializedName("name") String name; + @SerializedName("product_details") + ProductDetails productDetails; + /** The quantity of the line item. */ @SerializedName("quantity") Long quantity; @@ -566,6 +569,81 @@ public static class LineItemDetail extends StripeObject { /** The per-unit amount of the item before any discounts or taxes are applied. */ @SerializedName("unit_amount") Long unitAmount; + + /** + * For more details about ProductDetails, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class ProductDetails extends StripeObject { + /** Custom attributes for the product. */ + @SerializedName("custom_attributes") + List customAttributes; + + /** The description of the product. */ + @SerializedName("description") + String description; + + /** Disclosures for the product. */ + @SerializedName("disclosures") + List disclosures; + + /** The images of the product. */ + @SerializedName("images") + List images; + + /** The title of the product. */ + @SerializedName("title") + String title; + + /** + * For more details about CustomAttribute, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class CustomAttribute extends StripeObject { + /** The display name of the custom attribute. */ + @SerializedName("display_name") + String displayName; + + /** The value of the custom attribute. */ + @SerializedName("value") + String value; + } + + /** + * For more details about Disclosure, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Disclosure extends StripeObject { + /** The content of the disclosure. */ + @SerializedName("content") + String content; + + /** + * The content type of the disclosure. + * + *

One of {@code link}, {@code markdown}, or {@code plain}. + */ + @SerializedName("content_type") + String contentType; + + /** + * The type of disclosure. + * + *

Equal to {@code disclaimer}. + */ + @SerializedName("type") + String type; + } + } } /** diff --git a/src/main/java/com/stripe/model/entitlements/ActiveEntitlement.java b/src/main/java/com/stripe/model/entitlements/ActiveEntitlement.java index cb052c1f088..c8a5182648e 100644 --- a/src/main/java/com/stripe/model/entitlements/ActiveEntitlement.java +++ b/src/main/java/com/stripe/model/entitlements/ActiveEntitlement.java @@ -24,7 +24,7 @@ @EqualsAndHashCode(callSuper = false) public class ActiveEntitlement extends ApiResource implements HasId { /** - * The Feature that the customer is + * The Feature that the customer is * entitled to. */ @SerializedName("feature") diff --git a/src/main/java/com/stripe/model/financialconnections/Account.java b/src/main/java/com/stripe/model/financialconnections/Account.java index 028c6e63055..9aafea3d42e 100644 --- a/src/main/java/com/stripe/model/financialconnections/Account.java +++ b/src/main/java/com/stripe/model/financialconnections/Account.java @@ -152,7 +152,7 @@ public class Account extends ApiResource implements HasId { /** * The PaymentMethod + * href="https://docs.stripe.com/api/payment_methods/object#payment_method_object-type">PaymentMethod * type(s) that can be created from this account. */ @SerializedName("supported_payment_method_types") @@ -547,7 +547,7 @@ public com.stripe.model.financialconnections.Account unsubscribe( @EqualsAndHashCode(callSuper = false) public static class AccountHolder extends StripeObject { /** - * The ID of the Stripe account this account belongs to. Should only be present if {@code + * The ID of the Stripe account that this account belongs to. Only available when {@code * account_holder.type} is {@code account}. */ @SerializedName("account") @@ -556,8 +556,8 @@ public static class AccountHolder extends StripeObject { ExpandableField account; /** - * ID of the Stripe customer this account belongs to. Present if and only if {@code - * account_holder.type} is {@code customer}. + * The ID for an Account representing a customer that this account belongs to. Only available + * when {@code account_holder.type} is {@code customer}. */ @SerializedName("customer") @Getter(lombok.AccessLevel.NONE) diff --git a/src/main/java/com/stripe/model/financialconnections/Session.java b/src/main/java/com/stripe/model/financialconnections/Session.java index 6fe6f8abe4f..3b7d59116b3 100644 --- a/src/main/java/com/stripe/model/financialconnections/Session.java +++ b/src/main/java/com/stripe/model/financialconnections/Session.java @@ -188,7 +188,7 @@ public static Session retrieve( @EqualsAndHashCode(callSuper = false) public static class AccountHolder extends StripeObject { /** - * The ID of the Stripe account this account belongs to. Should only be present if {@code + * The ID of the Stripe account that this account belongs to. Only available when {@code * account_holder.type} is {@code account}. */ @SerializedName("account") @@ -197,8 +197,8 @@ public static class AccountHolder extends StripeObject { ExpandableField account; /** - * ID of the Stripe customer this account belongs to. Present if and only if {@code - * account_holder.type} is {@code customer}. + * The ID for an Account representing a customer that this account belongs to. Only available + * when {@code account_holder.type} is {@code customer}. */ @SerializedName("customer") @Getter(lombok.AccessLevel.NONE) diff --git a/src/main/java/com/stripe/model/forwarding/Request.java b/src/main/java/com/stripe/model/forwarding/Request.java index da156f4c7e6..383e5b894b3 100644 --- a/src/main/java/com/stripe/model/forwarding/Request.java +++ b/src/main/java/com/stripe/model/forwarding/Request.java @@ -60,7 +60,7 @@ public class Request 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/identity/BlocklistEntry.java b/src/main/java/com/stripe/model/identity/BlocklistEntry.java index 57c1cc6e80d..da181f40119 100644 --- a/src/main/java/com/stripe/model/identity/BlocklistEntry.java +++ b/src/main/java/com/stripe/model/identity/BlocklistEntry.java @@ -27,7 +27,7 @@ * details or facial biometrics. This allows us to compare future verification attempts against * these entries. If a match is found, we categorize the new verification as unverified. * - *

To learn more, see Identity + *

To learn more, see Identity * Verification Blocklist */ @Getter diff --git a/src/main/java/com/stripe/model/identity/VerificationReport.java b/src/main/java/com/stripe/model/identity/VerificationReport.java index 073ef205326..a5acea3ca80 100644 --- a/src/main/java/com/stripe/model/identity/VerificationReport.java +++ b/src/main/java/com/stripe/model/identity/VerificationReport.java @@ -29,12 +29,12 @@ * *

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 @@ -216,7 +216,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") @@ -538,7 +538,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") @@ -553,9 +553,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; @@ -632,7 +632,7 @@ public static class Selfie extends StripeObject { ExpandableField blockedByEntry; /** - * 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") @@ -643,7 +643,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 inside your app. * This client secret expires after 24 hours and can only be used once. Don’t store it, log it, * embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS * enabled on any page that includes the client secret. Refer to our docs on passing the client + * href="https://docs.stripe.com/identity/verification-sessions#client-secret">passing the client * secret to the frontend to learn more. */ @SerializedName("client_secret") @@ -82,7 +82,7 @@ public class VerificationSession extends ApiResource /** * ID of the most recent VerificationReport. Learn more about + * href="https://docs.stripe.com/identity/verification-sessions#results">Learn more about * accessing detailed verification results. */ @SerializedName("last_verification_report") @@ -98,7 +98,7 @@ public class VerificationSession 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. */ @@ -133,7 +133,7 @@ public class VerificationSession extends ApiResource @SerializedName("related_customer") String relatedCustomer; - /** Token referencing a Customer Account resource. */ + /** The ID of the Account representing a customer. */ @SerializedName("related_customer_account") String relatedCustomerAccount; @@ -142,7 +142,7 @@ public class VerificationSession extends ApiResource /** * Status of this VerificationSession. Learn more about the lifecycle of + * href="https://docs.stripe.com/identity/how-sessions-work">Learn more about the lifecycle of * sessions. * *

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 balanceTransactions; /** - * You can create physical or virtual cards that are + * You can create physical or virtual cards that are * issued to cardholders. */ @SerializedName("card") @@ -160,7 +160,7 @@ public class Authorization extends ApiResource MerchantData merchantData; /** - * 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. */ @@ -206,7 +206,7 @@ public class Authorization extends ApiResource String status; /** - * Token object used for this + * Token object used for this * authorization. If a network token was not used for this authorization, this field will be null. */ @SerializedName("token") @@ -215,16 +215,16 @@ public class Authorization extends ApiResource ExpandableField token; /** - * List of transactions associated + * List of transactions associated * with this authorization. */ @SerializedName("transactions") List transactions; /** - * Treasury details related to this + * Treasury details related to this * authorization if it was created on a FinancialAccount. + * href="https://docs.stripe.com/api/treasury/financial_accounts">FinancialAccount. */ @SerializedName("treasury") Treasury treasury; @@ -877,7 +877,7 @@ public static class Fuel extends StripeObject { public static class MerchantData extends StripeObject { /** * A categorization of the seller's type of business. See our merchant categories guide for + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide for * a list of possible values. */ @SerializedName("category") @@ -967,8 +967,8 @@ public static class NetworkData extends StripeObject { public static class PendingRequest extends StripeObject { /** * The additional amount Stripe will hold if the authorization is approved, in the card's currency - * and in the smallest currency + * href="https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency">currency + * and in the smallest currency * unit. */ @SerializedName("amount") @@ -976,7 +976,7 @@ public static class PendingRequest extends StripeObject { /** * Detailed breakdown of amount components. These amounts are denominated in {@code currency} - * and in the smallest currency + * and in the smallest currency * unit. */ @SerializedName("amount_details") @@ -992,7 +992,7 @@ public static class PendingRequest extends StripeObject { /** * If set {@code true}, you may provide amount + * href="https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount">amount * to control how much to hold for the authorization. */ @SerializedName("is_amount_controllable") @@ -1000,7 +1000,7 @@ public static class PendingRequest extends StripeObject { /** * The amount the merchant is requesting to be authorized in the {@code merchant_currency}. The - * amount is in the smallest currency + * amount is in the smallest currency * unit. */ @SerializedName("merchant_amount") @@ -1045,7 +1045,7 @@ public static class AmountDetails extends StripeObject { public static class RequestHistory extends StripeObject { /** * The {@code pending_request.amount} at the time of the request, presented in your card's - * currency and in the smallest + * currency and in the smallest * currency unit. Stripe held this amount from your account to fund the authorization if the * request was approved. */ @@ -1054,7 +1054,7 @@ public static class RequestHistory extends StripeObject { /** * Detailed breakdown of amount components. These amounts are denominated in {@code currency} - * and in the smallest currency + * and in the smallest currency * unit. */ @SerializedName("amount_details") @@ -1089,7 +1089,7 @@ public static class RequestHistory extends StripeObject { /** * The {@code pending_request.merchant_amount} at the time of the request, presented in the * {@code merchant_currency} and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("merchant_amount") Long merchantAmount; @@ -1168,7 +1168,7 @@ public static class AmountDetails extends StripeObject { public static class Treasury extends StripeObject { /** * The array of ReceivedCredits associated + * href="https://docs.stripe.com/api/treasury/received_credits">ReceivedCredits associated * with this authorization */ @SerializedName("received_credits") @@ -1176,14 +1176,14 @@ public static class Treasury extends StripeObject { /** * The array of ReceivedDebits associated + * href="https://docs.stripe.com/api/treasury/received_debits">ReceivedDebits associated * with this authorization */ @SerializedName("received_debits") List receivedDebits; /** - * The Treasury Transaction + * The Treasury Transaction * associated with this authorization */ @SerializedName("transaction") diff --git a/src/main/java/com/stripe/model/issuing/Card.java b/src/main/java/com/stripe/model/issuing/Card.java index 2c21195a2df..880c06ed275 100644 --- a/src/main/java/com/stripe/model/issuing/Card.java +++ b/src/main/java/com/stripe/model/issuing/Card.java @@ -30,7 +30,7 @@ import lombok.Setter; /** - * You can create physical or virtual cards that are + * You can create physical or virtual cards that are * issued to cardholders. */ @Getter @@ -51,10 +51,10 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * An Issuing {@code Cardholder} object represents an individual or business entity who is issued cards. + * href="https://docs.stripe.com/issuing">issued cards. * *

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 { /** * The card's CVC. For security reasons, this is only available for virtual cards, and will be * omitted unless you explicitly request it with the {@code expand} parameter. + * href="https://docs.stripe.com/api/expanding_objects">the {@code expand} parameter. * Additionally, it's only available via the "Retrieve a card" + * href="https://docs.stripe.com/api/issuing/cards/retrieve">"Retrieve a card" * endpoint, not via "List all cards" or any other endpoint. */ @SerializedName("cvc") @@ -119,7 +119,7 @@ public class Card 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. */ @@ -130,9 +130,9 @@ public class Card extends ApiResource implements HasId, MetadataStore { /** * The full unredacted card number. For security reasons, this is only available for virtual * cards, and will be omitted unless you explicitly request it with the {@code expand} parameter. + * href="https://docs.stripe.com/api/expanding_objects">the {@code expand} parameter. * Additionally, it's only available via the "Retrieve a card" + * href="https://docs.stripe.com/api/issuing/cards/retrieve">"Retrieve a card" * endpoint, not via "List all cards" or any other endpoint. */ @SerializedName("number") @@ -591,7 +591,7 @@ public static class Customs extends StripeObject { public static class SpendingControls extends StripeObject { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -609,7 +609,7 @@ public static class SpendingControls extends StripeObject { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -649,14 +649,14 @@ public static class SpendingControls extends StripeObject { public static class SpendingLimit extends StripeObject { /** * Maximum amount allowed to spend per interval. This amount is in the card's currency and in - * the smallest currency unit. + * the smallest currency unit. */ @SerializedName("amount") Long amount; /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") @@ -711,6 +711,10 @@ public static class ApplePay extends StripeObject { */ @SerializedName("ineligible_reason") String ineligibleReason; + + /** Unique identifier for the card in Apple Pay. */ + @SerializedName("primary_account_identifier") + String primaryAccountIdentifier; } /** @@ -733,6 +737,10 @@ public static class GooglePay extends StripeObject { */ @SerializedName("ineligible_reason") String ineligibleReason; + + /** Unique identifier for the card in Google Pay. */ + @SerializedName("primary_account_identifier") + String primaryAccountIdentifier; } } diff --git a/src/main/java/com/stripe/model/issuing/Cardholder.java b/src/main/java/com/stripe/model/issuing/Cardholder.java index 3e0b8556aab..6c0c016ee23 100644 --- a/src/main/java/com/stripe/model/issuing/Cardholder.java +++ b/src/main/java/com/stripe/model/issuing/Cardholder.java @@ -27,10 +27,10 @@ /** * An Issuing {@code Cardholder} object represents an individual or business entity who is issued cards. + * href="https://docs.stripe.com/issuing">issued cards. * *

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, 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. */ @@ -91,7 +91,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStore3D + * cards. See the 3D * Secure documentation for more details. */ @SerializedName("phone_number") @@ -100,7 +100,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStore3D Secure flow and one-time password + * href="https://docs.stripe.com/issuing/3d-secure">3D Secure flow and one-time password * messages sent to the cardholder. */ @SerializedName("preferred_locales") @@ -111,7 +111,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStoredocumentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ @SerializedName("spending_controls") @@ -127,7 +127,7 @@ public class Cardholder extends ApiResource implements HasId, MetadataStoreChoose a cardholder type for + * href="https://docs.stripe.com/issuing/other/choose-cardholder">Choose a cardholder type for * more details. */ @SerializedName("type") @@ -444,9 +444,8 @@ 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 identity_document}. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @Getter(lombok.AccessLevel.NONE) @@ -454,9 +453,8 @@ public static class Document extends StripeObject { ExpandableField back; /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code identity_document}. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") @Getter(lombok.AccessLevel.NONE) @@ -537,7 +535,7 @@ public static class Requirements extends StripeObject { public static class SpendingControls extends StripeObject { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -555,7 +553,7 @@ public static class SpendingControls extends StripeObject { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -588,14 +586,14 @@ public static class SpendingControls extends StripeObject { public static class SpendingLimit extends StripeObject { /** * Maximum amount allowed to spend per interval. This amount is in the card's currency and in - * the smallest currency unit. + * the smallest currency unit. */ @SerializedName("amount") Long amount; /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/model/issuing/CreditUnderwritingRecord.java b/src/main/java/com/stripe/model/issuing/CreditUnderwritingRecord.java index 1ed0ee628cf..7391e4a1c7e 100644 --- a/src/main/java/com/stripe/model/issuing/CreditUnderwritingRecord.java +++ b/src/main/java/com/stripe/model/issuing/CreditUnderwritingRecord.java @@ -30,7 +30,7 @@ * account. * *

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, BalanceTransactionSource { /** * Disputed amount in the card's currency and in the smallest currency unit. Usually the + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. Usually the * amount of the {@code transaction}, but can differ (usually because of currency fluctuation). */ @SerializedName("amount") @@ -92,7 +92,7 @@ public class Dispute extends ApiResource String lossReason; /** - * 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. */ @@ -124,7 +124,7 @@ public class Dispute extends ApiResource ExpandableField transaction; /** - * Treasury details related to this dispute if + * Treasury details related to this dispute if * it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ @SerializedName("treasury") @@ -1002,14 +1002,14 @@ public void setAdditionalDocumentationObject(File expandableObject) { @EqualsAndHashCode(callSuper = false) public static class Treasury extends StripeObject { /** - * The Treasury DebitReversal + * The Treasury DebitReversal * representing this Issuing dispute */ @SerializedName("debit_reversal") String debitReversal; /** - * The Treasury ReceivedDebit + * The Treasury ReceivedDebit * that is being disputed. */ @SerializedName("received_debit") diff --git a/src/main/java/com/stripe/model/issuing/FraudLiabilityDebit.java b/src/main/java/com/stripe/model/issuing/FraudLiabilityDebit.java index c2c7b7faa3d..f9ecf08114e 100644 --- a/src/main/java/com/stripe/model/issuing/FraudLiabilityDebit.java +++ b/src/main/java/com/stripe/model/issuing/FraudLiabilityDebit.java @@ -35,7 +35,7 @@ public class FraudLiabilityDebit extends ApiResource implements HasId { Long amount; /** - * ID of the balance transaction + * ID of the balance transaction * associated with this debit. */ @SerializedName("balance_transaction") diff --git a/src/main/java/com/stripe/model/issuing/PersonalizationDesign.java b/src/main/java/com/stripe/model/issuing/PersonalizationDesign.java index 4fcb050f743..ae1297192a1 100644 --- a/src/main/java/com/stripe/model/issuing/PersonalizationDesign.java +++ b/src/main/java/com/stripe/model/issuing/PersonalizationDesign.java @@ -73,7 +73,7 @@ public class PersonalizationDesign extends ApiResource String lookupKey; /** - * 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/issuing/Program.java b/src/main/java/com/stripe/model/issuing/Program.java index db8c824ee42..e9bb79f3363 100644 --- a/src/main/java/com/stripe/model/issuing/Program.java +++ b/src/main/java/com/stripe/model/issuing/Program.java @@ -41,7 +41,7 @@ public class Program 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. */ diff --git a/src/main/java/com/stripe/model/issuing/Settlement.java b/src/main/java/com/stripe/model/issuing/Settlement.java index a7ddf2f76e6..c08c585ce15 100644 --- a/src/main/java/com/stripe/model/issuing/Settlement.java +++ b/src/main/java/com/stripe/model/issuing/Settlement.java @@ -10,7 +10,7 @@ import lombok.Setter; /** - * When a non-stripe BIN is used, any use of an issued + * When a non-stripe BIN is used, any use of an issued * card must be settled directly with the card network. The net amount owed is represented by an * Issuing {@code Settlement} object. */ @@ -54,7 +54,7 @@ public class Settlement extends StripeObject 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/issuing/Token.java b/src/main/java/com/stripe/model/issuing/Token.java index 4d9f4578230..6dee449d600 100644 --- a/src/main/java/com/stripe/model/issuing/Token.java +++ b/src/main/java/com/stripe/model/issuing/Token.java @@ -23,8 +23,8 @@ /** * An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens + * href="https://docs.stripe.com/issuing">card issuer, you can view and manage these tokens * through Stripe. */ @Getter diff --git a/src/main/java/com/stripe/model/issuing/Transaction.java b/src/main/java/com/stripe/model/issuing/Transaction.java index 0949aabc5f5..f998985c23b 100644 --- a/src/main/java/com/stripe/model/issuing/Transaction.java +++ b/src/main/java/com/stripe/model/issuing/Transaction.java @@ -28,11 +28,11 @@ import lombok.Setter; /** - * Any use of an issued card that results in funds + * Any use of an issued card that results in funds * entering or leaving your Stripe account, such as a completed purchase or refund, is represented * by an Issuing {@code Transaction} object. * - *

Related guide: Issued card + *

Related guide: Issued card * transactions */ @Getter @@ -42,7 +42,7 @@ public class Transaction extends ApiResource implements MetadataStore, BalanceTransactionSource { /** * The transaction amount, which will be reflected in your balance. This amount is in your - * currency and in the smallest currency + * currency and in the smallest currency * unit. */ @SerializedName("amount") @@ -50,7 +50,7 @@ public class Transaction 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; @@ -62,7 +62,7 @@ public class Transaction extends ApiResource ExpandableField authorization; /** - * ID of the balance transaction + * ID of the balance transaction * associated with this transaction. */ @SerializedName("balance_transaction") @@ -113,7 +113,7 @@ public class Transaction extends ApiResource /** * The amount that the merchant will receive, denominated in {@code merchant_currency} and in the - * smallest currency unit. It will + * smallest currency unit. It will * be different from {@code amount} if the merchant is taking payment in a different currency. */ @SerializedName("merchant_amount") @@ -127,7 +127,7 @@ public class Transaction extends ApiResource MerchantData merchantData; /** - * 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. */ @@ -152,7 +152,7 @@ public class Transaction extends ApiResource PurchaseDetails purchaseDetails; /** - * The ID of the settlement to which + * The ID of the settlement to which * this transaction belongs. */ @SerializedName("settlement") @@ -161,7 +161,7 @@ public class Transaction extends ApiResource ExpandableField settlement; /** - * Token object used for this + * Token object used for this * transaction. If a network token was not used for this transaction, this field will be null. */ @SerializedName("token") @@ -170,7 +170,7 @@ public class Transaction extends ApiResource ExpandableField token; /** - * Treasury details related to this transaction + * Treasury details related to this transaction * if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ @SerializedName("treasury") @@ -481,7 +481,7 @@ public static class AmountDetails extends StripeObject { public static class MerchantData extends StripeObject { /** * A categorization of the seller's type of business. See our merchant categories guide for + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide for * a list of possible values. */ @SerializedName("category") @@ -899,14 +899,14 @@ public static class Receipt extends StripeObject { public static class Treasury extends StripeObject { /** * The Treasury ReceivedCredit representing + * href="https://docs.stripe.com/api/treasury/received_credits">ReceivedCredit representing * this Issuing transaction if it is a refund */ @SerializedName("received_credit") String receivedCredit; /** - * The Treasury ReceivedDebit + * The Treasury ReceivedDebit * representing this Issuing transaction if it is a capture */ @SerializedName("received_debit") diff --git a/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java b/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java index e86ccf34326..1ab2f5c3742 100644 --- a/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java +++ b/src/main/java/com/stripe/model/radar/EarlyFraudWarning.java @@ -24,7 +24,7 @@ * An early fraud warning indicates that the card issuer has notified us that a charge may be * fraudulent. * - *

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, 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. */ diff --git a/src/main/java/com/stripe/model/radar/ValueListItem.java b/src/main/java/com/stripe/model/radar/ValueListItem.java index ed9809d4710..e86648905cd 100644 --- a/src/main/java/com/stripe/model/radar/ValueListItem.java +++ b/src/main/java/com/stripe/model/radar/ValueListItem.java @@ -21,7 +21,7 @@ * Value list items allow you to add specific values to a given Radar value list, which can then be * used in rules. * - *

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. */ @Getter @Setter @@ -71,7 +71,7 @@ public class ReportRun extends ApiResource implements HasId { Parameters parameters; /** - * The ID of the report type to run, + * The ID of the report type to run, * such as {@code "balance.summary.1"}. */ @SerializedName("report_type") diff --git a/src/main/java/com/stripe/model/reporting/ReportType.java b/src/main/java/com/stripe/model/reporting/ReportType.java index 7990371fc98..37cc6dabf2b 100644 --- a/src/main/java/com/stripe/model/reporting/ReportType.java +++ b/src/main/java/com/stripe/model/reporting/ReportType.java @@ -21,12 +21,12 @@ * The Report Type resource corresponds to a particular type of report, such as the "Activity * summary" or "Itemized payouts" reports. These objects are identified by an ID * belonging to a set of enumerated values. See API Access to Reports documentation + * href="https://docs.stripe.com/reporting/statements/api">API Access to Reports documentation * for those Report Type IDs, along with required and optional parameters. * *

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 defaultColumns; /** - * The ID of the + * The ID of the * Report Type, such as {@code balance.summary.1}. */ @Getter(onMethod_ = {@Override}) diff --git a/src/main/java/com/stripe/model/sharedpayment/GrantedToken.java b/src/main/java/com/stripe/model/sharedpayment/GrantedToken.java new file mode 100644 index 00000000000..1f1033048b3 --- /dev/null +++ b/src/main/java/com/stripe/model/sharedpayment/GrantedToken.java @@ -0,0 +1,295 @@ +// File generated from our OpenAPI spec +package com.stripe.model.sharedpayment; + +import com.google.gson.annotations.SerializedName; +import com.stripe.exception.StripeException; +import com.stripe.model.HasId; +import com.stripe.model.StripeObject; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.sharedpayment.GrantedTokenCreateParams; +import com.stripe.param.sharedpayment.GrantedTokenRetrieveParams; +import com.stripe.param.sharedpayment.GrantedTokenUpdateParams; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; + +/** + * SharedPaymentGrantedToken is the view-only resource of a SharedPaymentIssuedToken, which is a + * limited-use reference to a PaymentMethod. When another Stripe merchant shares a + * SharedPaymentIssuedToken with you, you can view attributes of the shared token using the + * SharedPaymentGrantedToken API, and use it with a PaymentIntent. + */ +@Getter +@Setter +@EqualsAndHashCode(callSuper = false) +public class GrantedToken extends ApiResource implements HasId { + /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + @SerializedName("created") + Long created; + + /** + * Time at which this SharedPaymentGrantedToken expires and can no longer be used to confirm a + * PaymentIntent. + */ + @SerializedName("deactivated_at") + Long deactivatedAt; + + /** + * The reason why the SharedPaymentGrantedToken has been deactivated. + * + *

One of {@code consumed}, {@code expired}, or {@code revoked}. + */ + @SerializedName("deactivated_reason") + String deactivatedReason; + + /** 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; + + /** + * String representing the object's type. Objects of the same type share the same value. + * + *

Equal to {@code shared_payment.granted_token}. + */ + @SerializedName("object") + String object; + + /** Metadata about the SharedPaymentGrantedToken. */ + @SerializedName("shared_metadata") + Map sharedMetadata; + + /** Some details about how the SharedPaymentGrantedToken has been used already. */ + @SerializedName("usage_details") + UsageDetails usageDetails; + + /** Limits on how this SharedPaymentGrantedToken can be used. */ + @SerializedName("usage_limits") + UsageLimits usageLimits; + + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public static GrantedToken retrieve(String sharedPaymentGrantedToken) throws StripeException { + return retrieve(sharedPaymentGrantedToken, (Map) null, (RequestOptions) null); + } + + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public static GrantedToken retrieve(String sharedPaymentGrantedToken, RequestOptions options) + throws StripeException { + return retrieve(sharedPaymentGrantedToken, (Map) null, options); + } + + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public static GrantedToken retrieve( + String sharedPaymentGrantedToken, Map params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/shared_payment/granted_tokens/%s", + ApiResource.urlEncodeId(sharedPaymentGrantedToken)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options); + return getGlobalResponseGetter().request(request, GrantedToken.class); + } + + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public static GrantedToken retrieve( + String sharedPaymentGrantedToken, GrantedTokenRetrieveParams params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/shared_payment/granted_tokens/%s", + ApiResource.urlEncodeId(sharedPaymentGrantedToken)); + ApiResource.checkNullTypedParams(path, params); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + path, + ApiRequestParams.paramsToMap(params), + options); + return getGlobalResponseGetter().request(request, GrantedToken.class); + } + + /** Some details on how the SharedPaymentGrantedToken has been used so far. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class UsageDetails extends StripeObject { + /** The total amount captured using this SharedPaymentToken. */ + @SerializedName("amount_captured") + AmountCaptured amountCaptured; + + /** A representation of an amount of money, consisting of an amount and a currency. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class AmountCaptured extends StripeObject { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** Integer value of the amount in the smallest currency unit. */ + @SerializedName("value") + Long value; + } + } + + /** Limits on how this SharedPaymentGrantedToken can be used. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class UsageLimits extends StripeObject { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** + * Time at which this SharedPaymentToken expires and can no longer be used to confirm a + * PaymentIntent. + */ + @SerializedName("expires_at") + Long expiresAt; + + /** Max amount that can be captured using this SharedPaymentToken. */ + @SerializedName("max_amount") + Long maxAmount; + } + + public TestHelpers getTestHelpers() { + return new TestHelpers(this); + } + + public static class TestHelpers { + private final GrantedToken resource; + + private TestHelpers(GrantedToken resource) { + this.resource = resource; + } + + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public static GrantedToken create(Map params) throws StripeException { + return create(params, (RequestOptions) null); + } + + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public static GrantedToken create(Map params, RequestOptions options) + throws StripeException { + String path = "/v1/test_helpers/shared_payment/granted_tokens"; + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); + return getGlobalResponseGetter().request(request, GrantedToken.class); + } + + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public static GrantedToken create(GrantedTokenCreateParams params) throws StripeException { + return create(params, (RequestOptions) null); + } + + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public static GrantedToken create(GrantedTokenCreateParams params, RequestOptions options) + throws StripeException { + String path = "/v1/test_helpers/shared_payment/granted_tokens"; + ApiResource.checkNullTypedParams(path, params); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return getGlobalResponseGetter().request(request, GrantedToken.class); + } + + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(Map params) throws StripeException { + return update(params, (RequestOptions) null); + } + + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(Map params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/test_helpers/shared_payment/granted_tokens/%s/revoke", + ApiResource.urlEncodeId(this.resource.getId())); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options); + return resource.getResponseGetter().request(request, GrantedToken.class); + } + + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(GrantedTokenUpdateParams params) throws StripeException { + return update(params, (RequestOptions) null); + } + + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(GrantedTokenUpdateParams params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/test_helpers/shared_payment/granted_tokens/%s/revoke", + ApiResource.urlEncodeId(this.resource.getId())); + ApiResource.checkNullTypedParams(path, params); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return resource.getResponseGetter().request(request, GrantedToken.class); + } + } + + @Override + public void setResponseGetter(StripeResponseGetter responseGetter) { + super.setResponseGetter(responseGetter); + trySetResponseGetter(usageDetails, responseGetter); + trySetResponseGetter(usageLimits, responseGetter); + } +} diff --git a/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java b/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java index a1ca52cdbd0..8267280140f 100644 --- a/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java +++ b/src/main/java/com/stripe/model/sigma/ScheduledQueryRun.java @@ -20,7 +20,7 @@ import lombok.Setter; /** - * If you have scheduled a Sigma + * If you have scheduled a Sigma * query, you'll receive a {@code sigma.scheduled_query_run.created} webhook each time the query * runs. The webhook contains a {@code ScheduledQueryRun} object, which you can use to retrieve the * query results. diff --git a/src/main/java/com/stripe/model/tax/Association.java b/src/main/java/com/stripe/model/tax/Association.java index ec28d2b0d1b..09d9454ff42 100644 --- a/src/main/java/com/stripe/model/tax/Association.java +++ b/src/main/java/com/stripe/model/tax/Association.java @@ -26,7 +26,7 @@ @EqualsAndHashCode(callSuper = false) public class Association extends ApiResource implements HasId { /** - * The Tax Calculation that was + * The Tax Calculation that was * included in PaymentIntent. */ @SerializedName("calculation") @@ -46,7 +46,7 @@ public class Association extends ApiResource implements HasId { String object; /** - * The PaymentIntent that this + * The PaymentIntent that this * Tax Association is tracking. */ @SerializedName("payment_intent") @@ -120,7 +120,7 @@ public static class TaxTransactionAttempt extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Committed extends StripeObject { - /** The Tax Transaction. */ + /** The Tax Transaction. */ @SerializedName("transaction") String transaction; } diff --git a/src/main/java/com/stripe/model/tax/Calculation.java b/src/main/java/com/stripe/model/tax/Calculation.java index 239ee21ba6d..4f2a4219eb2 100644 --- a/src/main/java/com/stripe/model/tax/Calculation.java +++ b/src/main/java/com/stripe/model/tax/Calculation.java @@ -23,7 +23,7 @@ /** * A Tax Calculation allows you to calculate the tax to collect from your customer. * - *

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. */ @SerializedName("amount_total") Long amountTotal; @@ -45,7 +45,7 @@ public class Calculation 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") @@ -410,7 +410,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. */ @@ -419,14 +419,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. */ @SerializedName("amount_tax") Long amountTax; /** * The ID of an existing ShippingRate. + * href="https://docs.stripe.com/api/shipping_rates/object">ShippingRate. */ @SerializedName("shipping_rate") String shippingRate; @@ -445,7 +445,7 @@ public static class ShippingCost extends StripeObject { List taxBreakdown; /** - * The tax code ID used for shipping. + * The tax code ID used for shipping. */ @SerializedName("tax_code") String taxCode; @@ -460,7 +460,7 @@ public static class ShippingCost extends StripeObject { public static class TaxBreakdown extends StripeObject { /** * The amount of tax, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -499,7 +499,7 @@ public static class TaxBreakdown extends StripeObject { /** * The amount on which tax is calculated, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("taxable_amount") Long taxableAmount; @@ -585,7 +585,7 @@ public static class TaxRateDetails extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class TaxBreakdown extends StripeObject { /** - * The amount of tax, in the smallest + * The amount of tax, in the smallest * currency unit. */ @SerializedName("amount") @@ -613,7 +613,7 @@ public static class TaxBreakdown extends StripeObject { /** * The amount on which tax is calculated, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("taxable_amount") Long taxableAmount; @@ -656,7 +656,10 @@ public static class TaxRateDetails extends StripeObject { @SerializedName("rate_type") String rateType; - /** 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/tax/CalculationLineItem.java b/src/main/java/com/stripe/model/tax/CalculationLineItem.java index 157223e51d5..fc64b94fa46 100644 --- a/src/main/java/com/stripe/model/tax/CalculationLineItem.java +++ b/src/main/java/com/stripe/model/tax/CalculationLineItem.java @@ -15,7 +15,7 @@ @EqualsAndHashCode(callSuper = false) public class CalculationLineItem extends StripeObject implements HasId { /** - * The line item amount in the smallest + * The line item 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. */ @@ -24,7 +24,7 @@ public class CalculationLineItem extends StripeObject implements HasId { /** * The amount of tax calculated for this line item, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount_tax") Long amountTax; @@ -42,7 +42,7 @@ public class CalculationLineItem extends StripeObject 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. */ @@ -57,7 +57,7 @@ public class CalculationLineItem extends StripeObject implements HasId { @SerializedName("object") String object; - /** The ID of an existing Product. */ + /** The ID of an existing Product. */ @SerializedName("product") String product; @@ -85,7 +85,7 @@ public class CalculationLineItem extends StripeObject implements HasId { List taxBreakdown; /** - * The tax code ID used for this + * The tax code ID used for this * resource. */ @SerializedName("tax_code") @@ -100,7 +100,7 @@ public class CalculationLineItem extends StripeObject implements HasId { @EqualsAndHashCode(callSuper = false) public static class TaxBreakdown extends StripeObject { /** - * The amount of tax, in the smallest + * The amount of tax, in the smallest * currency unit. */ @SerializedName("amount") @@ -140,7 +140,7 @@ public static class TaxBreakdown extends StripeObject { /** * The amount on which tax is calculated, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("taxable_amount") Long taxableAmount; diff --git a/src/main/java/com/stripe/model/tax/Registration.java b/src/main/java/com/stripe/model/tax/Registration.java index 0e5aa4d4ea7..79c3c4fcfd2 100644 --- a/src/main/java/com/stripe/model/tax/Registration.java +++ b/src/main/java/com/stripe/model/tax/Registration.java @@ -23,14 +23,14 @@ /** * A Tax {@code Registration} lets us know that your business is registered to collect tax on - * payments within a region, enabling you to automatically + * payments within a region, enabling you to automatically * collect tax. * *

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. */ @SerializedName("amount_tax") Long amountTax; /** * The ID of an existing ShippingRate. + * href="https://docs.stripe.com/api/shipping_rates/object">ShippingRate. */ @SerializedName("shipping_rate") String shippingRate; @@ -506,7 +506,7 @@ public static class ShippingCost extends StripeObject { List taxBreakdown; /** - * The tax code ID used for shipping. + * The tax code ID used for shipping. */ @SerializedName("tax_code") String taxCode; @@ -521,7 +521,7 @@ public static class ShippingCost extends StripeObject { public static class TaxBreakdown extends StripeObject { /** * The amount of tax, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -560,7 +560,7 @@ public static class TaxBreakdown extends StripeObject { /** * The amount on which tax is calculated, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("taxable_amount") Long taxableAmount; diff --git a/src/main/java/com/stripe/model/tax/TransactionLineItem.java b/src/main/java/com/stripe/model/tax/TransactionLineItem.java index a3f2fd08600..a6fb325ff88 100644 --- a/src/main/java/com/stripe/model/tax/TransactionLineItem.java +++ b/src/main/java/com/stripe/model/tax/TransactionLineItem.java @@ -14,7 +14,7 @@ @EqualsAndHashCode(callSuper = false) public class TransactionLineItem extends StripeObject implements HasId { /** - * The line item amount in the smallest + * The line item 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. */ @@ -23,7 +23,7 @@ public class TransactionLineItem extends StripeObject implements HasId { /** * The amount of tax calculated for this line item, in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount_tax") Long amountTax; @@ -41,7 +41,7 @@ public class TransactionLineItem extends StripeObject 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. */ @@ -56,7 +56,7 @@ public class TransactionLineItem extends StripeObject implements HasId { @SerializedName("object") String object; - /** The ID of an existing Product. */ + /** The ID of an existing Product. */ @SerializedName("product") String product; @@ -84,7 +84,7 @@ public class TransactionLineItem extends StripeObject implements HasId { String taxBehavior; /** - * The tax code ID used for this + * The tax code ID used for this * resource. */ @SerializedName("tax_code") diff --git a/src/main/java/com/stripe/model/terminal/ConnectionToken.java b/src/main/java/com/stripe/model/terminal/ConnectionToken.java index 9b913e8c018..456aacda17d 100644 --- a/src/main/java/com/stripe/model/terminal/ConnectionToken.java +++ b/src/main/java/com/stripe/model/terminal/ConnectionToken.java @@ -17,7 +17,7 @@ /** * A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * - *

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, 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. */ diff --git a/src/main/java/com/stripe/model/terminal/Reader.java b/src/main/java/com/stripe/model/terminal/Reader.java index ccf2c064aee..35f4ac84333 100644 --- a/src/main/java/com/stripe/model/terminal/Reader.java +++ b/src/main/java/com/stripe/model/terminal/Reader.java @@ -42,7 +42,7 @@ /** * A Reader represents a physical device for accepting payment details. * - *

Related guide: Connecting + *

Related guide: Connecting * to a reader */ @Getter @@ -84,7 +84,11 @@ public class Reader extends ApiResource implements HasId, MetadataStore @SerializedName("label") String label; - /** The last time this reader reported to Stripe backend. */ + /** + * The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds + * since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field + * uses milliseconds. + */ @SerializedName("last_seen_at") Long lastSeenAt; @@ -102,7 +106,7 @@ public class Reader extends ApiResource implements HasId, MetadataStore ExpandableField location; /** - * 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. */ @@ -866,7 +870,7 @@ public static class CollectInputs extends StripeObject { List inputs; /** - * Set of key-value pairs that you can + * 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. */ @@ -1082,11 +1086,11 @@ public static class CollectPaymentMethod extends StripeObject { /** * PaymentMethod objects represent your customer's payment instruments. You can use them with - * PaymentIntents to collect + * PaymentIntents to collect * payments or save them to Customer objects to store instrument details for future payments. * - *

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 charge; /** - * Set of key-value pairs that you can + * 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. */ @@ -1500,14 +1504,14 @@ public static class Cart extends StripeObject { /** * Tax amount for the entire cart. A positive integer in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("tax") Long tax; /** * Total amount for the entire cart, including tax. A positive integer in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("total") Long total; @@ -1519,7 +1523,7 @@ public static class Cart extends StripeObject { public static class LineItem extends StripeObject { /** * The amount of the line item. A positive integer in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; diff --git a/src/main/java/com/stripe/model/treasury/CreditReversal.java b/src/main/java/com/stripe/model/treasury/CreditReversal.java index 7b56f72ce96..2ce933d3fc0 100644 --- a/src/main/java/com/stripe/model/treasury/CreditReversal.java +++ b/src/main/java/com/stripe/model/treasury/CreditReversal.java @@ -21,7 +21,7 @@ import lombok.Setter; /** - * You can reverse some ReceivedCredits + * 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. */ @@ -49,7 +49,7 @@ public class CreditReversal 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. */ @@ -69,7 +69,7 @@ public class CreditReversal 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/treasury/DebitReversal.java b/src/main/java/com/stripe/model/treasury/DebitReversal.java index 0a819f8bed5..f8792d561d6 100644 --- a/src/main/java/com/stripe/model/treasury/DebitReversal.java +++ b/src/main/java/com/stripe/model/treasury/DebitReversal.java @@ -21,7 +21,7 @@ import lombok.Setter; /** - * 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. */ @@ -49,7 +49,7 @@ public class DebitReversal 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. */ @@ -73,7 +73,7 @@ public class DebitReversal 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/treasury/FinancialAccount.java b/src/main/java/com/stripe/model/treasury/FinancialAccount.java index e16eb9eecb7..d32775069d0 100644 --- a/src/main/java/com/stripe/model/treasury/FinancialAccount.java +++ b/src/main/java/com/stripe/model/treasury/FinancialAccount.java @@ -90,7 +90,7 @@ public class FinancialAccount 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. */ diff --git a/src/main/java/com/stripe/model/treasury/InboundTransfer.java b/src/main/java/com/stripe/model/treasury/InboundTransfer.java index 21a29cb2470..12823ff7cf0 100644 --- a/src/main/java/com/stripe/model/treasury/InboundTransfer.java +++ b/src/main/java/com/stripe/model/treasury/InboundTransfer.java @@ -29,9 +29,8 @@ /** * 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 @@ -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. 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 @@ -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. 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 @@ -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 1ab70aab922..cd76fa28834 100644 --- a/src/main/java/com/stripe/model/v2/EventDataClassLookup.java +++ b/src/main/java/com/stripe/model/v2/EventDataClassLookup.java @@ -90,6 +90,8 @@ public final class EventDataClassLookup { classLookup.put( "v2.core.vault.us_bank_account", com.stripe.model.v2.core.vault.UsBankAccount.class); + classLookup.put("v2.iam.api_key", com.stripe.model.v2.iam.ApiKey.class); + classLookup.put( "v2.money_management.adjustment", com.stripe.model.v2.moneymanagement.Adjustment.class); classLookup.put( @@ -139,10 +141,18 @@ public final class EventDataClassLookup { classLookup.put( "v2.payments.off_session_payment", com.stripe.model.v2.payments.OffSessionPayment.class); + classLookup.put( + "v2.payments.settlement_allocation_intent", + com.stripe.model.v2.payments.SettlementAllocationIntent.class); + classLookup.put( + "v2.payments.settlement_allocation_intent_split", + com.stripe.model.v2.payments.SettlementAllocationIntentSplit.class); classLookup.put("v2.reporting.report", com.stripe.model.v2.reporting.Report.class); classLookup.put("v2.reporting.report_run", com.stripe.model.v2.reporting.ReportRun.class); + classLookup.put("v2.tax.manual_rule", com.stripe.model.v2.tax.ManualRule.class); + eventClassLookup.put( "v1.billing.meter.error_report_triggered", com.stripe.events.V1BillingMeterErrorReportTriggeredEvent.class); @@ -369,6 +379,12 @@ public final class EventDataClassLookup { eventClassLookup.put( "v2.core.health.payment_method_error.resolved", com.stripe.events.V2CoreHealthPaymentMethodErrorResolvedEvent.class); + eventClassLookup.put( + "v2.core.health.sepa_debit_delayed.firing", + com.stripe.events.V2CoreHealthSepaDebitDelayedFiringEvent.class); + eventClassLookup.put( + "v2.core.health.sepa_debit_delayed.resolved", + com.stripe.events.V2CoreHealthSepaDebitDelayedResolvedEvent.class); eventClassLookup.put( "v2.core.health.traffic_volume_drop.firing", com.stripe.events.V2CoreHealthTrafficVolumeDropFiringEvent.class); @@ -460,6 +476,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); @@ -529,6 +548,39 @@ public final class EventDataClassLookup { eventClassLookup.put( "v2.payments.off_session_payment.succeeded", com.stripe.events.V2PaymentsOffSessionPaymentSucceededEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.canceled", + com.stripe.events.V2PaymentsSettlementAllocationIntentCanceledEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.created", + com.stripe.events.V2PaymentsSettlementAllocationIntentCreatedEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.errored", + com.stripe.events.V2PaymentsSettlementAllocationIntentErroredEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.funds_not_received", + com.stripe.events.V2PaymentsSettlementAllocationIntentFundsNotReceivedEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.matched", + com.stripe.events.V2PaymentsSettlementAllocationIntentMatchedEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.not_found", + com.stripe.events.V2PaymentsSettlementAllocationIntentNotFoundEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.settled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSettledEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.submitted", + com.stripe.events.V2PaymentsSettlementAllocationIntentSubmittedEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.canceled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitCanceledEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.created", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitCreatedEvent.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.settled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitSettledEvent.class); eventClassLookup.put( "v2.reporting.report_run.created", com.stripe.events.V2ReportingReportRunCreatedEvent.class); diff --git a/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java b/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java index 60c7107a1b6..eaecd71b083 100644 --- a/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java +++ b/src/main/java/com/stripe/model/v2/EventNotificationClassLookup.java @@ -273,6 +273,12 @@ public final class EventNotificationClassLookup { eventClassLookup.put( "v2.core.health.payment_method_error.resolved", com.stripe.events.V2CoreHealthPaymentMethodErrorResolvedEventNotification.class); + eventClassLookup.put( + "v2.core.health.sepa_debit_delayed.firing", + com.stripe.events.V2CoreHealthSepaDebitDelayedFiringEventNotification.class); + eventClassLookup.put( + "v2.core.health.sepa_debit_delayed.resolved", + com.stripe.events.V2CoreHealthSepaDebitDelayedResolvedEventNotification.class); eventClassLookup.put( "v2.core.health.traffic_volume_drop.firing", com.stripe.events.V2CoreHealthTrafficVolumeDropFiringEventNotification.class); @@ -370,6 +376,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); @@ -441,6 +450,40 @@ public final class EventNotificationClassLookup { eventClassLookup.put( "v2.payments.off_session_payment.succeeded", com.stripe.events.V2PaymentsOffSessionPaymentSucceededEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.canceled", + com.stripe.events.V2PaymentsSettlementAllocationIntentCanceledEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.created", + com.stripe.events.V2PaymentsSettlementAllocationIntentCreatedEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.errored", + com.stripe.events.V2PaymentsSettlementAllocationIntentErroredEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.funds_not_received", + com.stripe.events.V2PaymentsSettlementAllocationIntentFundsNotReceivedEventNotification + .class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.matched", + com.stripe.events.V2PaymentsSettlementAllocationIntentMatchedEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.not_found", + com.stripe.events.V2PaymentsSettlementAllocationIntentNotFoundEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.settled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSettledEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent.submitted", + com.stripe.events.V2PaymentsSettlementAllocationIntentSubmittedEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.canceled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.created", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitCreatedEventNotification.class); + eventClassLookup.put( + "v2.payments.settlement_allocation_intent_split.settled", + com.stripe.events.V2PaymentsSettlementAllocationIntentSplitSettledEventNotification.class); eventClassLookup.put( "v2.reporting.report_run.created", com.stripe.events.V2ReportingReportRunCreatedEventNotification.class); diff --git a/src/main/java/com/stripe/model/v2/billing/IntentAction.java b/src/main/java/com/stripe/model/v2/billing/IntentAction.java index 4b5eb752815..20e3b2a0e1f 100644 --- a/src/main/java/com/stripe/model/v2/billing/IntentAction.java +++ b/src/main/java/com/stripe/model/v2/billing/IntentAction.java @@ -156,9 +156,13 @@ public static class MaximumApplications extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Deactivate extends StripeObject { - /** Configuration for the billing details. */ - @SerializedName("billing_details") - BillingDetails billingDetails; + /** + * Allows users to override the collect at behavior. + * + *

One of {@code next_billing_date}, or {@code on_effective_at}. + */ + @SerializedName("collect_at") + String collectAt; /** * When the deactivate action will take effect. If not specified, the default behavior is @@ -179,20 +183,6 @@ public static class Deactivate extends StripeObject { @SerializedName("type") String type; - /** Configuration for the billing details. */ - @Getter - @Setter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails extends StripeObject { - /** - * This controls the proration adjustment for the partial servicing period. - * - *

One of {@code no_adjustment}, or {@code prorated_adjustment}. - */ - @SerializedName("proration_behavior") - String prorationBehavior; - } - /** * When the deactivate action will take effect. If not specified, the default behavior is * on_reserve. @@ -223,9 +213,60 @@ public static class EffectiveAt extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PricingPlanSubscriptionDetails extends StripeObject { + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** ID of the Pricing Plan Subscription to deactivate. */ @SerializedName("pricing_plan_subscription") String pricingPlanSubscription; + + /** Allows users to override the partial period behavior. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Overrides extends StripeObject { + /** Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List + partialPeriodBehaviors; + + /** + * For more details about PartialPeriodBehavior, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior extends StripeObject { + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; + + /** + * Type of the partial period behavior override. + * + *

Equal to {@code license_fee}. + */ + @SerializedName("type") + String type; + + /** Override for the license fee. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee extends StripeObject { + /** + * The proration behavior for the partial servicing period. Defines how we prorate the + * license fee when the user is deactivating. + * + *

One of {@code none}, or {@code prorated}. + */ + @SerializedName("credit_proration_behavior") + String creditProrationBehavior; + } + } + } } } @@ -234,9 +275,13 @@ public static class PricingPlanSubscriptionDetails extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Modify extends StripeObject { - /** Configuration for the billing details. */ - @SerializedName("billing_details") - BillingDetails billingDetails; + /** + * Allows users to override the collect at behavior. + * + *

One of {@code next_billing_date}, or {@code on_effective_at}. + */ + @SerializedName("collect_at") + String collectAt; /** * When the modify action will take effect. If not specified, the default behavior is @@ -257,20 +302,6 @@ public static class Modify extends StripeObject { @SerializedName("type") String type; - /** Configuration for the billing details. */ - @Getter - @Setter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails extends StripeObject { - /** - * This controls the proration adjustment for the partial servicing period. - * - *

One of {@code no_adjustment}, or {@code prorated_adjustment}. - */ - @SerializedName("proration_behavior") - String prorationBehavior; - } - /** * When the modify action will take effect. If not specified, the default behavior is * on_reserve. @@ -313,6 +344,10 @@ public static class PricingPlanSubscriptionDetails extends StripeObject { @SerializedName("new_pricing_plan_version") String newPricingPlanVersion; + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** ID of the Pricing Plan Subscription to modify. */ @SerializedName("pricing_plan_subscription") String pricingPlanSubscription; @@ -337,6 +372,62 @@ public static class ComponentConfiguration extends StripeObject { @SerializedName("quantity") Long quantity; } + + /** Allows users to override the partial period behavior. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Overrides extends StripeObject { + /** Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List + partialPeriodBehaviors; + + /** + * For more details about PartialPeriodBehavior, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior extends StripeObject { + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; + + /** + * Type of the partial period behavior override. + * + *

Equal to {@code license_fee}. + */ + @SerializedName("type") + String type; + + /** Override for the license fee. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee extends StripeObject { + /** + * The proration behavior for the partial servicing period. Defines how we prorate the + * license fee when the user is upgrading. + * + *

One of {@code none}, or {@code prorated}. + */ + @SerializedName("credit_proration_behavior") + String creditProrationBehavior; + + /** + * The proration behavior for the partial servicing period. Defines how we prorate the + * license fee when the user is downgrading. + * + *

One of {@code none}, or {@code prorated}. + */ + @SerializedName("debit_proration_behavior") + String debitProrationBehavior; + } + } + } } } @@ -364,11 +455,12 @@ public static class Remove extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Subscribe extends StripeObject { /** - * Configuration for the billing details. If not specified, see the default behavior for - * individual attributes. + * Allows users to override the collect at behavior. + * + *

One of {@code next_billing_date}, or {@code on_effective_at}. */ - @SerializedName("billing_details") - BillingDetails billingDetails; + @SerializedName("collect_at") + String collectAt; /** * When the subscribe action will take effect. If not specified, the default behavior is @@ -393,23 +485,6 @@ public static class Subscribe extends StripeObject { @SerializedName("v1_subscription_details") V1SubscriptionDetails v1SubscriptionDetails; - /** - * Configuration for the billing details. If not specified, see the default behavior for - * individual attributes. - */ - @Getter - @Setter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails extends StripeObject { - /** - * This controls the proration adjustment for the partial servicing period. - * - *

One of {@code no_adjustment}, or {@code prorated_adjustment}. - */ - @SerializedName("proration_behavior") - String prorationBehavior; - } - /** * When the subscribe action will take effect. If not specified, the default behavior is * on_reserve. @@ -452,6 +527,10 @@ public static class PricingPlanSubscriptionDetails extends StripeObject { @SerializedName("metadata") Map metadata; + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** ID of the Pricing Plan to subscribe to. */ @SerializedName("pricing_plan") String pricingPlan; @@ -487,6 +566,53 @@ public static class ComponentConfiguration extends StripeObject { @SerializedName("quantity") Long quantity; } + + /** Allows users to override the partial period behavior. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Overrides extends StripeObject { + /** Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List + partialPeriodBehaviors; + + /** + * For more details about PartialPeriodBehavior, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior extends StripeObject { + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; + + /** + * Type of the partial period behavior override. + * + *

Equal to {@code license_fee}. + */ + @SerializedName("type") + String type; + + /** Override for the license fee. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee extends StripeObject { + /** + * The proration behavior for the partial servicing period. Defines how we prorate the + * license fee when the user is subscribing. + * + *

One of {@code none}, or {@code prorated}. + */ + @SerializedName("debit_proration_behavior") + String debitProrationBehavior; + } + } + } } /** Details for subscribing to a V1 subscription. */ diff --git a/src/main/java/com/stripe/model/v2/core/Account.java b/src/main/java/com/stripe/model/v2/core/Account.java index e09f07a44a7..65172a9cc6c 100644 --- a/src/main/java/com/stripe/model/v2/core/Account.java +++ b/src/main/java/com/stripe/model/v2/core/Account.java @@ -4,7 +4,6 @@ import com.google.gson.annotations.SerializedName; import com.stripe.model.HasId; import com.stripe.model.StripeObject; -import java.time.Instant; import java.util.List; import java.util.Map; import lombok.EqualsAndHashCode; @@ -20,20 +19,18 @@ @Setter @EqualsAndHashCode(callSuper = false) public class Account extends StripeObject implements HasId { - /** - * Filter only accounts that have all of the configurations specified. If omitted, returns all - * accounts regardless of which configurations they have. - */ + /** The configurations that have been applied to this account. */ @SerializedName("applied_configurations") List appliedConfigurations; - /** A value indicating if the Account has been closed. */ + /** Indicates whether the account has been closed. */ @SerializedName("closed") Boolean closed; /** - * An Account Configuration which allows the Account to take on a key persona across Stripe - * products. + * An Account represents a company, individual, or other entity that a user interacts with. + * Accounts store identity information and one or more configurations that enable product-specific + * capabilities. You can assign configurations at creation or add them later. */ @SerializedName("configuration") Configuration configuration; @@ -50,7 +47,7 @@ public class Account extends StripeObject implements HasId { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("created") - Instant created; + java.time.Instant created; /** * A value indicating the Stripe dashboard this Account has access to. This will depend on which @@ -61,7 +58,7 @@ public class Account extends StripeObject implements HasId { @SerializedName("dashboard") String dashboard; - /** Default values to be used on Account Configurations. */ + /** Default values for settings shared across Account configurations. */ @SerializedName("defaults") Defaults defaults; @@ -119,8 +116,9 @@ public class Account extends StripeObject implements HasId { Requirements requirements; /** - * An Account Configuration which allows the Account to take on a key persona across Stripe - * products. + * An Account represents a company, individual, or other entity that a user interacts with. + * Accounts store identity information and one or more configurations that enable product-specific + * capabilities. You can assign configurations at creation or add them later. */ @Getter @Setter @@ -135,14 +133,20 @@ public static class Configuration extends StripeObject { Customer customer; /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your connected - * accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will be + * the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of + * set. */ @SerializedName("merchant") Merchant merchant; - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ @SerializedName("recipient") Recipient recipient; @@ -159,8 +163,10 @@ public static class Configuration extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class CardCreator extends StripeObject { /** - * Represents the state of the configuration, and can be updated to deactivate or re-apply a - * configuration. + * Indicates whether the card_creator configuration is active. You can deactivate or + * reactivate the card_creator configuration by updating this property. Deactivating the + * configuration by setting this value to false will unrequest all capabilities within the + * configuration. It will not delete any of the configuration's other properties. */ @SerializedName("applied") Boolean applied; @@ -217,10 +223,6 @@ public static class Celtic extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class ChargeCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -231,8 +233,8 @@ public static class ChargeCard 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< @@ -275,10 +277,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SpendCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -289,8 +287,8 @@ public static class SpendCard 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< @@ -347,10 +345,6 @@ public static class CrossRiverBank extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class ChargeCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -361,8 +355,8 @@ public static class ChargeCard 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< @@ -405,10 +399,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SpendCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -419,8 +409,8 @@ public static class SpendCard 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< @@ -479,10 +469,6 @@ public static class Lead extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PrepaidCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -493,8 +479,8 @@ public static class PrepaidCard 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< @@ -551,10 +537,6 @@ public static class Stripe extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class ChargeCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -565,8 +547,8 @@ public static class ChargeCard 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< @@ -609,10 +591,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PrepaidCard extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -623,8 +601,8 @@ public static class PrepaidCard 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< @@ -672,24 +650,23 @@ public static class StatusDetail extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Customer extends StripeObject { /** - * Represents the state of the configuration, and can be updated to deactivate or re-apply a - * configuration. + * Indicates whether the customer configuration is active. You can deactivate or reactivate + * the customer configuration by updating this property. Deactivating the configuration by + * setting this value to false will unrequest all capabilities within the configuration. It + * will not delete any of the configuration's other properties. */ @SerializedName("applied") Boolean applied; /** - * Automatic indirect tax settings to be used when automatic tax calculation is enabled on the - * customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if - * automatic tax calculation is possible given the current customer location information. + * Settings for automatic indirect tax calculation on the customer's invoices, subscriptions, + * Checkout Sessions, and Payment Links. Available when automatic tax calculation is available + * for the customer account's location. */ @SerializedName("automatic_indirect_tax") AutomaticIndirectTax automaticIndirectTax; - /** - * 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. */ @SerializedName("billing") Billing billing; @@ -709,18 +686,18 @@ public static class Customer extends StripeObject { String testClock; /** - * Automatic indirect tax settings to be used when automatic tax calculation is enabled on the - * customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if - * automatic tax calculation is possible given the current customer location information. + * Settings for automatic indirect tax calculation on the customer's invoices, subscriptions, + * Checkout Sessions, and Payment Links. Available when automatic tax calculation is available + * for the customer account's location. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class AutomaticIndirectTax extends StripeObject { /** - * Describes the customer's tax exemption status, which is {@code none}, {@code exempt}, or - * {@code reverse}. When set to reverse, invoice and receipt PDFs include the following - * text: “Reverse charge”. + * The customer account's tax exemption status: {@code none}, {@code exempt}, or {@code + * reverse}. When {@code reverse}, invoice and receipt PDFs include "Reverse + * charge". * *

One of {@code exempt}, {@code none}, or {@code reverse}. */ @@ -734,17 +711,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}. @@ -753,10 +729,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 @@ -772,26 +747,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) @@ -803,22 +775,22 @@ public static class Invoice extends StripeObject { @SerializedName("custom_fields") List customFields; - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ @SerializedName("footer") String footer; - /** The sequence to be used on the customer's next invoice. Defaults to 1. */ + /** Sequence number to use on the customer account's next invoice. Defaults to 1. */ @SerializedName("next_sequence") Long nextSequence; /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ @SerializedName("prefix") String prefix; - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ @SerializedName("rendering") Rendering rendering; @@ -842,16 +814,17 @@ public static class CustomField extends StripeObject { String value; } - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Rendering extends StripeObject { /** - * How line-item prices and amounts will be displayed with respect to tax on invoice - * PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include - * inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will - * exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. + * Indicates whether displayed line item prices and amounts on invoice PDFs include + * inclusive tax amounts. Must be either {@code include_inclusive_tax} or {@code + * exclude_tax}. + * + *

One of {@code exclude_tax}, or {@code include_inclusive_tax}. */ @SerializedName("amount_tax_display") String amountTaxDisplay; @@ -885,10 +858,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. * @@ -898,8 +867,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 @@ -989,22 +958,25 @@ public static class Address extends StripeObject { } /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your connected - * accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will be + * the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of + * set. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Merchant extends StripeObject { /** - * Represents the state of the configuration, and can be updated to deactivate or re-apply a - * configuration. + * Indicates whether the merchant configuration is active. You can deactivate or reactivate + * the merchant configuration by updating this property. Deactivating the configuration by + * setting this value to false doesn't delete the configuration's properties. */ @SerializedName("applied") Boolean applied; - /** Settings used for Bacs debit payments. */ + /** Settings for Bacs Direct Debit payments. */ @SerializedName("bacs_debit_payments") BacsDebitPayments bacsDebitPayments; @@ -1028,8 +1000,8 @@ public static class Merchant extends StripeObject { KonbiniPayments konbiniPayments; /** - * The merchant category code for the merchant. MCCs are used to classify businesses based on - * the goods or services they provide. + * The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the + * goods or services they provide. */ @SerializedName("mcc") String mcc; @@ -1038,7 +1010,7 @@ public static class Merchant extends StripeObject { @SerializedName("script_statement_descriptor") ScriptStatementDescriptor scriptStatementDescriptor; - /** Settings used for SEPA debit payments. */ + /** Settings for SEPA Direct Debit payments. */ @SerializedName("sepa_debit_payments") SepaDebitPayments sepaDebitPayments; @@ -1050,16 +1022,16 @@ public static class Merchant extends StripeObject { @SerializedName("support") Support support; - /** Settings used for Bacs debit payments. */ + /** Settings for Bacs Direct Debit payments. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class BacsDebitPayments extends StripeObject { - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ @SerializedName("display_name") String displayName; - /** Service user number for Bacs debit payments. */ + /** Service User Number (SUN) for Bacs Direct Debit payments. */ @SerializedName("service_user_number") String serviceUserNumber; } @@ -1286,10 +1258,6 @@ public static class Capabilities extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AchDebitPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1299,8 +1267,8 @@ public static class AchDebitPayments 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 @@ -1341,10 +1309,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AcssDebitPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1354,8 +1318,8 @@ public static class AcssDebitPayments 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 @@ -1396,10 +1360,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AffirmPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1409,8 +1369,8 @@ public static class AffirmPayments 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 @@ -1451,10 +1411,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AfterpayClearpayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1464,8 +1420,8 @@ public static class AfterpayClearpayPayments 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 @@ -1506,10 +1462,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AlmaPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1519,8 +1471,8 @@ public static class AlmaPayments 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 statusDetails; @@ -1560,10 +1512,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AmazonPayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1573,8 +1521,8 @@ public static class AmazonPayPayments 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 @@ -1615,10 +1563,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AuBecsDebitPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1628,8 +1572,8 @@ public static class AuBecsDebitPayments 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 @@ -1670,10 +1614,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BacsDebitPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1683,8 +1623,8 @@ public static class BacsDebitPayments 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 @@ -1725,10 +1665,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BancontactPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1738,8 +1674,8 @@ public static class BancontactPayments 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 @@ -1780,10 +1716,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BlikPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1793,8 +1725,8 @@ public static class BlikPayments 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 statusDetails; @@ -1834,10 +1766,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BoletoPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1847,8 +1775,8 @@ public static class BoletoPayments 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 @@ -1889,10 +1817,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class CardPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1902,8 +1826,8 @@ public static class CardPayments 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 statusDetails; @@ -1943,10 +1867,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class CartesBancairesPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -1956,8 +1876,8 @@ public static class CartesBancairesPayments 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 @@ -1998,10 +1918,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class CashappPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2011,8 +1927,8 @@ public static class CashappPayments 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 @@ -2053,10 +1969,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class EpsPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2066,8 +1978,8 @@ public static class EpsPayments 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 statusDetails; @@ -2107,10 +2019,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class FpxPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2120,8 +2028,8 @@ public static class FpxPayments 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 statusDetails; @@ -2161,10 +2069,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class GbBankTransferPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2174,8 +2078,8 @@ public static class GbBankTransferPayments 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 @@ -2216,10 +2120,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class GrabpayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2229,8 +2129,8 @@ public static class GrabpayPayments 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 @@ -2271,10 +2171,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class IdealPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2284,8 +2180,8 @@ public static class IdealPayments 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 @@ -2326,10 +2222,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class JcbPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2339,8 +2231,8 @@ public static class JcbPayments 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 statusDetails; @@ -2380,10 +2272,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class JpBankTransferPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2393,8 +2281,8 @@ public static class JpBankTransferPayments 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 @@ -2435,10 +2323,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class KakaoPayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2448,8 +2332,8 @@ public static class KakaoPayPayments 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 @@ -2490,10 +2374,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class KlarnaPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2503,8 +2383,8 @@ public static class KlarnaPayments 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 @@ -2545,10 +2425,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class KonbiniPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2558,8 +2434,8 @@ public static class KonbiniPayments 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 @@ -2600,10 +2476,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class KrCardPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2613,8 +2485,8 @@ public static class KrCardPayments 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 @@ -2655,10 +2527,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class LinkPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2668,8 +2536,8 @@ public static class LinkPayments 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 statusDetails; @@ -2709,10 +2577,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class MobilepayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2722,8 +2586,8 @@ public static class MobilepayPayments 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 @@ -2764,10 +2628,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class MultibancoPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2777,8 +2637,8 @@ public static class MultibancoPayments 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 @@ -2819,10 +2679,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class MxBankTransferPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2832,8 +2688,8 @@ public static class MxBankTransferPayments 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 @@ -2874,10 +2730,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class NaverPayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2887,8 +2739,8 @@ public static class NaverPayPayments 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 @@ -2929,10 +2781,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class OxxoPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2942,8 +2790,8 @@ public static class OxxoPayments 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 statusDetails; @@ -2983,10 +2831,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class P24Payments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -2996,8 +2840,8 @@ public static class P24Payments 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 statusDetails; @@ -3037,10 +2881,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PayByBankPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3050,8 +2890,8 @@ public static class PayByBankPayments 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 @@ -3092,10 +2932,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PaycoPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3105,8 +2941,8 @@ public static class PaycoPayments 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 @@ -3147,10 +2983,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PaynowPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3160,8 +2992,8 @@ public static class PaynowPayments 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 @@ -3202,10 +3034,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class PromptpayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3215,8 +3043,8 @@ public static class PromptpayPayments 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 @@ -3257,10 +3085,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class RevolutPayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3270,8 +3094,8 @@ public static class RevolutPayPayments 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 @@ -3312,10 +3136,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SamsungPayPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3325,8 +3145,8 @@ public static class SamsungPayPayments 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 @@ -3367,10 +3187,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SepaBankTransferPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3380,8 +3196,8 @@ public static class SepaBankTransferPayments 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 @@ -3422,10 +3238,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SepaDebitPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3435,8 +3247,8 @@ public static class SepaDebitPayments 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 @@ -3477,19 +3289,15 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class StripeBalance extends StripeObject { - /** Allows the account to do payouts using their Stripe Balance (/v1/balance). */ + /** Enables this Account to complete payouts from their Stripe Balance (/v1/balance). */ @SerializedName("payouts") Payouts payouts; - /** Allows the account to do payouts using their Stripe Balance (/v1/balance). */ + /** Enables this Account to complete payouts from their Stripe Balance (/v1/balance). */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Payouts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3500,8 +3308,8 @@ public static class Payouts 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 @@ -3543,10 +3351,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class SwishPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3556,8 +3360,8 @@ public static class SwishPayments 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 @@ -3598,10 +3402,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class TwintPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3611,8 +3411,8 @@ public static class TwintPayments 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 @@ -3653,10 +3453,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class UsBankTransferPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3666,8 +3462,8 @@ public static class UsBankTransferPayments 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 @@ -3708,10 +3504,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class ZipPayments extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -3721,8 +3513,8 @@ public static class ZipPayments 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 statusDetails; @@ -3929,12 +3721,12 @@ public static class Kanji extends StripeObject { } } - /** Settings used for SEPA debit payments. */ + /** Settings for SEPA Direct Debit payments. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class SepaDebitPayments extends StripeObject { - /** Creditor ID for SEPA debit payments. */ + /** Creditor ID for SEPA Direct Debit payments. */ @SerializedName("creditor_id") String creditorId; } @@ -4021,21 +3813,27 @@ public static class Address extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } } } - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Recipient extends StripeObject { /** - * Represents the state of the configuration, and can be updated to deactivate or re-apply a - * configuration. + * Indicates whether the recipient configuration is active. You can deactivate or reactivate + * the recipient configuration by updating this property. Deactivating the configuration by + * setting this value to false unrequest all capabilities within the configuration. It will + * not delete any of the configuration's other properties. */ @SerializedName("applied") Boolean applied; @@ -4060,11 +3858,11 @@ public static class Capabilities extends StripeObject { @SerializedName("bank_accounts") BankAccounts bankAccounts; - /** Capability that enable OutboundPayments to a debit card linked to this Account. */ + /** Enables this Account to receive OutboundPayments to a linked debit card. */ @SerializedName("cards") Cards cards; - /** Capability that enable OutboundPayments to a crypto wallet linked to this Account. */ + /** Enables this Account to receive OutboundPayments to a linked crypto wallet. */ @SerializedName("crypto_wallets") CryptoWallets cryptoWallets; @@ -4077,6 +3875,14 @@ public static class Capabilities extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BankAccounts extends StripeObject { + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real time + * rails. + */ + @SerializedName("instant") + com.stripe.model.v2.core.Account.Configuration.Recipient.Capabilities.BankAccounts.Instant + instant; + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -4088,6 +3894,61 @@ public static class BankAccounts extends StripeObject { @SerializedName("wire") Wire wire; + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real time + * rails. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Instant extends StripeObject { + /** + * The status of the Capability. + * + *

One of {@code active}, {@code pending}, {@code restricted}, or {@code + * unsupported}. + */ + @SerializedName("status") + String status; + + /** + * Additional details about the capability's status. This value is empty when {@code + * status} is {@code active}. + */ + @SerializedName("status_details") + List + statusDetails; + + /** + * For more details about StatusDetail, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class StatusDetail extends StripeObject { + /** + * Machine-readable code explaining the reason for the Capability to be in its current + * status. + * + *

One of {@code determining_status}, {@code requirements_past_due}, {@code + * requirements_pending_verification}, {@code restricted_other}, {@code + * unsupported_business}, {@code unsupported_country}, or {@code + * unsupported_entity_type}. + */ + @SerializedName("code") + String code; + + /** + * Machine-readable code explaining how to make the Capability active. + * + *

One of {@code contact_stripe}, {@code no_resolution}, or {@code provide_info}. + */ + @SerializedName("resolution") + String resolution; + } + } + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -4096,10 +3957,6 @@ public static class BankAccounts extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Local extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4110,8 +3967,8 @@ public static class Local 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 @@ -4152,10 +4009,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Wire extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4166,8 +4019,8 @@ public static class Wire 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 @@ -4204,15 +4057,11 @@ public static class StatusDetail extends StripeObject { } } - /** Capability that enable OutboundPayments to a debit card linked to this Account. */ + /** Enables this Account to receive OutboundPayments to a linked debit card. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Cards extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4222,8 +4071,8 @@ public static class Cards 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 statusDetails; @@ -4258,15 +4107,11 @@ public static class StatusDetail extends StripeObject { } } - /** Capability that enable OutboundPayments to a crypto wallet linked to this Account. */ + /** Enables this Account to receive OutboundPayments to a linked crypto wallet. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class CryptoWallets extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4276,8 +4121,8 @@ public static class CryptoWallets 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 @@ -4318,25 +4163,21 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class StripeBalance extends StripeObject { - /** Allows the account to do payouts using their Stripe Balance (/v1/balance). */ + /** Enables this Account to complete payouts from their Stripe Balance (/v1/balance). */ @SerializedName("payouts") Payouts payouts; /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). */ @SerializedName("stripe_transfers") StripeTransfers stripeTransfers; - /** Allows the account to do payouts using their Stripe Balance (/v1/balance). */ + /** Enables this Account to complete payouts from their Stripe Balance (/v1/balance). */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Payouts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4347,8 +4188,8 @@ public static class Payouts 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 @@ -4385,16 +4226,12 @@ public static class StatusDetail extends StripeObject { } /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class StripeTransfers extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4405,8 +4242,8 @@ public static class StripeTransfers 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< @@ -4462,26 +4299,31 @@ public static class DefaultOutboundDestination extends StripeObject implements H /** * Closed Enum. The payout method type of the default outbound destination. * - *

One of {@code at_bank_account}, {@code au_bank_account}, {@code ba_bank_account}, - * {@code be_bank_account}, {@code bg_bank_account}, {@code bj_bank_account}, {@code - * bs_bank_account}, {@code card}, {@code ca_bank_account}, {@code ch_bank_account}, {@code - * ci_bank_account}, {@code crypto_wallet}, {@code cy_bank_account}, {@code - * cz_bank_account}, {@code de_bank_account}, {@code dk_bank_account}, {@code - * ec_bank_account}, {@code ee_bank_account}, {@code es_bank_account}, {@code - * et_bank_account}, {@code fi_bank_account}, {@code fr_bank_account}, {@code - * gb_bank_account}, {@code gr_bank_account}, {@code hr_bank_account}, {@code + *

One of {@code al_bank_account}, {@code am_bank_account}, {@code at_bank_account}, + * {@code au_bank_account}, {@code ba_bank_account}, {@code be_bank_account}, {@code + * bg_bank_account}, {@code bj_bank_account}, {@code bn_bank_account}, {@code + * bs_bank_account}, {@code bw_bank_account}, {@code card}, {@code ca_bank_account}, {@code + * ch_bank_account}, {@code ci_bank_account}, {@code crypto_wallet}, {@code + * cy_bank_account}, {@code cz_bank_account}, {@code de_bank_account}, {@code + * dk_bank_account}, {@code dz_bank_account}, {@code ec_bank_account}, {@code + * ee_bank_account}, {@code es_bank_account}, {@code et_bank_account}, {@code + * fi_bank_account}, {@code fr_bank_account}, {@code gb_bank_account}, {@code + * gr_bank_account}, {@code gy_bank_account}, {@code hr_bank_account}, {@code * hu_bank_account}, {@code id_bank_account}, {@code ie_bank_account}, {@code * il_bank_account}, {@code in_bank_account}, {@code is_bank_account}, {@code - * it_bank_account}, {@code ke_bank_account}, {@code li_bank_account}, {@code - * lt_bank_account}, {@code lu_bank_account}, {@code lv_bank_account}, {@code - * mn_bank_account}, {@code mt_bank_account}, {@code mu_bank_account}, {@code - * mx_bank_account}, {@code na_bank_account}, {@code nl_bank_account}, {@code - * no_bank_account}, {@code nz_bank_account}, {@code pa_bank_account}, {@code + * it_bank_account}, {@code jm_bank_account}, {@code jo_bank_account}, {@code + * ke_bank_account}, {@code kw_bank_account}, {@code li_bank_account}, {@code + * lk_bank_account}, {@code lt_bank_account}, {@code lu_bank_account}, {@code + * lv_bank_account}, {@code ma_bank_account}, {@code mn_bank_account}, {@code + * mt_bank_account}, {@code mu_bank_account}, {@code mx_bank_account}, {@code + * na_bank_account}, {@code nl_bank_account}, {@code no_bank_account}, {@code + * nz_bank_account}, {@code om_bank_account}, {@code pa_bank_account}, {@code * ph_bank_account}, {@code pl_bank_account}, {@code pt_bank_account}, {@code * ro_bank_account}, {@code rs_bank_account}, {@code se_bank_account}, {@code * sg_bank_account}, {@code si_bank_account}, {@code sk_bank_account}, {@code * sn_bank_account}, {@code sv_bank_account}, {@code tn_bank_account}, {@code - * tr_bank_account}, {@code us_bank_account}, or {@code za_bank_account}. + * tr_bank_account}, {@code tz_bank_account}, {@code us_bank_account}, or {@code + * za_bank_account}. */ @SerializedName("type") String type; @@ -4497,8 +4339,8 @@ public static class DefaultOutboundDestination extends StripeObject implements H @EqualsAndHashCode(callSuper = false) public static class Storer extends StripeObject { /** - * Represents the state of the configuration, and can be updated to deactivate or re-apply a - * configuration. + * Indicates whether the storer configuration is active. You cannot deactivate (or reactivate) + * the storer configuration by updating this property. */ @SerializedName("applied") Boolean applied; @@ -4511,7 +4353,7 @@ public static class Storer extends StripeObject { @SerializedName("high_risk_activities") List highRiskActivities; - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ @SerializedName("high_risk_activities_description") String highRiskActivitiesDescription; @@ -4519,7 +4361,7 @@ public static class Storer extends StripeObject { @SerializedName("money_services_description") String moneyServicesDescription; - /** Does the business operate in any prohibited countries. */ + /** Indicates whether the business operates in any prohibited countries. */ @SerializedName("operates_in_prohibited_countries") Boolean operatesInProhibitedCountries; @@ -4575,15 +4417,21 @@ public static class Capabilities extends StripeObject { @SerializedName("holds_currencies") HoldsCurrencies holdsCurrencies; - /** Can pull funds from an external source, owned by yourself, to a FinancialAccount. */ + /** Hash containing capabilities related to InboundTransfers. */ @SerializedName("inbound_transfers") InboundTransfers inboundTransfers; - /** Can send funds from a FinancialAccount to a destination owned by someone else. */ + /** + * Hash containing capabilities related to OutboundPayments. + */ @SerializedName("outbound_payments") OutboundPayments outboundPayments; - /** Can send funds from a FinancialAccount to a destination owned by yourself. */ + /** + * Hash containing capabilities related to OutboundTransfers. + */ @SerializedName("outbound_transfers") OutboundTransfers outboundTransfers; @@ -4611,10 +4459,6 @@ public static class FinancialAddresses extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class BankAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4625,8 +4469,8 @@ public static class BankAccounts 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< @@ -4669,10 +4513,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class CryptoWallets extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4683,8 +4523,8 @@ public static class CryptoWallets 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< @@ -4749,10 +4589,6 @@ public static class HoldsCurrencies extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Eur extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4763,8 +4599,8 @@ public static class Eur 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 @@ -4805,10 +4641,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Gbp extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4819,8 +4651,8 @@ public static class Gbp 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 @@ -4861,10 +4693,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Usd extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4875,8 +4703,8 @@ public static class Usd 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 @@ -4917,10 +4745,6 @@ public static class StatusDetail extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Usdc extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -4931,8 +4755,8 @@ public static class Usdc 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 @@ -4969,28 +4793,24 @@ public static class StatusDetail extends StripeObject { } } - /** Can pull funds from an external source, owned by yourself, to a FinancialAccount. */ + /** Hash containing capabilities related to InboundTransfers. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class InboundTransfers extends StripeObject { /** - * Can pull funds from an external bank account, owned by yourself, to a FinancialAccount. + * Can pull funds into a FinancialAccount from an external bank account owned by the user. */ @SerializedName("bank_accounts") BankAccounts bankAccounts; /** - * Can pull funds from an external bank account, owned by yourself, to a FinancialAccount. + * Can pull funds into a FinancialAccount from an external bank account owned by the user. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class BankAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5001,8 +4821,8 @@ public static class BankAccounts 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< @@ -5041,39 +4861,44 @@ public static class StatusDetail extends StripeObject { } } - /** Can send funds from a FinancialAccount to a destination owned by someone else. */ + /** + * Hash containing capabilities related to OutboundPayments. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class OutboundPayments extends StripeObject { - /** Can send funds from a FinancialAccount to a bank account, owned by someone else. */ + /** + * Can send funds from a FinancialAccount to a bank account owned by a different entity. + */ @SerializedName("bank_accounts") BankAccounts bankAccounts; - /** Can send funds from a FinancialAccount to a debit card, owned by someone else. */ + /** Can send funds from a FinancialAccount to a debit card owned by a different entity. */ @SerializedName("cards") Cards cards; - /** Can send funds from a FinancialAccount to a crypto wallet, owned by someone else. */ + /** + * Can send funds from a FinancialAccount to a crypto wallet owned by a different entity. + */ @SerializedName("crypto_wallets") CryptoWallets cryptoWallets; /** - * Can send funds from a FinancialAccount to another FinancialAccount, owned by someone - * else. + * Can send funds from a FinancialAccount to a FinancialAccount owned by a different + * entity. */ @SerializedName("financial_accounts") FinancialAccounts financialAccounts; - /** Can send funds from a FinancialAccount to a bank account, owned by someone else. */ + /** + * Can send funds from a FinancialAccount to a bank account owned by a different entity. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class BankAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5084,8 +4909,8 @@ public static class BankAccounts 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< @@ -5123,15 +4948,11 @@ public static class StatusDetail extends StripeObject { } } - /** Can send funds from a FinancialAccount to a debit card, owned by someone else. */ + /** Can send funds from a FinancialAccount to a debit card owned by a different entity. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class Cards extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5142,8 +4963,8 @@ public static class Cards 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 @@ -5179,15 +5000,13 @@ public static class StatusDetail extends StripeObject { } } - /** Can send funds from a FinancialAccount to a crypto wallet, owned by someone else. */ + /** + * Can send funds from a FinancialAccount to a crypto wallet owned by a different entity. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class CryptoWallets extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5198,8 +5017,8 @@ public static class CryptoWallets 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< @@ -5238,17 +5057,13 @@ public static class StatusDetail extends StripeObject { } /** - * Can send funds from a FinancialAccount to another FinancialAccount, owned by someone - * else. + * Can send funds from a FinancialAccount to a FinancialAccount owned by a different + * entity. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class FinancialAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5259,8 +5074,8 @@ public static class FinancialAccounts 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< @@ -5299,34 +5114,40 @@ public static class StatusDetail extends StripeObject { } } - /** Can send funds from a FinancialAccount to a destination owned by yourself. */ + /** + * Hash containing capabilities related to OutboundTransfers. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class OutboundTransfers extends StripeObject { - /** Can send funds from a FinancialAccount, to a bank account, owned by yourself. */ + /** + * Can send funds from a FinancialAccount to a bank account belonging to the same user. + */ @SerializedName("bank_accounts") BankAccounts bankAccounts; - /** Can send funds from a FinancialAccount to a crypto wallet, owned by yourself. */ + /** + * Can send funds from a FinancialAccount to a crypto wallet belonging to the same user. + */ @SerializedName("crypto_wallets") CryptoWallets cryptoWallets; /** - * Can send funds from a FinancialAccount to another FinancialAccount, owned by yourself. + * Can send funds from a FinancialAccount to another FinancialAccount belonging to the + * same user. */ @SerializedName("financial_accounts") FinancialAccounts financialAccounts; - /** Can send funds from a FinancialAccount, to a bank account, owned by yourself. */ + /** + * Can send funds from a FinancialAccount to a bank account belonging to the same user. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class BankAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5337,8 +5158,8 @@ public static class BankAccounts 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< @@ -5376,15 +5197,13 @@ public static class StatusDetail extends StripeObject { } } - /** Can send funds from a FinancialAccount to a crypto wallet, owned by yourself. */ + /** + * Can send funds from a FinancialAccount to a crypto wallet belonging to the same user. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class CryptoWallets extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5395,8 +5214,8 @@ public static class CryptoWallets 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< @@ -5435,16 +5254,13 @@ public static class StatusDetail extends StripeObject { } /** - * Can send funds from a FinancialAccount to another FinancialAccount, owned by yourself. + * Can send funds from a FinancialAccount to another FinancialAccount belonging to the + * same user. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class FinancialAccounts extends StripeObject { - /** Whether the Capability has been requested. */ - @SerializedName("requested") - Boolean requested; - /** * The status of the Capability. * @@ -5455,8 +5271,8 @@ public static class FinancialAccounts 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< @@ -5530,7 +5346,7 @@ public static class RegulatedActivity extends StripeObject { } } - /** Default values to be used on Account Configurations. */ + /** Default values for settings shared across Account configurations. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -5564,7 +5380,7 @@ public static class Profile extends StripeObject { @SerializedName("business_url") String businessUrl; - /** The company’s legal name. */ + /** The customer-facing business name. */ @SerializedName("doing_business_as") String doingBusinessAs; @@ -5582,8 +5398,8 @@ public static class Profile extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Responsibilities extends StripeObject { /** - * A value indicating the responsible payer of a bundle of Stripe fees for pricing-control - * eligible products on this Account. + * Indicates whether the platform or connected account is responsible for paying Stripe fees + * for pricing-control-eligible products. * *

One of {@code application}, {@code application_custom}, {@code application_express}, or * {@code stripe}. @@ -5592,8 +5408,7 @@ public static class Responsibilities extends StripeObject { String feesCollector; /** - * A value indicating who is responsible for losses when this Account can’t pay back negative - * balances from payments. + * A value indicating responsibility for collecting requirements on this account. * *

One of {@code application}, or {@code stripe}. */ @@ -5624,7 +5439,7 @@ public static class FutureRequirements extends StripeObject { /** The time at which the future requirements become effective. */ @SerializedName("minimum_transition_date") - Instant minimumTransitionDate; + java.time.Instant minimumTransitionDate; /** An object containing an overview of requirements for the Account. */ @SerializedName("summary") @@ -5639,8 +5454,8 @@ public static class FutureRequirements extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Entry extends StripeObject { /** - * Whether the responsibility is with the integrator or with Stripe (to review info, to wait - * for some condition, etc.) to action the requirement. + * Indicates whether the platform or Stripe is currently responsible for taking action on the + * requirement. Value can be {@code user} or {@code stripe}. * *

One of {@code stripe}, or {@code user}. */ @@ -5785,11 +5600,12 @@ public static class RestrictsCapability extends StripeObject { *

One of {@code ach_debit_payments}, {@code acss_debit_payments}, {@code * affirm_payments}, {@code afterpay_clearpay_payments}, {@code alma_payments}, {@code * amazon_pay_payments}, {@code automatic_indirect_tax}, {@code au_becs_debit_payments}, - * {@code bacs_debit_payments}, {@code bancontact_payments}, {@code bank_accounts.local}, - * {@code bank_accounts.wire}, {@code blik_payments}, {@code boleto_payments}, {@code - * cards}, {@code card_payments}, {@code cartes_bancaires_payments}, {@code - * cashapp_payments}, {@code commercial.celtic.charge_card}, {@code - * commercial.celtic.spend_card}, {@code commercial.cross_river_bank.charge_card}, {@code + * {@code bacs_debit_payments}, {@code bancontact_payments}, {@code + * bank_accounts.instant}, {@code bank_accounts.local}, {@code bank_accounts.wire}, {@code + * blik_payments}, {@code boleto_payments}, {@code cards}, {@code card_payments}, {@code + * cartes_bancaires_payments}, {@code cashapp_payments}, {@code + * commercial.celtic.charge_card}, {@code commercial.celtic.spend_card}, {@code + * commercial.cross_river_bank.charge_card}, {@code * commercial.cross_river_bank.spend_card}, {@code commercial.lead.prepaid_card}, {@code * commercial.stripe.charge_card}, {@code commercial.stripe.prepaid_card}, {@code crypto}, * {@code eps_payments}, {@code financial_addresses.bank_accounts}, {@code fpx_payments}, @@ -5936,7 +5752,7 @@ public static class MinimumDeadline extends StripeObject { /** The soonest RFC3339 date & time UTC value a requirement can impact the Account. */ @SerializedName("time") - Instant time; + java.time.Instant time; } } } @@ -6031,7 +5847,7 @@ public static class DirectorshipDeclaration extends StripeObject { * & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** The IP address from which the director attestation was made. */ @SerializedName("ip") @@ -6056,7 +5872,7 @@ public static class OwnershipDeclaration extends StripeObject { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** The IP address from which the beneficial owner attestation was made. */ @SerializedName("ip") @@ -6120,7 +5936,7 @@ public static class RepresentativeDeclaration extends StripeObject { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** The IP address from which the representative attestation was made. */ @SerializedName("ip") @@ -6208,7 +6024,7 @@ public static class AccountHolder extends StripeObject { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6271,7 +6087,7 @@ public static class ApplePay extends StripeObject { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6328,7 +6144,7 @@ public static class BankTerms extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6363,7 +6179,7 @@ public static class Platform extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6428,7 +6244,7 @@ public static class BankTerms extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6463,7 +6279,7 @@ public static class FinancingDisclosures extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6498,7 +6314,7 @@ public static class Platform extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6564,7 +6380,7 @@ public static class ApplePay extends StripeObject { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6628,7 +6444,7 @@ public static class BankTerms extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6663,7 +6479,7 @@ public static class FinancingDisclosures extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6698,7 +6514,7 @@ public static class Platform extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6756,7 +6572,7 @@ public static class BankTerms extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6791,7 +6607,7 @@ public static class FinancingDisclosures extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6825,7 +6641,7 @@ public static class GlobalAccountHolder extends StripeObject { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6881,7 +6697,7 @@ public static class ApplePay extends StripeObject { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6938,7 +6754,7 @@ public static class BankTerms extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -6973,7 +6789,7 @@ public static class Platform extends StripeObject { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of @@ -7009,7 +6825,7 @@ public static class CryptoStorer extends StripeObject { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of service. @@ -7040,7 +6856,7 @@ public static class InnerAccount extends StripeObject { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of service. @@ -7067,7 +6883,7 @@ public static class Storer extends StripeObject { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * The IP address from which the Account's representative accepted the terms of service. @@ -7110,8 +6926,8 @@ public static class BusinessDetails extends StripeObject { Documents documents; /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for the - * business. + * Estimated maximum number of workers currently engaged by the business (including employees, + * contractors, and vendors). */ @SerializedName("estimated_worker_count") Long estimatedWorkerCount; @@ -7120,7 +6936,10 @@ public static class BusinessDetails extends StripeObject { @SerializedName("id_numbers") List idNumbers; - /** An estimate of the monthly revenue of the business. */ + /** + * An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil + * and India. + */ @SerializedName("monthly_estimated_revenue") MonthlyEstimatedRevenue monthlyEstimatedRevenue; @@ -7189,7 +7008,7 @@ public static class Address extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -7199,7 +7018,7 @@ public static class Address extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class AnnualRevenue extends StripeObject { - /** A non-negative integer representing the amount in the smallest currency unit. */ + /** Annual revenue amount in minor currency units (for example, '123' for 1.23 USD). */ @SerializedName("amount") Amount amount; @@ -7210,7 +7029,7 @@ public static class AnnualRevenue extends StripeObject { @SerializedName("fiscal_year_end") String fiscalYearEnd; - /** A non-negative integer representing the amount in the smallest currency unit. */ + /** Annual revenue amount in minor currency units (for example, '123' for 1.23 USD). */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -7568,34 +7387,51 @@ public static class IdNumber extends StripeObject { * Open Enum. The ID number type of a business entity. * *

One of {@code ae_crn}, {@code ae_vat}, {@code ao_nif}, {@code ar_cuit}, {@code at_fn}, - * {@code au_abn}, {@code au_acn}, {@code au_in}, {@code az_tin}, {@code bd_etin}, {@code - * be_cbe}, {@code bg_uic}, {@code br_cnpj}, {@code ca_cn}, {@code ca_crarr}, {@code - * ca_neq}, {@code ca_rid}, {@code ch_chid}, {@code ch_uid}, {@code cr_cpj}, {@code - * cr_nite}, {@code cy_tic}, {@code cz_ico}, {@code de_hrn}, {@code de_vat}, {@code dk_cvr}, - * {@code do_rcn}, {@code ee_rk}, {@code es_cif}, {@code fi_yt}, {@code fr_siren}, {@code - * fr_vat}, {@code gb_crn}, {@code gi_crn}, {@code gr_gemi}, {@code gt_nit}, {@code hk_br}, - * {@code hk_cr}, {@code hk_mbs}, {@code hu_cjs}, {@code ie_crn}, {@code it_rea}, {@code - * it_vat}, {@code jp_cn}, {@code kz_bin}, {@code li_uid}, {@code lt_ccrn}, {@code lu_rcs}, - * {@code lv_urn}, {@code mt_crn}, {@code mx_rfc}, {@code my_brn}, {@code my_coid}, {@code - * my_sst}, {@code mz_nuit}, {@code nl_kvk}, {@code no_orgnr}, {@code nz_bn}, {@code - * pe_ruc}, {@code pk_ntn}, {@code pl_regon}, {@code pt_vat}, {@code ro_cui}, {@code - * sa_crn}, {@code sa_tin}, {@code se_orgnr}, {@code sg_uen}, {@code si_msp}, {@code - * sk_ico}, {@code th_crn}, {@code th_prn}, {@code th_tin}, or {@code us_ein}. + * {@code at_stn}, {@code at_vat}, {@code au_abn}, {@code au_acn}, {@code au_in}, {@code + * az_tin}, {@code bd_etin}, {@code be_cbe}, {@code be_vat}, {@code bg_uic}, {@code bg_vat}, + * {@code br_cnpj}, {@code ca_cn}, {@code ca_crarr}, {@code ca_gst_hst}, {@code ca_neq}, + * {@code ca_rid}, {@code ch_chid}, {@code ch_uid}, {@code cr_cpj}, {@code cr_nite}, {@code + * cy_he}, {@code cy_tic}, {@code cy_vat}, {@code cz_ico}, {@code cz_vat}, {@code de_hrn}, + * {@code de_stn}, {@code de_vat}, {@code dk_cvr}, {@code dk_vat}, {@code do_rcn}, {@code + * ee_rk}, {@code ee_vat}, {@code es_cif}, {@code es_vat}, {@code fi_vat}, {@code fi_yt}, + * {@code fr_rna}, {@code fr_siren}, {@code fr_vat}, {@code gb_crn}, {@code gi_crn}, {@code + * gr_afm}, {@code gr_gemi}, {@code gr_vat}, {@code gt_nit}, {@code hk_br}, {@code hk_cr}, + * {@code hr_mbs}, {@code hr_oib}, {@code hr_vat}, {@code hu_cjs}, {@code hu_tin}, {@code + * hu_vat}, {@code ie_crn}, {@code ie_trn}, {@code ie_vat}, {@code it_rea}, {@code it_vat}, + * {@code jp_cn}, {@code kz_bin}, {@code li_uid}, {@code lt_ccrn}, {@code lt_vat}, {@code + * lu_nif}, {@code lu_rcs}, {@code lu_vat}, {@code lv_urn}, {@code lv_vat}, {@code mt_crn}, + * {@code mt_tin}, {@code mt_vat}, {@code mx_rfc}, {@code my_brn}, {@code my_coid}, {@code + * my_itn}, {@code my_sst}, {@code mz_nuit}, {@code nl_kvk}, {@code nl_rsin}, {@code + * nl_vat}, {@code no_orgnr}, {@code nz_bn}, {@code nz_ird}, {@code pe_ruc}, {@code pk_ntn}, + * {@code pl_nip}, {@code pl_regon}, {@code pl_vat}, {@code pt_vat}, {@code ro_cui}, {@code + * ro_orc}, {@code ro_vat}, {@code sa_crn}, {@code sa_tin}, {@code se_orgnr}, {@code + * se_vat}, {@code sg_uen}, {@code si_msp}, {@code si_tin}, {@code si_vat}, {@code sk_dic}, + * {@code sk_ico}, {@code sk_vat}, {@code th_crn}, {@code th_prn}, {@code th_tin}, or {@code + * us_ein}. */ @SerializedName("type") String type; } - /** An estimate of the monthly revenue of the business. */ + /** + * An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil + * and India. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class MonthlyEstimatedRevenue extends StripeObject { - /** A non-negative integer representing the amount in the smallest currency unit. */ + /** + * Estimated monthly revenue amount in minor currency units (for example, '123' for 1.23 + * USD). + */ @SerializedName("amount") Amount amount; - /** A non-negative integer representing the amount in the smallest currency unit. */ + /** + * Estimated monthly revenue amount in minor currency units (for example, '123' for 1.23 + * USD). + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -7662,7 +7498,7 @@ public static class Kana extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -7699,7 +7535,7 @@ public static class Kanji extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -7773,7 +7609,7 @@ public static class Individual extends StripeObject implements HasId { * in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("created") - Instant created; + java.time.Instant created; /** The individual's date of birth. */ @SerializedName("date_of_birth") @@ -7859,7 +7695,7 @@ public static class Individual extends StripeObject implements HasId { /** Time at which the object was last updated. */ @SerializedName("updated") - Instant updated; + java.time.Instant updated; /** * For more details about AdditionalAddress, please refer to the One of {@code ae_eid}, {@code ao_nif}, {@code ar_dni}, {@code az_tin}, {@code bd_brc}, - * {@code bd_etin}, {@code bd_nid}, {@code br_cpf}, {@code cr_cpf}, {@code cr_dimex}, {@code - * cr_nite}, {@code de_stn}, {@code do_rcn}, {@code gt_nit}, {@code hk_id}, {@code kz_iin}, - * {@code mx_rfc}, {@code my_nric}, {@code mz_nuit}, {@code nl_bsn}, {@code pe_dni}, {@code - * pk_cnic}, {@code pk_snic}, {@code sa_tin}, {@code sg_fin}, {@code sg_nric}, {@code - * th_lc}, {@code th_pin}, {@code us_itin}, {@code us_itin_last_4}, {@code us_ssn}, or - * {@code us_ssn_last_4}. + *

One of {@code ae_eid}, {@code ao_nif}, {@code ar_cuil}, {@code ar_dni}, {@code + * at_stn}, {@code az_tin}, {@code bd_brc}, {@code bd_etin}, {@code bd_nid}, {@code be_nrn}, + * {@code bg_ucn}, {@code bn_nric}, {@code br_cpf}, {@code ca_sin}, {@code ch_oasi}, {@code + * cl_rut}, {@code cn_pp}, {@code co_nuip}, {@code cr_ci}, {@code cr_cpf}, {@code cr_dimex}, + * {@code cr_nite}, {@code cy_tic}, {@code cz_rc}, {@code de_stn}, {@code dk_cpr}, {@code + * do_cie}, {@code do_rcn}, {@code ec_ci}, {@code ee_ik}, {@code es_nif}, {@code fi_hetu}, + * {@code fr_nir}, {@code gb_nino}, {@code gr_afm}, {@code gt_nit}, {@code hk_id}, {@code + * hr_oib}, {@code hu_ad}, {@code id_nik}, {@code ie_ppsn}, {@code is_kt}, {@code it_cf}, + * {@code jp_inc}, {@code ke_pin}, {@code kz_iin}, {@code li_peid}, {@code lt_ak}, {@code + * lu_nif}, {@code lv_pk}, {@code mx_rfc}, {@code my_nric}, {@code mz_nuit}, {@code ng_nin}, + * {@code nl_bsn}, {@code no_nin}, {@code nz_ird}, {@code pe_dni}, {@code pk_cnic}, {@code + * pk_snic}, {@code pl_pesel}, {@code pt_nif}, {@code ro_cnp}, {@code sa_tin}, {@code + * se_pin}, {@code sg_fin}, {@code sg_nric}, {@code sk_dic}, {@code th_lc}, {@code th_pin}, + * {@code tr_tin}, {@code us_itin}, {@code us_itin_last_4}, {@code us_ssn}, {@code + * us_ssn_last_4}, {@code uy_dni}, or {@code za_id}. */ @SerializedName("type") String type; @@ -8276,13 +8120,13 @@ public static class IdNumber extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Relationship extends StripeObject { - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ @SerializedName("authorizer") Boolean authorizer; /** - * Whether the individual is a director of the Account’s legal entity. Directors are - * typically members of the governing board of the company, or responsible for ensuring the + * Whether the individual is a director of the Account's identity. Directors are typically + * members of the governing board of the company or are responsible for making sure that the * company meets its regulatory obligations. */ @SerializedName("director") @@ -8295,15 +8139,15 @@ public static class Relationship extends StripeObject { @SerializedName("executive") Boolean executive; - /** Whether the individual is the legal guardian of the Account’s representative. */ + /** Whether the individual is the legal guardian of the Account's representative. */ @SerializedName("legal_guardian") Boolean legalGuardian; - /** Whether the individual is an owner of the Account’s legal entity. */ + /** Whether the individual is an owner of the Account's identity. */ @SerializedName("owner") Boolean owner; - /** The percent owned by the individual of the Account’s legal entity. */ + /** The percentage of the Account's identity that the individual owns. */ @SerializedName("percent_ownership") String percentOwnership; @@ -8367,7 +8211,7 @@ public static class Kana extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -8404,7 +8248,7 @@ public static class Kanji extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -8479,8 +8323,8 @@ public static class Requirements extends StripeObject { @EqualsAndHashCode(callSuper = false) public static class Entry extends StripeObject { /** - * Whether the responsibility is with the integrator or with Stripe (to review info, to wait - * for some condition, etc.) to action the requirement. + * Indicates whether the platform or Stripe is currently responsible for taking action on the + * requirement. Value can be {@code user} or {@code stripe}. * *

One of {@code stripe}, or {@code user}. */ @@ -8625,11 +8469,12 @@ public static class RestrictsCapability extends StripeObject { *

One of {@code ach_debit_payments}, {@code acss_debit_payments}, {@code * affirm_payments}, {@code afterpay_clearpay_payments}, {@code alma_payments}, {@code * amazon_pay_payments}, {@code automatic_indirect_tax}, {@code au_becs_debit_payments}, - * {@code bacs_debit_payments}, {@code bancontact_payments}, {@code bank_accounts.local}, - * {@code bank_accounts.wire}, {@code blik_payments}, {@code boleto_payments}, {@code - * cards}, {@code card_payments}, {@code cartes_bancaires_payments}, {@code - * cashapp_payments}, {@code commercial.celtic.charge_card}, {@code - * commercial.celtic.spend_card}, {@code commercial.cross_river_bank.charge_card}, {@code + * {@code bacs_debit_payments}, {@code bancontact_payments}, {@code + * bank_accounts.instant}, {@code bank_accounts.local}, {@code bank_accounts.wire}, {@code + * blik_payments}, {@code boleto_payments}, {@code cards}, {@code card_payments}, {@code + * cartes_bancaires_payments}, {@code cashapp_payments}, {@code + * commercial.celtic.charge_card}, {@code commercial.celtic.spend_card}, {@code + * commercial.cross_river_bank.charge_card}, {@code * commercial.cross_river_bank.spend_card}, {@code commercial.lead.prepaid_card}, {@code * commercial.stripe.charge_card}, {@code commercial.stripe.prepaid_card}, {@code crypto}, * {@code eps_payments}, {@code financial_addresses.bank_accounts}, {@code fpx_payments}, @@ -8776,7 +8621,7 @@ public static class MinimumDeadline extends StripeObject { /** The soonest RFC3339 date & time UTC value a requirement can impact the Account. */ @SerializedName("time") - Instant time; + java.time.Instant time; } } } diff --git a/src/main/java/com/stripe/model/v2/core/AccountLink.java b/src/main/java/com/stripe/model/v2/core/AccountLink.java index 7931531ede8..a3d98189ee1 100644 --- a/src/main/java/com/stripe/model/v2/core/AccountLink.java +++ b/src/main/java/com/stripe/model/v2/core/AccountLink.java @@ -10,23 +10,22 @@ import lombok.Setter; /** - * AccountLinks are the means by which a Merchant grants an Account permission to access - * Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users - * enrolled in the public preview for Accounts v2. + * Account Links let a platform create a temporary, single-use URL that an account can use to access + * a Stripe-hosted flow for collecting or updating required information. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public class AccountLink extends StripeObject { - /** The ID of the Account the link was created for. */ + /** The ID of the connected account this Account Link applies to. */ @SerializedName("account") String account; - /** The timestamp at which this AccountLink was created. */ + /** The timestamp at which this Account Link was created. */ @SerializedName("created") Instant created; - /** The timestamp at which this AccountLink will expire. */ + /** The timestamp at which this Account Link will expire. */ @SerializedName("expires_at") Instant expiresAt; @@ -46,36 +45,42 @@ public class AccountLink extends StripeObject { @SerializedName("object") String object; - /** The URL for the AccountLink. */ + /** The URL at which the account can access the Stripe-hosted flow. */ @SerializedName("url") String url; - /** The use case of AccountLink the user is requesting. */ + /** Hash containing usage options. */ @SerializedName("use_case") UseCase useCase; - /** The use case of AccountLink the user is requesting. */ + /** Hash containing usage options. */ @Getter @Setter @EqualsAndHashCode(callSuper = false) public static class UseCase extends StripeObject { - /** Indicates that the AccountLink provided should onboard an account. */ + /** + * Hash containing configuration options for an Account Link object that onboards a new account. + */ @SerializedName("account_onboarding") AccountOnboarding accountOnboarding; - /** Indicates that the AccountLink provided should update a previously onboarded account. */ + /** + * Hash containing configuration options for an Account Link that updates an existing account. + */ @SerializedName("account_update") AccountUpdate accountUpdate; /** - * Open Enum. The type of AccountLink the user is requesting. + * Open Enum. The type of Account Link the user is requesting. * *

One of {@code account_onboarding}, or {@code account_update}. */ @SerializedName("type") String type; - /** Indicates that the AccountLink provided should onboard an account. */ + /** + * Hash containing configuration options for an Account Link object that onboards a new account. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -141,7 +146,9 @@ public static class CollectionOptions extends StripeObject { } } - /** Indicates that the AccountLink provided should update a previously onboarded account. */ + /** + * Hash containing configuration options for an Account Link that updates an existing account. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -162,13 +169,13 @@ public static class AccountUpdate extends StripeObject { List configurations; /** - * The URL the user will be redirected to if the AccountLink is expired, has been used, or is - * otherwise invalid. The URL you specify should attempt to generate a new AccountLink with - * the same parameters used to create the original AccountLink, then redirect the user to the - * new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be - * generated or the redirect fails you should display a useful error to the user. Please make - * sure to implement authentication before redirecting the user in case this URL is leaked to - * a third party. + * The URL the user will be redirected to if the Account Link is expired, has been used, or is + * otherwise invalid. The URL you specify should attempt to generate a new Account Link with + * the same parameters used to create the original Account Link, then redirect the user to the + * new Account Link URL so they can continue the flow. Make sure to authenticate the user + * before redirecting to the new Account Link, in case the URL leaks to a third party. If a + * new Account Link can't be generated, or if the redirect fails, you should display a useful + * error to the user. */ @SerializedName("refresh_url") String refreshUrl; @@ -188,8 +195,7 @@ public static class CollectionOptions extends StripeObject { /** * Specifies whether the platform collects only currently_due requirements ({@code * currently_due}) or both currently_due and eventually_due requirements ({@code - * eventually_due}). If you don’t specify collection_options, the default value is - * currently_due. + * eventually_due}). The default value is {@code currently_due}. * *

One of {@code currently_due}, or {@code eventually_due}. */ diff --git a/src/main/java/com/stripe/model/v2/core/AccountPerson.java b/src/main/java/com/stripe/model/v2/core/AccountPerson.java index 96dfa034726..f3ce221205d 100644 --- a/src/main/java/com/stripe/model/v2/core/AccountPerson.java +++ b/src/main/java/com/stripe/model/v2/core/AccountPerson.java @@ -11,7 +11,11 @@ import lombok.Getter; import lombok.Setter; -/** Person retrieval response schema. */ +/** + * A Person represents an individual associated with an Account's identity (for example, an owner, + * director, executive, or representative). Use Persons to provide and update identity information + * for verification and compliance. + */ @Getter @Setter @EqualsAndHashCode(callSuper = false) @@ -185,7 +189,7 @@ public static class AdditionalAddress extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -286,7 +290,7 @@ public static class Address extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -526,13 +530,21 @@ public static class IdNumber extends StripeObject { /** * The ID number type of an individual. * - *

One of {@code ae_eid}, {@code ao_nif}, {@code ar_dni}, {@code az_tin}, {@code bd_brc}, - * {@code bd_etin}, {@code bd_nid}, {@code br_cpf}, {@code cr_cpf}, {@code cr_dimex}, {@code - * cr_nite}, {@code de_stn}, {@code do_rcn}, {@code gt_nit}, {@code hk_id}, {@code kz_iin}, - * {@code mx_rfc}, {@code my_nric}, {@code mz_nuit}, {@code nl_bsn}, {@code pe_dni}, {@code - * pk_cnic}, {@code pk_snic}, {@code sa_tin}, {@code sg_fin}, {@code sg_nric}, {@code th_lc}, - * {@code th_pin}, {@code us_itin}, {@code us_itin_last_4}, {@code us_ssn}, or {@code - * us_ssn_last_4}. + *

One of {@code ae_eid}, {@code ao_nif}, {@code ar_cuil}, {@code ar_dni}, {@code at_stn}, + * {@code az_tin}, {@code bd_brc}, {@code bd_etin}, {@code bd_nid}, {@code be_nrn}, {@code + * bg_ucn}, {@code bn_nric}, {@code br_cpf}, {@code ca_sin}, {@code ch_oasi}, {@code cl_rut}, + * {@code cn_pp}, {@code co_nuip}, {@code cr_ci}, {@code cr_cpf}, {@code cr_dimex}, {@code + * cr_nite}, {@code cy_tic}, {@code cz_rc}, {@code de_stn}, {@code dk_cpr}, {@code do_cie}, + * {@code do_rcn}, {@code ec_ci}, {@code ee_ik}, {@code es_nif}, {@code fi_hetu}, {@code + * fr_nir}, {@code gb_nino}, {@code gr_afm}, {@code gt_nit}, {@code hk_id}, {@code hr_oib}, + * {@code hu_ad}, {@code id_nik}, {@code ie_ppsn}, {@code is_kt}, {@code it_cf}, {@code jp_inc}, + * {@code ke_pin}, {@code kz_iin}, {@code li_peid}, {@code lt_ak}, {@code lu_nif}, {@code + * lv_pk}, {@code mx_rfc}, {@code my_nric}, {@code mz_nuit}, {@code ng_nin}, {@code nl_bsn}, + * {@code no_nin}, {@code nz_ird}, {@code pe_dni}, {@code pk_cnic}, {@code pk_snic}, {@code + * pl_pesel}, {@code pt_nif}, {@code ro_cnp}, {@code sa_tin}, {@code se_pin}, {@code sg_fin}, + * {@code sg_nric}, {@code sk_dic}, {@code th_lc}, {@code th_pin}, {@code tr_tin}, {@code + * us_itin}, {@code us_itin_last_4}, {@code us_ssn}, {@code us_ssn_last_4}, {@code uy_dni}, or + * {@code za_id}. */ @SerializedName("type") String type; @@ -543,14 +555,14 @@ public static class IdNumber extends StripeObject { @Setter @EqualsAndHashCode(callSuper = false) public static class Relationship extends StripeObject { - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ @SerializedName("authorizer") Boolean authorizer; /** - * Whether the individual is a director of the Account’s legal entity. Directors are typically - * members of the governing board of the company, or responsible for ensuring the company meets - * its regulatory obligations. + * Whether the individual is a director of the Account's identity. Directors are typically + * members of the governing board of the company or are responsible for making sure that the + * company meets its regulatory obligations. */ @SerializedName("director") Boolean director; @@ -562,15 +574,15 @@ public static class Relationship extends StripeObject { @SerializedName("executive") Boolean executive; - /** Whether the individual is the legal guardian of the Account’s representative. */ + /** Whether the individual is the legal guardian of the Account's representative. */ @SerializedName("legal_guardian") Boolean legalGuardian; - /** Whether the individual is an owner of the Account’s legal entity. */ + /** Whether the individual is an owner of the Account's identity. */ @SerializedName("owner") Boolean owner; - /** The percent owned by the individual of the Account’s legal entity. */ + /** The percentage of the Account's identity that the individual owns. */ @SerializedName("percent_ownership") String percentOwnership; @@ -634,7 +646,7 @@ public static class Kana extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } @@ -671,7 +683,7 @@ public static class Kanji extends StripeObject { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; } diff --git a/src/main/java/com/stripe/model/v2/core/vault/GbBankAccount.java b/src/main/java/com/stripe/model/v2/core/vault/GbBankAccount.java index 766317d0182..d1ea223c682 100644 --- a/src/main/java/com/stripe/model/v2/core/vault/GbBankAccount.java +++ b/src/main/java/com/stripe/model/v2/core/vault/GbBankAccount.java @@ -14,6 +14,10 @@ @Setter @EqualsAndHashCode(callSuper = false) public class GbBankAccount extends StripeObject implements HasId { + /** The alternative reference for this payout method, if it's a projected payout method. */ + @SerializedName("alternative_reference") + AlternativeReference alternativeReference; + /** * Whether this bank account object was archived. Bank account objects can be archived through the * /archive API, and they will not be automatically archived by Stripe. Archived bank account @@ -76,6 +80,25 @@ public class GbBankAccount extends StripeObject implements HasId { @SerializedName("sort_code") String sortCode; + /** The alternative reference for this payout method, if it's a projected payout method. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class AlternativeReference extends StripeObject implements HasId { + /** The ID of the alternative resource being referenced. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + + /** + * The type of the alternative reference (e.g., external_account for V1 external accounts). + * + *

One of {@code external_account}, or {@code payment_method}. + */ + @SerializedName("type") + String type; + } + /** * Information around the status of Confirmation of Payee matching done on this bank account. * Confirmation of Payee is a name matching service that must be done before making diff --git a/src/main/java/com/stripe/model/v2/core/vault/UsBankAccount.java b/src/main/java/com/stripe/model/v2/core/vault/UsBankAccount.java index 9dd736d44fc..a4b359adc37 100644 --- a/src/main/java/com/stripe/model/v2/core/vault/UsBankAccount.java +++ b/src/main/java/com/stripe/model/v2/core/vault/UsBankAccount.java @@ -17,6 +17,10 @@ @Setter @EqualsAndHashCode(callSuper = false) public class UsBankAccount extends StripeObject implements HasId { + /** The alternative reference for this payout method, if it's a projected payout method. */ + @SerializedName("alternative_reference") + AlternativeReference alternativeReference; + /** Whether this USBankAccount object was archived. */ @SerializedName("archived") Boolean archived; @@ -44,6 +48,10 @@ public class UsBankAccount extends StripeObject implements HasId { @SerializedName("fedwire_routing_number") String fedwireRoutingNumber; + /** The ID of the Financial Connections Account used to create the bank account. */ + @SerializedName("financial_connections_account") + String financialConnectionsAccount; + /** The ID of the USBankAccount object. */ @Getter(onMethod_ = {@Override}) @SerializedName("id") @@ -77,6 +85,25 @@ public class UsBankAccount extends StripeObject implements HasId { @SerializedName("verification") Verification verification; + /** The alternative reference for this payout method, if it's a projected payout method. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class AlternativeReference extends StripeObject implements HasId { + /** The ID of the alternative resource being referenced. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + + /** + * The type of the alternative reference (e.g., external_account for V1 external accounts). + * + *

One of {@code external_account}, or {@code payment_method}. + */ + @SerializedName("type") + String type; + } + /** The bank account verification details. */ @Getter @Setter diff --git a/src/main/java/com/stripe/model/v2/iam/ApiKey.java b/src/main/java/com/stripe/model/v2/iam/ApiKey.java new file mode 100644 index 00000000000..dc4b01b660f --- /dev/null +++ b/src/main/java/com/stripe/model/v2/iam/ApiKey.java @@ -0,0 +1,168 @@ +// File generated from our OpenAPI spec +package com.stripe.model.v2.iam; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.HasId; +import com.stripe.model.StripeObject; +import java.time.Instant; +import java.util.List; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; + +/** An API key. */ +@Getter +@Setter +@EqualsAndHashCode(callSuper = false) +public class ApiKey extends StripeObject implements HasId { + /** Timestamp when the API key was created. */ + @SerializedName("created") + Instant created; + + /** Timestamp when the API key expires. */ + @SerializedName("expires_at") + Instant expiresAt; + + /** Unique identifier of the API key. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + + /** + * List of IP addresses allowed to use this API key. Addresses use IPv4 protocol, and may be a + * CIDR range (e.g., [100.10.38.255, 100.10.38.0/24]). + */ + @SerializedName("ip_allowlist") + List ipAllowlist; + + /** Timestamp when the API key was last used. */ + @SerializedName("last_used") + Instant lastUsed; + + /** + * 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; + + /** Account that manages this API key (for keys managed by platforms). */ + @SerializedName("managed_by") + ManagedBy managedBy; + + /** Name of the API key. */ + @SerializedName("name") + String name; + + /** Note or description for the API key. */ + @SerializedName("note") + String note; + + /** + * String representing the object's type. Objects of the same type share the same value of the + * object field. + * + *

Equal to {@code v2.iam.api_key}. + */ + @SerializedName("object") + String object; + + /** Token set for a publishable key. */ + @SerializedName("publishable_key") + PublishableKey publishableKey; + + /** Token set for a secret key. */ + @SerializedName("secret_key") + SecretKey secretKey; + + /** + * Current status of the API key (e.g., active, expired). + * + *

One of {@code active}, or {@code expired}. + */ + @SerializedName("status") + String status; + + /** + * Type of the API key. + * + *

One of {@code publishable_key}, or {@code secret_key}. + */ + @SerializedName("type") + String type; + + /** Account that manages this API key (for keys managed by platforms). */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class ManagedBy extends StripeObject { + /** An application. */ + @SerializedName("application") + Application application; + + /** + * The type of entity. + * + *

Equal to {@code application}. + */ + @SerializedName("type") + String type; + + /** An application. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Application extends StripeObject implements HasId { + /** Identifier of the application. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + } + } + + /** Token set for a publishable key. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class PublishableKey extends StripeObject { + /** The plaintext token for the API key. */ + @SerializedName("token") + String token; + } + + /** Token set for a secret key. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class SecretKey extends StripeObject { + /** The encrypted secret for the API key. Only included when a key is first created. */ + @SerializedName("encrypted_secret") + EncryptedSecret encryptedSecret; + + /** Redacted version of the secret token for display purposes. */ + @SerializedName("secret_token_redacted") + String secretTokenRedacted; + + /** The plaintext token for the API key. Only included for testmode keys. */ + @SerializedName("token") + String token; + + /** The encrypted secret for the API key. Only included when a key is first created. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class EncryptedSecret extends StripeObject { + /** The encrypted secret data in base64 format. */ + @SerializedName("ciphertext") + String ciphertext; + + /** The format of the encrypted secret (e.g., jwe_compact). */ + @SerializedName("format") + String format; + + /** The caller's identifier of the public key provided. */ + @SerializedName("recipient_key_id") + String recipientKeyId; + } + } +} diff --git a/src/main/java/com/stripe/model/v2/moneymanagement/FinancialAccount.java b/src/main/java/com/stripe/model/v2/moneymanagement/FinancialAccount.java index a02e0dfa787..10bcbe7b15d 100644 --- a/src/main/java/com/stripe/model/v2/moneymanagement/FinancialAccount.java +++ b/src/main/java/com/stripe/model/v2/moneymanagement/FinancialAccount.java @@ -57,6 +57,14 @@ public class FinancialAccount extends StripeObject implements HasId { @SerializedName("livemode") Boolean livemode; + /** + * If this is a managed FinancialAccount, {@code managed_by} indicates the product that created + * and manages this FinancialAccount. For managed FinancialAccounts, creation of money management + * resources can only be orchestrated by the managing product. + */ + @SerializedName("managed_by") + ManagedBy managedBy; + /** Metadata associated with the FinancialAccount. */ @SerializedName("metadata") Map metadata; @@ -77,6 +85,13 @@ public class FinancialAccount extends StripeObject implements HasId { @SerializedName("other") Other other; + /** + * If this is a {@code payments} FinancialAccount, this hash include details specific to {@code + * payments} FinancialAccount. + */ + @SerializedName("payments") + Payments payments; + /** * Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or * not the FinancialAccount can be used for any money movement flows. @@ -101,7 +116,7 @@ public class FinancialAccount extends StripeObject implements HasId { * name matching this value. It contains additional information specific to the FinancialAccount * type. * - *

One of {@code other}, or {@code storage}. + *

One of {@code other}, {@code payments}, or {@code storage}. */ @SerializedName("type") String type; @@ -200,6 +215,24 @@ public static class OutboundPending extends StripeObject { } } + /** + * If this is a managed FinancialAccount, {@code managed_by} indicates the product that created + * and manages this FinancialAccount. For managed FinancialAccounts, creation of money management + * resources can only be orchestrated by the managing product. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class ManagedBy extends StripeObject { + /** + * Enum describing the Stripe product that is managing this FinancialAccount. + * + *

Equal to {@code multiprocessor_settlement}. + */ + @SerializedName("type") + String type; + } + /** * If this is a {@code other} FinancialAccount, this hash indicates what the actual type is. * Upgrade your API version to see it reflected in {@code type}. @@ -216,6 +249,26 @@ public static class Other extends StripeObject { String type; } + /** + * If this is a {@code payments} FinancialAccount, this hash include details specific to {@code + * payments} FinancialAccount. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Payments extends StripeObject { + /** The currency that non-settlement currency payments will be converted to. */ + @SerializedName("default_currency") + String defaultCurrency; + + /** + * Settlement currencies enabled for this FinancialAccount. Payments in other currencies will be + * automatically converted to {@code default_currency}. + */ + @SerializedName("settlement_currencies") + List settlementCurrencies; + } + /** * For more details about StatusDetails, please refer to the API Reference. diff --git a/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPayment.java b/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPayment.java index 675d96229d0..f5927a4c795 100644 --- a/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPayment.java +++ b/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPayment.java @@ -182,6 +182,14 @@ public static class DeliveryOptions extends StripeObject { */ @SerializedName("bank_account") String bankAccount; + + /** + * Open Enum. Speed of the payout. + * + *

One of {@code instant}, {@code next_business_day}, or {@code standard}. + */ + @SerializedName("speed") + String speed; } /** The FinancialAccount that funds were pulled from. */ diff --git a/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPaymentQuote.java b/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPaymentQuote.java index 1c80c6d4cac..a9602b89124 100644 --- a/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPaymentQuote.java +++ b/src/main/java/com/stripe/model/v2/moneymanagement/OutboundPaymentQuote.java @@ -104,6 +104,14 @@ public static class DeliveryOptions extends StripeObject { */ @SerializedName("bank_account") String bankAccount; + + /** + * Open Enum. Speed of the payout. + * + *

One of {@code instant}, {@code next_business_day}, or {@code standard}. + */ + @SerializedName("speed") + String speed; } /** @@ -122,7 +130,8 @@ public static class EstimatedFee extends StripeObject { * The fee type. * *

One of {@code cross_border_payout_fee}, {@code foreign_exchange_fee}, {@code - * instant_payout_fee}, {@code standard_payout_fee}, or {@code wire_payout_fee}. + * instant_payout_fee}, {@code real_time_payout_fee}, {@code standard_payout_fee}, or {@code + * wire_payout_fee}. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/v2/moneymanagement/PayoutMethod.java b/src/main/java/com/stripe/model/v2/moneymanagement/PayoutMethod.java index 8bc955949ee..5ca5f058402 100644 --- a/src/main/java/com/stripe/model/v2/moneymanagement/PayoutMethod.java +++ b/src/main/java/com/stripe/model/v2/moneymanagement/PayoutMethod.java @@ -15,6 +15,10 @@ @Setter @EqualsAndHashCode(callSuper = false) public class PayoutMethod extends StripeObject implements HasId { + /** The alternative reference for this payout method, if it's a projected payout method. */ + @SerializedName("alternative_reference") + AlternativeReference alternativeReference; + /** A set of available payout speeds for this payout method. */ @SerializedName("available_payout_speeds") List availablePayoutSpeeds; @@ -75,6 +79,25 @@ public class PayoutMethod extends StripeObject implements HasId { @SerializedName("usage_status") UsageStatus usageStatus; + /** The alternative reference for this payout method, if it's a projected payout method. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class AlternativeReference extends StripeObject implements HasId { + /** The ID of the alternative resource being referenced. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + + /** + * The type of the alternative reference (e.g., external_account for V1 external accounts). + * + *

One of {@code external_account}, or {@code payment_method}. + */ + @SerializedName("type") + String type; + } + /** The PayoutMethodBankAccount object details. */ @Getter @Setter @@ -112,6 +135,10 @@ public static class BankAccount extends StripeObject { @SerializedName("enabled_delivery_options") List enabledDeliveryOptions; + /** The ID of the Financial Connections Account used to create the bank account. */ + @SerializedName("financial_connections_account") + String financialConnectionsAccount; + /** The last 4 digits of the account number. */ @SerializedName("last4") String last4; diff --git a/src/main/java/com/stripe/model/v2/moneymanagement/ReceivedCredit.java b/src/main/java/com/stripe/model/v2/moneymanagement/ReceivedCredit.java index e12f6087b48..6e47eb4eb5e 100644 --- a/src/main/java/com/stripe/model/v2/moneymanagement/ReceivedCredit.java +++ b/src/main/java/com/stripe/model/v2/moneymanagement/ReceivedCredit.java @@ -162,10 +162,15 @@ public static class BalanceTransfer extends StripeObject { @SerializedName("payout_v1") String payoutV1; + /** The ID of the v1 transfer object that originated the ReceivedCredit. */ + @SerializedName("transfer") + String transfer; + /** * Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit. * - *

One of {@code outbound_payment}, {@code outbound_transfer}, or {@code payout_v1}. + *

One of {@code outbound_payment}, {@code outbound_transfer}, {@code transfer}, or {@code + * payout_v1}. */ @SerializedName("type") String type; diff --git a/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntent.java b/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntent.java new file mode 100644 index 00000000000..a57c6f217d1 --- /dev/null +++ b/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntent.java @@ -0,0 +1,144 @@ +// File generated from our OpenAPI spec +package com.stripe.model.v2.payments; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.HasId; +import com.stripe.model.StripeObject; +import java.time.Instant; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; + +/** SettlementAllocationIntent resource. */ +@Getter +@Setter +@EqualsAndHashCode(callSuper = false) +public class SettlementAllocationIntent extends StripeObject implements HasId { + /** The amount and currency of the SettlementAllocationIntent. */ + @SerializedName("amount") + Amount amount; + + /** Timestamp at which SettlementAllocationIntent was created . */ + @SerializedName("created") + Instant created; + + /** Date when we expect to receive the funds. */ + @SerializedName("expected_settlement_date") + Instant expectedSettlementDate; + + /** FinancialAccount ID where the funds are expected. */ + @SerializedName("financial_account") + String financialAccount; + + /** Unique identifier for the SettlementAllocationIntent. */ + @Getter(onMethod_ = {@Override}) + @SerializedName("id") + String id; + + /** List of ReceivedCredits that matched with the SettlementAllocationIntent. */ + @SerializedName("linked_credits") + List linkedCredits; + + /** + * 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; + + /** Metadata associated with the SettlementAllocationIntent. */ + @SerializedName("metadata") + Map metadata; + + /** + * String representing the object's type. Objects of the same type share the same value of the + * object field. + * + *

Equal to {@code v2.payments.settlement_allocation_intent}. + */ + @SerializedName("object") + String object; + + /** + * Reference for the SettlementAllocationIntent. This is the transaction reference used by + * payments processor to send funds to Stripe . + */ + @SerializedName("reference") + String reference; + + /** + * SettlementAllocationIntent status. + * + *

One of {@code canceled}, {@code errored}, {@code matched}, {@code pending}, {@code settled}, + * or {@code submitted}. + */ + @SerializedName("status") + String status; + + /** Status details for a SettlementAllocationIntent in {@code errored} state. */ + @SerializedName("status_details") + StatusDetails statusDetails; + + /** The amount and currency of the SettlementAllocationIntent. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Amount extends StripeObject { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + @SerializedName("value") + Long value; + } + + /** Status details for a SettlementAllocationIntent in {@code errored} state. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class StatusDetails extends StripeObject { + /** + * Hash that provides additional information regarding the reason behind a {@code errored} + * SettlementAllocationIntent status. It is only present when the SettlementAllocationIntent + * status is {@code errored}. + */ + @SerializedName("errored") + Errored errored; + + /** + * Hash that provides additional information regarding the reason behind a {@code errored} + * SettlementAllocationIntent status. It is only present when the SettlementAllocationIntent + * status is {@code errored}. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Errored extends StripeObject { + /** Stripe doc link to debug the issue. */ + @SerializedName("doc_url") + String docUrl; + + /** User Message detailing the reason code and possible resolution . */ + @SerializedName("message") + String message; + + /** + * Open Enum. The {@code errored} status reason. + * + *

Equal to {@code amount_mismatch}. + */ + @SerializedName("reason_code") + String reasonCode; + } + } +} diff --git a/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntentSplit.java b/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntentSplit.java new file mode 100644 index 00000000000..c870e9150e6 --- /dev/null +++ b/src/main/java/com/stripe/model/v2/payments/SettlementAllocationIntentSplit.java @@ -0,0 +1,121 @@ +// File generated from our OpenAPI spec +package com.stripe.model.v2.payments; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.HasId; +import com.stripe.model.StripeObject; +import java.time.Instant; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; + +/** SettlementAllocationIntentSplit resource. */ +@Getter +@Setter +@EqualsAndHashCode(callSuper = false) +public class SettlementAllocationIntentSplit extends StripeObject implements HasId { + /** The account id against which the SettlementAllocationIntentSplit should be settled. */ + @SerializedName("account") + String account; + + /** The amount and currency of the SettlementAllocationIntentSplit. */ + @SerializedName("amount") + Amount amount; + + /** Timestamp at which SettlementAllocationIntentSplit was created. */ + @SerializedName("created") + Instant created; + + /** Details about the Flow object that settled the split. */ + @SerializedName("flow") + Flow flow; + + /** Unique identifier for the SettlementAllocationIntentSplit. */ + @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; + + /** + * String representing the object's type. Objects of the same type share the same value of the + * object field. + * + *

Equal to {@code v2.payments.settlement_allocation_intent_split}. + */ + @SerializedName("object") + String object; + + /** The ID of the SettlementAllocationIntent that this split belongs too. */ + @SerializedName("settlement_allocation_intent") + String settlementAllocationIntent; + + /** + * The status of the SettlementAllocationIntentSplit. + * + *

One of {@code canceled}, {@code pending}, or {@code settled}. + */ + @SerializedName("status") + String status; + + /** + * The type of the SettlementAllocationIntentSplit. + * + *

One of {@code credit}, or {@code debit}. + */ + @SerializedName("type") + String type; + + /** The amount and currency of the SettlementAllocationIntentSplit. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Amount extends StripeObject { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + @SerializedName("value") + Long value; + } + + /** Details about the Flow object that settled the split. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Flow extends StripeObject { + /** If applicable, the ID of the OutboundPayment that created this transaction. */ + @SerializedName("outbound_payment") + String outboundPayment; + + /** If applicable, the ID of the OutboundTransfer that created this transaction. */ + @SerializedName("outbound_transfer") + String outboundTransfer; + + /** If applicable, the ID of the ReceivedCredit that created this transaction. */ + @SerializedName("received_credit") + String receivedCredit; + + /** + * Type of the flow linked to the transaction which settled the SettlementAllocationIntentSplit. + * The field matching this value will contain the ID of the flow. + * + *

One of {@code outbound_payment}, {@code outbound_transfer}, or {@code received_credit}. + */ + @SerializedName("type") + String type; + } +} diff --git a/src/main/java/com/stripe/model/v2/tax/ManualRule.java b/src/main/java/com/stripe/model/v2/tax/ManualRule.java new file mode 100644 index 00000000000..a3953ebf634 --- /dev/null +++ b/src/main/java/com/stripe/model/v2/tax/ManualRule.java @@ -0,0 +1,155 @@ +// File generated from our OpenAPI spec +package com.stripe.model.v2.tax; + +import com.google.gson.annotations.SerializedName; +import com.stripe.model.HasId; +import com.stripe.model.StripeObject; +import java.time.Instant; +import java.util.List; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; + +/** A ManualRule holds tax rates for a BillableItem. It can hold at most 5 distinct tax rates. */ +@Getter +@Setter +@EqualsAndHashCode(callSuper = false) +public class ManualRule extends StripeObject implements HasId { + /** The time at which the ManualRule object was created. */ + @SerializedName("created") + Instant created; + + /** The ID of the ManualRule 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; + + /** Location where the rule applies. */ + @SerializedName("location") + Location location; + + /** + * String representing the object's type. Objects of the same type share the same value of the + * object field. + * + *

Equal to {@code v2.tax.manual_rule}. + */ + @SerializedName("object") + String object; + + /** Products associated with the rule. */ + @SerializedName("products") + List products; + + /** Tax rates to be applied. */ + @SerializedName("scheduled_tax_rates") + List scheduledTaxRates; + + /** + * The status of the ManualRule object. + * + *

One of {@code active}, or {@code inactive}. + */ + @SerializedName("status") + String status; + + /** Location where the rule applies. */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Location extends StripeObject { + /** Country ISO-3166. */ + @SerializedName("country") + String country; + + /** State ISO-3166. */ + @SerializedName("state") + String state; + } + + /** + * For more details about Product, please refer to the API + * Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Product extends StripeObject { + /** The licensed item identifier. */ + @SerializedName("licensed_item") + String licensedItem; + + /** The metered item identifier. */ + @SerializedName("metered_item") + String meteredItem; + + /** The tax code for the product. */ + @SerializedName("tax_code") + String taxCode; + + /** + * The type of the product. + * + *

One of {@code licensed_item}, {@code metered_item}, or {@code tax_code}. + */ + @SerializedName("type") + String type; + } + + /** + * For more details about ScheduledTaxRate, please refer to the API Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class ScheduledTaxRate extends StripeObject { + /** The tax rates to be applied. */ + @SerializedName("rates") + List rates; + + /** The start time for the tax rate. */ + @SerializedName("starts_at") + Instant startsAt; + + /** + * For more details about Rate, please refer to the API + * Reference. + */ + @Getter + @Setter + @EqualsAndHashCode(callSuper = false) + public static class Rate extends StripeObject { + /** Country of the tax rate. */ + @SerializedName("country") + String country; + + /** Description of the tax rate. */ + @SerializedName("description") + String description; + + /** Display name of the tax rate as it will be shown on the invoice. */ + @SerializedName("display_name") + String displayName; + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + @SerializedName("jurisdiction") + String jurisdiction; + + /** Percentage of the tax rate. Must be positive and maximum of 4 decimal points. */ + @SerializedName("percentage") + String percentage; + + /** State of the tax rate. */ + @SerializedName("state") + String state; + } + } +} diff --git a/src/main/java/com/stripe/net/HttpClient.java b/src/main/java/com/stripe/net/HttpClient.java index f012b688298..2d4942d9964 100644 --- a/src/main/java/com/stripe/net/HttpClient.java +++ b/src/main/java/com/stripe/net/HttpClient.java @@ -1,13 +1,17 @@ package com.stripe.net; +import com.google.gson.Gson; import com.stripe.Stripe; import com.stripe.exception.ApiConnectionException; import com.stripe.exception.StripeException; +import java.io.InputStream; import java.net.ConnectException; import java.net.SocketTimeoutException; import java.time.Duration; import java.util.HashMap; import java.util.Map; +import java.util.Optional; +import java.util.Properties; import java.util.concurrent.ThreadLocalRandom; /** Base abstract class for HTTP clients used to send requests to Stripe's API. */ @@ -176,10 +180,31 @@ protected static String buildXStripeClientUserAgentString() { if (Stripe.getAppInfo() != null) { propertyMap.put("application", ApiResource.INTERNAL_GSON.toJson(Stripe.getAppInfo())); } + getGsonVersion().ifPresent(ver -> propertyMap.put("gson.version", ver)); return ApiResource.INTERNAL_GSON.toJson(propertyMap); } + /** + * Gets the Gson version being used at runtime. + * + * @return the Gson version string, or Optional.empty() if it cannot be determined + */ + private static Optional getGsonVersion() { + try (InputStream in = + Gson.class.getResourceAsStream( + "/META-INF/maven/com.google.code.gson/gson/pom.properties")) { + if (in != null) { + Properties props = new Properties(); + props.load(in); + return Optional.ofNullable(props.getProperty("version")); + } + } catch (Exception ignore) { + // Silently ignore - we'll just not include the version + } + return Optional.empty(); + } + private static String formatAppInfo(Map info) { String str = info.get("name"); diff --git a/src/main/java/com/stripe/param/AccountCreateParams.java b/src/main/java/com/stripe/param/AccountCreateParams.java index 9281c17fe64..39ec32e30cb 100644 --- a/src/main/java/com/stripe/param/AccountCreateParams.java +++ b/src/main/java/com/stripe/param/AccountCreateParams.java @@ -16,8 +16,8 @@ @EqualsAndHashCode(callSuper = false) public class AccountCreateParams extends ApiRequestParams { /** - * An account token, used to - * securely provide details to the account. + * An account token, used to securely + * provide details to the account. */ @SerializedName("account_token") String accountToken; @@ -153,7 +153,7 @@ public class AccountCreateParams extends ApiRequestParams { Individual individual; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -305,8 +305,8 @@ public AccountCreateParams build() { } /** - * An account token, used to - * securely provide details to the account. + * An account token, used to securely + * provide details to the account. */ public Builder setAccountToken(String accountToken) { this.accountToken = accountToken; @@ -536,7 +536,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -547,7 +547,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1181,7 +1181,10 @@ public static class SupportAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1294,7 +1297,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -9035,7 +9041,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -9148,7 +9157,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -9978,11 +9990,10 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ @SerializedName("back") String back; @@ -9998,11 +10009,10 @@ public static class Document { Map extraParams; /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ @SerializedName("front") String front; @@ -10031,11 +10041,10 @@ public AccountCreateParams.Company.Verification.Document build() { } /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -10071,11 +10080,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -10354,7 +10362,7 @@ public static class Application { /** * Required. Whether the controller is liable for losses on this account. For - * details, see Understanding + * details, see Understanding * Connect Account Balances. */ @SerializedName("loss_liable") @@ -10428,7 +10436,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Whether the controller is liable for losses on this account. - * For details, see Understanding + * For details, see Understanding * Connect Account Balances. */ public Builder setLossLiable(Boolean lossLiable) { @@ -11096,9 +11104,8 @@ public static class BankAccountOwnershipVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11197,9 +11204,8 @@ public static class CompanyLicense { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11292,9 +11298,8 @@ public static class CompanyMemorandumOfAssociation { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11390,9 +11395,8 @@ public static class CompanyMinisterialDecree { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11488,9 +11492,8 @@ public static class CompanyRegistrationVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11588,9 +11591,8 @@ public static class CompanyTaxIdVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11686,9 +11688,8 @@ public static class ProofOfAddress { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11781,16 +11782,20 @@ public static class ProofOfRegistration { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; - private ProofOfRegistration(Map extraParams, List files) { + @SerializedName("signer") + Signer signer; + + private ProofOfRegistration( + Map extraParams, List files, Signer signer) { this.extraParams = extraParams; this.files = files; + this.signer = signer; } public static Builder builder() { @@ -11802,10 +11807,12 @@ public static class Builder { private List files; + private Signer signer; + /** Finalize and obtain parameter instance from this builder. */ public AccountCreateParams.Documents.ProofOfRegistration build() { return new AccountCreateParams.Documents.ProofOfRegistration( - this.extraParams, this.files); + this.extraParams, this.files, this.signer); } /** @@ -11861,6 +11868,84 @@ public Builder addAllFile(List elements) { this.files.addAll(elements); return this; } + + public Builder setSigner(AccountCreateParams.Documents.ProofOfRegistration.Signer signer) { + this.signer = signer; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Signer { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The token of the person signing the document, if applicable. */ + @SerializedName("person") + String person; + + private Signer(Map extraParams, String person) { + this.extraParams = extraParams; + this.person = person; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String person; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountCreateParams.Documents.ProofOfRegistration.Signer build() { + return new AccountCreateParams.Documents.ProofOfRegistration.Signer( + this.extraParams, this.person); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountCreateParams.Documents.ProofOfRegistration.Signer#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountCreateParams.Documents.ProofOfRegistration.Signer#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(String person) { + this.person = person; + return this; + } + } } } @@ -11877,17 +11962,20 @@ public static class ProofOfUltimateBeneficialOwnership { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; + @SerializedName("signer") + Signer signer; + private ProofOfUltimateBeneficialOwnership( - Map extraParams, List files) { + Map extraParams, List files, Signer signer) { this.extraParams = extraParams; this.files = files; + this.signer = signer; } public static Builder builder() { @@ -11899,10 +11987,12 @@ public static class Builder { private List files; + private Signer signer; + /** Finalize and obtain parameter instance from this builder. */ public AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership build() { return new AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership( - this.extraParams, this.files); + this.extraParams, this.files, this.signer); } /** @@ -11962,6 +12052,87 @@ public Builder addAllFile(List elements) { this.files.addAll(elements); return this; } + + public Builder setSigner( + AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer signer) { + this.signer = signer; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Signer { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The token of the person signing the document, if applicable. */ + @SerializedName("person") + String person; + + private Signer(Map extraParams, String person) { + this.extraParams = extraParams; + this.person = person; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String person; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer build() { + return new AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer( + this.extraParams, this.person); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountCreateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(String person) { + this.person = person; + return this; + } + } } } } @@ -11980,7 +12151,7 @@ public static class Groups { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ @SerializedName("payments_pricing") @@ -12033,7 +12204,7 @@ public Builder putAllExtraParam(Map map) { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ public Builder setPaymentsPricing(String paymentsPricing) { @@ -12043,7 +12214,7 @@ public Builder setPaymentsPricing(String paymentsPricing) { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ public Builder setPaymentsPricing(EmptyParam paymentsPricing) { @@ -12142,7 +12313,7 @@ public static class Individual { String maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -12532,7 +12703,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -12543,7 +12714,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -12646,7 +12817,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -12759,7 +12933,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -13242,7 +13419,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -13355,7 +13535,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -13817,7 +14000,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13836,7 +14019,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13868,7 +14051,7 @@ public AccountCreateParams.Individual.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13909,7 +14092,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13925,7 +14108,7 @@ public Builder setFront(String front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13944,7 +14127,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13976,7 +14159,7 @@ public AccountCreateParams.Individual.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -14015,7 +14198,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -14049,7 +14232,7 @@ public enum PoliticalExposure implements ApiRequestParams.EnumParam { public static class RiskControls { /** * Represents the risk control status of charges. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ @SerializedName("charges") @@ -14066,7 +14249,7 @@ public static class RiskControls { /** * Represents the risk control status of payouts. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ @SerializedName("payouts") @@ -14096,7 +14279,7 @@ public AccountCreateParams.RiskControls build() { /** * Represents the risk control status of charges. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ public Builder setCharges(AccountCreateParams.RiskControls.Charges charges) { @@ -14132,7 +14315,7 @@ public Builder putAllExtraParam(Map map) { /** * Represents the risk control status of payouts. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ public Builder setPayouts(AccountCreateParams.RiskControls.Payouts payouts) { diff --git a/src/main/java/com/stripe/param/AccountExternalAccountCreateParams.java b/src/main/java/com/stripe/param/AccountExternalAccountCreateParams.java index be3e016fde4..d429bd588b8 100644 --- a/src/main/java/com/stripe/param/AccountExternalAccountCreateParams.java +++ b/src/main/java/com/stripe/param/AccountExternalAccountCreateParams.java @@ -26,7 +26,7 @@ public class AccountExternalAccountCreateParams extends ApiRequestParams { /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ @@ -43,7 +43,7 @@ public class AccountExternalAccountCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -126,7 +126,7 @@ public Builder addAllExpand(List elements) { /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ @@ -137,7 +137,7 @@ public Builder setExternalAccount(String externalAccount) { /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ @@ -148,7 +148,7 @@ public Builder setExternalAccount(AccountExternalAccountCreateParams.Card extern /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ @@ -160,7 +160,7 @@ public Builder setExternalAccount( /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ diff --git a/src/main/java/com/stripe/param/AccountExternalAccountUpdateParams.java b/src/main/java/com/stripe/param/AccountExternalAccountUpdateParams.java index 3c53284bdfb..f1b5486e447 100644 --- a/src/main/java/com/stripe/param/AccountExternalAccountUpdateParams.java +++ b/src/main/java/com/stripe/param/AccountExternalAccountUpdateParams.java @@ -86,7 +86,7 @@ public class AccountExternalAccountUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -425,7 +425,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -436,7 +436,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -557,9 +557,8 @@ public static class BankAccountOwnershipVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; diff --git a/src/main/java/com/stripe/param/AccountNoticeUpdateParams.java b/src/main/java/com/stripe/param/AccountNoticeUpdateParams.java index e61ac6a75a6..9e0f1c6ef65 100644 --- a/src/main/java/com/stripe/param/AccountNoticeUpdateParams.java +++ b/src/main/java/com/stripe/param/AccountNoticeUpdateParams.java @@ -32,7 +32,7 @@ public class AccountNoticeUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/AccountPersonCreateParams.java b/src/main/java/com/stripe/param/AccountPersonCreateParams.java index 6fff20183b2..7322fdc4eea 100644 --- a/src/main/java/com/stripe/param/AccountPersonCreateParams.java +++ b/src/main/java/com/stripe/param/AccountPersonCreateParams.java @@ -117,7 +117,7 @@ public class AccountPersonCreateParams extends ApiRequestParams { String maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -599,7 +599,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -610,7 +610,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -929,7 +929,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1040,7 +1043,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1606,9 +1612,8 @@ public static class CompanyAuthorization { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1704,9 +1709,8 @@ public static class Passport { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1799,9 +1803,8 @@ public static class Visa { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1917,7 +1920,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -2029,7 +2035,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -2972,7 +2981,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -2990,7 +2999,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3022,7 +3031,7 @@ public AccountPersonCreateParams.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3061,7 +3070,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3077,7 +3086,7 @@ public Builder setFront(String front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3095,7 +3104,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3127,7 +3136,7 @@ public AccountPersonCreateParams.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3166,7 +3175,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. diff --git a/src/main/java/com/stripe/param/AccountPersonUpdateParams.java b/src/main/java/com/stripe/param/AccountPersonUpdateParams.java index f389ddf8492..d16dab7c69b 100644 --- a/src/main/java/com/stripe/param/AccountPersonUpdateParams.java +++ b/src/main/java/com/stripe/param/AccountPersonUpdateParams.java @@ -117,7 +117,7 @@ public class AccountPersonUpdateParams extends ApiRequestParams { Object maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -679,7 +679,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -690,7 +690,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1046,7 +1046,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -1190,13 +1193,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -1852,9 +1861,8 @@ public static class CompanyAuthorization { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1950,9 +1958,8 @@ public static class Passport { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -2045,9 +2052,8 @@ public static class Visa { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -2163,7 +2169,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -2308,13 +2317,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -3301,7 +3316,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3319,7 +3334,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3351,7 +3366,7 @@ public AccountPersonUpdateParams.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3362,7 +3377,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3401,7 +3416,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3412,7 +3427,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3428,7 +3443,7 @@ public Builder setFront(EmptyParam front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3446,7 +3461,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3478,7 +3493,7 @@ public AccountPersonUpdateParams.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3489,7 +3504,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3528,7 +3543,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3539,7 +3554,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. diff --git a/src/main/java/com/stripe/param/AccountSessionCreateParams.java b/src/main/java/com/stripe/param/AccountSessionCreateParams.java index fba818b6717..32e918b94bd 100644 --- a/src/main/java/com/stripe/param/AccountSessionCreateParams.java +++ b/src/main/java/com/stripe/param/AccountSessionCreateParams.java @@ -210,6 +210,14 @@ public static class Components { @SerializedName("capital_overview") CapitalOverview capitalOverview; + /** + * Configuration for the check + * scanning embedded component. + */ + @SerializedName("check_scanning") + CheckScanning checkScanning; + /** * Configuration for the disputes @@ -405,6 +413,7 @@ private Components( CapitalFinancingApplication capitalFinancingApplication, CapitalFinancingPromotion capitalFinancingPromotion, CapitalOverview capitalOverview, + CheckScanning checkScanning, DisputesList disputesList, Documents documents, ExportTaxTransactions exportTaxTransactions, @@ -437,6 +446,7 @@ private Components( this.capitalFinancingApplication = capitalFinancingApplication; this.capitalFinancingPromotion = capitalFinancingPromotion; this.capitalOverview = capitalOverview; + this.checkScanning = checkScanning; this.disputesList = disputesList; this.documents = documents; this.exportTaxTransactions = exportTaxTransactions; @@ -485,6 +495,8 @@ public static class Builder { private CapitalOverview capitalOverview; + private CheckScanning checkScanning; + private DisputesList disputesList; private Documents documents; @@ -543,6 +555,7 @@ public AccountSessionCreateParams.Components build() { this.capitalFinancingApplication, this.capitalFinancingPromotion, this.capitalOverview, + this.checkScanning, this.disputesList, this.documents, this.exportTaxTransactions, @@ -666,6 +679,17 @@ public Builder setCapitalOverview( return this; } + /** + * Configuration for the check + * scanning embedded component. + */ + public Builder setCheckScanning( + AccountSessionCreateParams.Components.CheckScanning checkScanning) { + this.checkScanning = checkScanning; + return this; + } + /** * Configuration for the disputes @@ -2597,6 +2621,154 @@ public Builder putAllExtraParam(Map map) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class CheckScanning { + /** Required. Whether the embedded component is enabled. */ + @SerializedName("enabled") + Boolean enabled; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** An empty list, because this embedded component has no features. */ + @SerializedName("features") + Features features; + + private CheckScanning(Boolean enabled, Map extraParams, Features features) { + this.enabled = enabled; + this.extraParams = extraParams; + this.features = features; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Boolean enabled; + + private Map extraParams; + + private Features features; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountSessionCreateParams.Components.CheckScanning build() { + return new AccountSessionCreateParams.Components.CheckScanning( + this.enabled, this.extraParams, this.features); + } + + /** Required. Whether the embedded component is enabled. */ + public Builder setEnabled(Boolean enabled) { + this.enabled = enabled; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountSessionCreateParams.Components.CheckScanning#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountSessionCreateParams.Components.CheckScanning#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** An empty list, because this embedded component has no features. */ + public Builder setFeatures( + AccountSessionCreateParams.Components.CheckScanning.Features features) { + this.features = features; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Features { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private Features(Map extraParams) { + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountSessionCreateParams.Components.CheckScanning.Features build() { + return new AccountSessionCreateParams.Components.CheckScanning.Features( + this.extraParams); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountSessionCreateParams.Components.CheckScanning.Features#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountSessionCreateParams.Components.CheckScanning.Features#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class DisputesList { diff --git a/src/main/java/com/stripe/param/AccountUpdateParams.java b/src/main/java/com/stripe/param/AccountUpdateParams.java index dd3d0d37d5f..2c4d5b90728 100644 --- a/src/main/java/com/stripe/param/AccountUpdateParams.java +++ b/src/main/java/com/stripe/param/AccountUpdateParams.java @@ -16,8 +16,8 @@ @EqualsAndHashCode(callSuper = false) public class AccountUpdateParams extends ApiRequestParams { /** - * An account token, used to - * securely provide details to the account. + * An account token, used to securely + * provide details to the account. */ @SerializedName("account_token") Object accountToken; @@ -137,7 +137,7 @@ public class AccountUpdateParams extends ApiRequestParams { Individual individual; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -267,8 +267,8 @@ public AccountUpdateParams build() { } /** - * An account token, used to - * securely provide details to the account. + * An account token, used to securely + * provide details to the account. */ public Builder setAccountToken(String accountToken) { this.accountToken = accountToken; @@ -276,8 +276,8 @@ public Builder setAccountToken(String accountToken) { } /** - * An account token, used to - * securely provide details to the account. + * An account token, used to securely + * provide details to the account. */ public Builder setAccountToken(EmptyParam accountToken) { this.accountToken = accountToken; @@ -532,7 +532,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -543,7 +543,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1240,7 +1240,10 @@ public static class SupportAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -1386,13 +1389,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -9204,7 +9213,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -9350,13 +9362,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -10318,11 +10336,10 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ @SerializedName("back") Object back; @@ -10338,11 +10355,10 @@ public static class Document { Map extraParams; /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ @SerializedName("front") Object front; @@ -10371,11 +10387,10 @@ public AccountUpdateParams.Company.Verification.Document build() { } /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -10383,11 +10398,10 @@ public Builder setBack(String back) { } /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setBack(EmptyParam back) { this.back = back; @@ -10423,11 +10437,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -10435,11 +10448,10 @@ public Builder setFront(String front) { } /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ public Builder setFront(EmptyParam front) { this.front = front; @@ -10791,9 +10803,8 @@ public static class BankAccountOwnershipVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -10892,9 +10903,8 @@ public static class CompanyLicense { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -10987,9 +10997,8 @@ public static class CompanyMemorandumOfAssociation { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11085,9 +11094,8 @@ public static class CompanyMinisterialDecree { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11183,9 +11191,8 @@ public static class CompanyRegistrationVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11283,9 +11290,8 @@ public static class CompanyTaxIdVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11381,9 +11387,8 @@ public static class ProofOfAddress { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -11476,16 +11481,20 @@ public static class ProofOfRegistration { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; - private ProofOfRegistration(Map extraParams, List files) { + @SerializedName("signer") + Signer signer; + + private ProofOfRegistration( + Map extraParams, List files, Signer signer) { this.extraParams = extraParams; this.files = files; + this.signer = signer; } public static Builder builder() { @@ -11497,10 +11506,12 @@ public static class Builder { private List files; + private Signer signer; + /** Finalize and obtain parameter instance from this builder. */ public AccountUpdateParams.Documents.ProofOfRegistration build() { return new AccountUpdateParams.Documents.ProofOfRegistration( - this.extraParams, this.files); + this.extraParams, this.files, this.signer); } /** @@ -11556,6 +11567,90 @@ public Builder addAllFile(List elements) { this.files.addAll(elements); return this; } + + public Builder setSigner(AccountUpdateParams.Documents.ProofOfRegistration.Signer signer) { + this.signer = signer; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Signer { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The token of the person signing the document, if applicable. */ + @SerializedName("person") + Object person; + + private Signer(Map extraParams, Object person) { + this.extraParams = extraParams; + this.person = person; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object person; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountUpdateParams.Documents.ProofOfRegistration.Signer build() { + return new AccountUpdateParams.Documents.ProofOfRegistration.Signer( + this.extraParams, this.person); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountUpdateParams.Documents.ProofOfRegistration.Signer#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link AccountUpdateParams.Documents.ProofOfRegistration.Signer#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(String person) { + this.person = person; + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(EmptyParam person) { + this.person = person; + return this; + } + } } } @@ -11572,17 +11667,20 @@ public static class ProofOfUltimateBeneficialOwnership { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; + @SerializedName("signer") + Signer signer; + private ProofOfUltimateBeneficialOwnership( - Map extraParams, List files) { + Map extraParams, List files, Signer signer) { this.extraParams = extraParams; this.files = files; + this.signer = signer; } public static Builder builder() { @@ -11594,10 +11692,12 @@ public static class Builder { private List files; + private Signer signer; + /** Finalize and obtain parameter instance from this builder. */ public AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership build() { return new AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership( - this.extraParams, this.files); + this.extraParams, this.files, this.signer); } /** @@ -11657,6 +11757,93 @@ public Builder addAllFile(List elements) { this.files.addAll(elements); return this; } + + public Builder setSigner( + AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer signer) { + this.signer = signer; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Signer { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The token of the person signing the document, if applicable. */ + @SerializedName("person") + Object person; + + private Signer(Map extraParams, Object person) { + this.extraParams = extraParams; + this.person = person; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object person; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer build() { + return new AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer( + this.extraParams, this.person); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * AccountUpdateParams.Documents.ProofOfUltimateBeneficialOwnership.Signer#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(String person) { + this.person = person; + return this; + } + + /** The token of the person signing the document, if applicable. */ + public Builder setPerson(EmptyParam person) { + this.person = person; + return this; + } + } } } } @@ -11675,7 +11862,7 @@ public static class Groups { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ @SerializedName("payments_pricing") @@ -11728,7 +11915,7 @@ public Builder putAllExtraParam(Map map) { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ public Builder setPaymentsPricing(String paymentsPricing) { @@ -11738,7 +11925,7 @@ public Builder setPaymentsPricing(String paymentsPricing) { /** * The group the account is in to determine their payments pricing, and null if the account is - * on customized pricing. See + * on customized pricing. See * the Platform pricing tool documentation for details. */ public Builder setPaymentsPricing(EmptyParam paymentsPricing) { @@ -11837,7 +12024,7 @@ public static class Individual { Object maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -12305,7 +12492,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -12316,7 +12503,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -12431,7 +12618,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -12577,13 +12767,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -13156,7 +13352,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -13302,13 +13501,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -13796,7 +14001,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13815,7 +14020,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13847,7 +14052,7 @@ public AccountUpdateParams.Individual.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13858,7 +14063,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13899,7 +14104,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13910,7 +14115,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13926,7 +14131,7 @@ public Builder setFront(EmptyParam front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13945,7 +14150,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -13977,7 +14182,7 @@ public AccountUpdateParams.Individual.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -13988,7 +14193,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -14027,7 +14232,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -14038,7 +14243,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -14072,7 +14277,7 @@ public enum PoliticalExposure implements ApiRequestParams.EnumParam { public static class RiskControls { /** * Represents the risk control status of charges. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ @SerializedName("charges") @@ -14089,7 +14294,7 @@ public static class RiskControls { /** * Represents the risk control status of payouts. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ @SerializedName("payouts") @@ -14119,7 +14324,7 @@ public AccountUpdateParams.RiskControls build() { /** * Represents the risk control status of charges. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ public Builder setCharges(AccountUpdateParams.RiskControls.Charges charges) { @@ -14155,7 +14360,7 @@ public Builder putAllExtraParam(Map map) { /** * Represents the risk control status of payouts. Please see this + * href="https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts">this * page for more details. */ public Builder setPayouts(AccountUpdateParams.RiskControls.Payouts payouts) { diff --git a/src/main/java/com/stripe/param/ApplicationFeeRefundCreateParams.java b/src/main/java/com/stripe/param/ApplicationFeeRefundCreateParams.java index 771046a7811..e95937dc9cb 100644 --- a/src/main/java/com/stripe/param/ApplicationFeeRefundCreateParams.java +++ b/src/main/java/com/stripe/param/ApplicationFeeRefundCreateParams.java @@ -34,7 +34,7 @@ public class ApplicationFeeRefundCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/ApplicationFeeRefundUpdateParams.java b/src/main/java/com/stripe/param/ApplicationFeeRefundUpdateParams.java index 4b3ab4d2fa0..8943675731c 100644 --- a/src/main/java/com/stripe/param/ApplicationFeeRefundUpdateParams.java +++ b/src/main/java/com/stripe/param/ApplicationFeeRefundUpdateParams.java @@ -28,7 +28,7 @@ public class ApplicationFeeRefundUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/BalanceTransferCreateParams.java b/src/main/java/com/stripe/param/BalanceTransferCreateParams.java index d2b80e15548..2c4a921cf6a 100644 --- a/src/main/java/com/stripe/param/BalanceTransferCreateParams.java +++ b/src/main/java/com/stripe/param/BalanceTransferCreateParams.java @@ -46,7 +46,7 @@ public class BalanceTransferCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CashBalanceUpdateParams.java b/src/main/java/com/stripe/param/CashBalanceUpdateParams.java index 18b3dfc32d0..00fdc2d1a3a 100644 --- a/src/main/java/com/stripe/param/CashBalanceUpdateParams.java +++ b/src/main/java/com/stripe/param/CashBalanceUpdateParams.java @@ -128,7 +128,7 @@ public static class Settings { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ @SerializedName("reconciliation_mode") ReconciliationMode reconciliationMode; @@ -182,7 +182,7 @@ public Builder putAllExtraParam(Map map) { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ public Builder setReconciliationMode( CashBalanceUpdateParams.Settings.ReconciliationMode reconciliationMode) { diff --git a/src/main/java/com/stripe/param/ChargeCaptureParams.java b/src/main/java/com/stripe/param/ChargeCaptureParams.java index 6c2c4c88207..0c3aecfd06f 100644 --- a/src/main/java/com/stripe/param/ChargeCaptureParams.java +++ b/src/main/java/com/stripe/param/ChargeCaptureParams.java @@ -78,7 +78,7 @@ public class ChargeCaptureParams extends ApiRequestParams { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. See the + * destination charge. See the * Connect documentation for details. */ @SerializedName("transfer_data") @@ -87,7 +87,7 @@ public class ChargeCaptureParams extends ApiRequestParams { /** * A string that identifies this transaction as part of a group. {@code transfer_group} may only * be provided if it has not been set. See the Connect + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect * documentation for details. */ @SerializedName("transfer_group") @@ -279,7 +279,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. See the + * destination charge. See the * Connect documentation for details. */ public Builder setTransferData(ChargeCaptureParams.TransferData transferData) { @@ -290,7 +290,7 @@ public Builder setTransferData(ChargeCaptureParams.TransferData transferData) { /** * A string that identifies this transaction as part of a group. {@code transfer_group} may only * be provided if it has not been set. See the Connect + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect * documentation for details. */ public Builder setTransferGroup(String transferGroup) { @@ -1679,7 +1679,10 @@ public static class PickupAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -1792,7 +1795,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1836,7 +1842,10 @@ public static class ReturnAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -1949,7 +1958,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -2871,7 +2883,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -2989,7 +3004,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3286,7 +3304,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3404,7 +3425,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4601,7 +4625,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -4714,7 +4741,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -8053,7 +8083,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -8166,7 +8199,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -9475,7 +9511,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -9593,7 +9632,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/ChargeCreateParams.java b/src/main/java/com/stripe/param/ChargeCreateParams.java index bc73185fe0e..52a2041671b 100644 --- a/src/main/java/com/stripe/param/ChargeCreateParams.java +++ b/src/main/java/com/stripe/param/ChargeCreateParams.java @@ -16,10 +16,10 @@ public class ChargeCreateParams extends ApiRequestParams { /** * Amount intended to be collected by this payment. A positive integer representing how much to - * charge in the smallest currency + * charge in the smallest currency * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The * minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -34,7 +34,7 @@ public class ChargeCreateParams extends ApiRequestParams { * application owner's Stripe account. The request must be made with an OAuth key or the {@code * Stripe-Account} header in order to take an application fee. For more information, see the * application fees documentation. + * href="https://docs.stripe.com/connect/direct-charges#collect-fees">documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; @@ -42,9 +42,9 @@ public class ChargeCreateParams extends ApiRequestParams { /** * Whether to immediately capture the charge. Defaults to {@code true}. When {@code false}, the * charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire + * href="https://api.stripe.com#capture_charge">captured later. Uncaptured charges expire * after a set number of days (7 by default). For more information, see the authorizing charges and settling + * href="https://docs.stripe.com/charges/placing-a-hold">authorizing charges and settling * later documentation. */ @SerializedName("capture") @@ -87,7 +87,7 @@ public class ChargeCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -96,16 +96,17 @@ public class ChargeCreateParams extends ApiRequestParams { Object metadata; /** - * The Stripe account ID for which these funds are intended. Automatically set if you use the - * {@code destination} parameter. For details, see Creating + * The Stripe account ID for which these funds are intended. You can specify the business of + * record as the connected account using the {@code on_behalf_of} attribute on the charge. For + * details, see Creating * Separate Charges and Transfers. */ @SerializedName("on_behalf_of") String onBehalfOf; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -113,9 +114,9 @@ public class ChargeCreateParams extends ApiRequestParams { /** * The email address to which this charge's receipt will be sent. The receipt will + * href="https://docs.stripe.com/dashboard/receipts">receipt will be sent. The receipt will * not be sent until the charge is paid, and no receipts will be sent for test mode charges. If - * this charge is for a Customer, the + * this charge is for a Customer, the * email address specified here will override the customer's email address. If {@code * receipt_email} is specified for a charge in live mode, a receipt will be sent regardless of * your email settings. @@ -129,15 +130,15 @@ public class ChargeCreateParams extends ApiRequestParams { /** * A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected + * href="https://docs.stripe.com/api#cards">card (i.e., credit or debit card), a bank account, a source, a token, or a connected * account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the + * href="https://docs.stripe.com/api#cards">cards, bank accounts, and attached sources---you must also pass the ID of the * associated customer. */ @SerializedName("source") @@ -168,7 +169,7 @@ public class ChargeCreateParams extends ApiRequestParams { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. See the + * destination charge. See the * Connect documentation for details. */ @SerializedName("transfer_data") @@ -176,7 +177,7 @@ public class ChargeCreateParams extends ApiRequestParams { /** * A string that identifies this transaction as part of a group. For details, see Grouping + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Grouping * transactions. */ @SerializedName("transfer_group") @@ -297,10 +298,10 @@ public ChargeCreateParams build() { /** * Amount intended to be collected by this payment. A positive integer representing how much to - * charge in the smallest currency + * charge in the smallest currency * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). * The minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -319,7 +320,7 @@ public Builder setApplicationFee(Long applicationFee) { * the application owner's Stripe account. The request must be made with an OAuth key or the * {@code Stripe-Account} header in order to take an application fee. For more information, see * the application fees documentation. + * href="https://docs.stripe.com/connect/direct-charges#collect-fees">documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -329,9 +330,9 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { /** * Whether to immediately capture the charge. Defaults to {@code true}. When {@code false}, the * charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges - * expire after a set number of days (7 by default). For more information, see the authorizing charges and settling + * href="https://api.stripe.com#capture_charge">captured later. Uncaptured charges expire + * after a set number of days (7 by default). For more information, see the authorizing charges and settling * later documentation. */ public Builder setCapture(Boolean capture) { @@ -452,7 +453,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -463,7 +464,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -474,9 +475,10 @@ public Builder setMetadata(Map metadata) { } /** - * The Stripe account ID for which these funds are intended. Automatically set if you use the - * {@code destination} parameter. For details, see Creating + * The Stripe account ID for which these funds are intended. You can specify the business of + * record as the connected account using the {@code on_behalf_of} attribute on the charge. For + * details, see Creating * Separate Charges and Transfers. */ public Builder setOnBehalfOf(String onBehalfOf) { @@ -485,7 +487,7 @@ public Builder setOnBehalfOf(String onBehalfOf) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions(ChargeCreateParams.RadarOptions radarOptions) { @@ -495,9 +497,9 @@ public Builder setRadarOptions(ChargeCreateParams.RadarOptions radarOptions) { /** * The email address to which this charge's receipt will be sent. The receipt will + * href="https://docs.stripe.com/dashboard/receipts">receipt will be sent. The receipt will * not be sent until the charge is paid, and no receipts will be sent for test mode charges. If - * this charge is for a Customer, the + * this charge is for a Customer, the * email address specified here will override the customer's email address. If {@code * receipt_email} is specified for a charge in live mode, a receipt will be sent regardless of * your email settings. @@ -515,15 +517,15 @@ public Builder setShipping(ChargeCreateParams.Shipping shipping) { /** * A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected + * href="https://docs.stripe.com/api#cards">card (i.e., credit or debit card), a bank account, a source, a token, or a connected * account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the + * href="https://docs.stripe.com/api#cards">cards, bank accounts, and attached sources---you must also pass the ID of the * associated customer. */ public Builder setSource(String source) { @@ -560,7 +562,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * An optional dictionary including the account to automatically transfer to as part of a - * destination charge. See the + * destination charge. See the * Connect documentation for details. */ public Builder setTransferData(ChargeCreateParams.TransferData transferData) { @@ -570,7 +572,7 @@ public Builder setTransferData(ChargeCreateParams.TransferData transferData) { /** * A string that identifies this transaction as part of a group. For details, see Grouping + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Grouping * transactions. */ public Builder setTransferGroup(String transferGroup) { @@ -682,7 +684,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -735,7 +737,7 @@ public Builder putAllExtraParam(Map map) { } /** - * 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. */ @@ -919,7 +921,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1032,7 +1037,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/ChargeSearchParams.java b/src/main/java/com/stripe/param/ChargeSearchParams.java index 541a8c15ab9..1df86bbf856 100644 --- a/src/main/java/com/stripe/param/ChargeSearchParams.java +++ b/src/main/java/com/stripe/param/ChargeSearchParams.java @@ -43,8 +43,8 @@ public class ChargeSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for charges. */ @SerializedName("query") @@ -153,8 +153,8 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for charges. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/ChargeUpdateParams.java b/src/main/java/com/stripe/param/ChargeUpdateParams.java index 6a280ffd29a..8c0fdfe61de 100644 --- a/src/main/java/com/stripe/param/ChargeUpdateParams.java +++ b/src/main/java/com/stripe/param/ChargeUpdateParams.java @@ -54,7 +54,7 @@ public class ChargeUpdateParams extends ApiRequestParams { FraudDetails fraudDetails; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -80,7 +80,7 @@ public class ChargeUpdateParams extends ApiRequestParams { /** * A string that identifies this transaction as part of a group. {@code transfer_group} may only * be provided if it has not been set. See the Connect + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect * documentation for details. */ @SerializedName("transfer_group") @@ -282,7 +282,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -293,7 +293,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -336,7 +336,7 @@ public Builder setShipping(ChargeUpdateParams.Shipping shipping) { /** * A string that identifies this transaction as part of a group. {@code transfer_group} may only * be provided if it has not been set. See the Connect + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect * documentation for details. */ public Builder setTransferGroup(String transferGroup) { @@ -347,7 +347,7 @@ public Builder setTransferGroup(String transferGroup) { /** * A string that identifies this transaction as part of a group. {@code transfer_group} may only * be provided if it has not been set. See the Connect + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options">Connect * documentation for details. */ public Builder setTransferGroup(EmptyParam transferGroup) { @@ -1929,7 +1929,10 @@ public static class PickupAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -2075,13 +2078,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -2125,7 +2134,10 @@ public static class ReturnAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -2271,13 +2283,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -3257,7 +3275,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -3411,13 +3432,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -3732,7 +3759,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -3886,13 +3916,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -5148,7 +5184,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -5294,13 +5333,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -8936,7 +8981,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -9082,13 +9130,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -10508,7 +10562,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -10662,13 +10719,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -12060,7 +12123,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -12206,13 +12272,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/ConfirmationTokenCreateParams.java b/src/main/java/com/stripe/param/ConfirmationTokenCreateParams.java index d0a29f7522c..2e092fb7dca 100644 --- a/src/main/java/com/stripe/param/ConfirmationTokenCreateParams.java +++ b/src/main/java/com/stripe/param/ConfirmationTokenCreateParams.java @@ -47,7 +47,7 @@ public class ConfirmationTokenCreateParams extends ApiRequestParams { * 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. */ @@ -194,7 +194,7 @@ public Builder setReturnUrl(String returnUrl) { * 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. */ @@ -441,7 +441,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -555,7 +555,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -1472,7 +1472,7 @@ public Builder setQris(ConfirmationTokenCreateParams.PaymentMethodData.Qris qris } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -2494,7 +2494,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -2609,7 +2612,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3648,6 +3654,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -5368,7 +5377,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -5424,7 +5433,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -7249,7 +7258,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -7362,7 +7374,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/CouponCreateParams.java b/src/main/java/com/stripe/param/CouponCreateParams.java index e026516507e..ed8abfde592 100644 --- a/src/main/java/com/stripe/param/CouponCreateParams.java +++ b/src/main/java/com/stripe/param/CouponCreateParams.java @@ -86,7 +86,7 @@ public class CouponCreateParams extends ApiRequestParams { Long maxRedemptions; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -380,7 +380,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -391,7 +391,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CouponUpdateParams.java b/src/main/java/com/stripe/param/CouponUpdateParams.java index 5f1ece4d17a..2b1ee890b21 100644 --- a/src/main/java/com/stripe/param/CouponUpdateParams.java +++ b/src/main/java/com/stripe/param/CouponUpdateParams.java @@ -37,7 +37,7 @@ public class CouponUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -193,7 +193,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -204,7 +204,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CreditNoteCreateParams.java b/src/main/java/com/stripe/param/CreditNoteCreateParams.java index 53c7738c60f..1bb4ad959cb 100644 --- a/src/main/java/com/stripe/param/CreditNoteCreateParams.java +++ b/src/main/java/com/stripe/param/CreditNoteCreateParams.java @@ -73,7 +73,7 @@ public class CreditNoteCreateParams extends ApiRequestParams { String memo; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CreditNoteListParams.java b/src/main/java/com/stripe/param/CreditNoteListParams.java index e6e4bac3fe9..1b13ca0a6bc 100644 --- a/src/main/java/com/stripe/param/CreditNoteListParams.java +++ b/src/main/java/com/stripe/param/CreditNoteListParams.java @@ -21,7 +21,10 @@ public class CreditNoteListParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** Only return credit notes for the account specified by this account ID. */ + /** + * Only return credit notes for the account representing the customer specified by this account + * ID. + */ @SerializedName("customer_account") String customerAccount; @@ -143,7 +146,10 @@ public Builder setCustomer(String customer) { return this; } - /** Only return credit notes for the account specified by this account ID. */ + /** + * Only return credit notes for the account representing the customer specified by this account + * ID. + */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/CreditNotePreviewLinesListParams.java b/src/main/java/com/stripe/param/CreditNotePreviewLinesListParams.java index 4445a387a6b..ef2dc2f119e 100644 --- a/src/main/java/com/stripe/param/CreditNotePreviewLinesListParams.java +++ b/src/main/java/com/stripe/param/CreditNotePreviewLinesListParams.java @@ -89,7 +89,7 @@ public class CreditNotePreviewLinesListParams extends ApiRequestParams { String memo; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CreditNotePreviewParams.java b/src/main/java/com/stripe/param/CreditNotePreviewParams.java index 1ca061957bc..1619ae42160 100644 --- a/src/main/java/com/stripe/param/CreditNotePreviewParams.java +++ b/src/main/java/com/stripe/param/CreditNotePreviewParams.java @@ -73,7 +73,7 @@ public class CreditNotePreviewParams extends ApiRequestParams { String memo; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CreditNoteUpdateParams.java b/src/main/java/com/stripe/param/CreditNoteUpdateParams.java index 5c2e137323d..0d0e333e7a0 100644 --- a/src/main/java/com/stripe/param/CreditNoteUpdateParams.java +++ b/src/main/java/com/stripe/param/CreditNoteUpdateParams.java @@ -32,7 +32,7 @@ public class CreditNoteUpdateParams extends ApiRequestParams { Object memo; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java index 73951633ed7..69c60bbbeda 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionCreateParams.java @@ -25,7 +25,7 @@ public class CustomerBalanceTransactionCollectionCreateParams extends ApiRequest * Required. Three-letter ISO currency code, in lowercase. * Must be a supported currency. Specifies the {@code + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance">{@code * invoice_credit_balance} that this transaction will apply to. If the customer's {@code * currency} is not set, it will be updated to this value. */ @@ -50,7 +50,7 @@ public class CustomerBalanceTransactionCollectionCreateParams extends ApiRequest Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -115,7 +115,7 @@ public Builder setAmount(Long amount) { * href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code, in lowercase. * Must be a supported currency. Specifies the * {@code + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance">{@code * invoice_credit_balance} that this transaction will apply to. If the customer's {@code * currency} is not set, it will be updated to this value. */ @@ -213,7 +213,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -224,7 +224,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java index 686751224ce..a6d58919467 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionCollectionListParams.java @@ -39,6 +39,10 @@ public class CustomerBalanceTransactionCollectionListParams extends ApiRequestPa @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** Only return transactions that are related to the specified invoice. */ + @SerializedName("invoice") + String invoice; + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. @@ -60,12 +64,14 @@ private CustomerBalanceTransactionCollectionListParams( String endingBefore, List expand, Map extraParams, + String invoice, Long limit, String startingAfter) { this.created = created; this.endingBefore = endingBefore; this.expand = expand; this.extraParams = extraParams; + this.invoice = invoice; this.limit = limit; this.startingAfter = startingAfter; } @@ -83,6 +89,8 @@ public static class Builder { private Map extraParams; + private String invoice; + private Long limit; private String startingAfter; @@ -94,6 +102,7 @@ public CustomerBalanceTransactionCollectionListParams build() { this.endingBefore, this.expand, this.extraParams, + this.invoice, this.limit, this.startingAfter); } @@ -178,6 +187,12 @@ public Builder putAllExtraParam(Map map) { return this; } + /** Only return transactions that are related to the specified invoice. */ + public Builder setInvoice(String invoice) { + this.invoice = invoice; + return this; + } + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionCreateParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionCreateParams.java index 18402d47888..8b68b4dff7a 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionCreateParams.java @@ -25,7 +25,7 @@ public class CustomerBalanceTransactionCreateParams extends ApiRequestParams { * Required. Three-letter ISO currency code, in lowercase. * Must be a supported currency. Specifies the {@code + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance">{@code * invoice_credit_balance} that this transaction will apply to. If the customer's {@code * currency} is not set, it will be updated to this value. */ @@ -50,7 +50,7 @@ public class CustomerBalanceTransactionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -115,7 +115,7 @@ public Builder setAmount(Long amount) { * href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code, in lowercase. * Must be a supported currency. Specifies the * {@code + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance">{@code * invoice_credit_balance} that this transaction will apply to. If the customer's {@code * currency} is not set, it will be updated to this value. */ @@ -211,7 +211,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -222,7 +222,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionListParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionListParams.java index e2191f7e6da..6e9b6139559 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionListParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionListParams.java @@ -39,6 +39,10 @@ public class CustomerBalanceTransactionListParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** Only return transactions that are related to the specified invoice. */ + @SerializedName("invoice") + String invoice; + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. @@ -60,12 +64,14 @@ private CustomerBalanceTransactionListParams( String endingBefore, List expand, Map extraParams, + String invoice, Long limit, String startingAfter) { this.created = created; this.endingBefore = endingBefore; this.expand = expand; this.extraParams = extraParams; + this.invoice = invoice; this.limit = limit; this.startingAfter = startingAfter; } @@ -83,6 +89,8 @@ public static class Builder { private Map extraParams; + private String invoice; + private Long limit; private String startingAfter; @@ -94,6 +102,7 @@ public CustomerBalanceTransactionListParams build() { this.endingBefore, this.expand, this.extraParams, + this.invoice, this.limit, this.startingAfter); } @@ -177,6 +186,12 @@ public Builder putAllExtraParam(Map map) { return this; } + /** Only return transactions that are related to the specified invoice. */ + public Builder setInvoice(String invoice) { + this.invoice = invoice; + return this; + } + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java index 9e5cc313fd0..bc729a96273 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionUpdateParams.java @@ -32,7 +32,7 @@ public class CustomerBalanceTransactionUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -160,7 +160,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -171,7 +171,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java b/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java index cc2de9dd2d7..8911b15a3a4 100644 --- a/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java +++ b/src/main/java/com/stripe/param/CustomerBalanceTransactionsParams.java @@ -39,6 +39,10 @@ public class CustomerBalanceTransactionsParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** Only return transactions that are related to the specified invoice. */ + @SerializedName("invoice") + String invoice; + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. @@ -60,12 +64,14 @@ private CustomerBalanceTransactionsParams( String endingBefore, List expand, Map extraParams, + String invoice, Long limit, String startingAfter) { this.created = created; this.endingBefore = endingBefore; this.expand = expand; this.extraParams = extraParams; + this.invoice = invoice; this.limit = limit; this.startingAfter = startingAfter; } @@ -83,6 +89,8 @@ public static class Builder { private Map extraParams; + private String invoice; + private Long limit; private String startingAfter; @@ -94,6 +102,7 @@ public CustomerBalanceTransactionsParams build() { this.endingBefore, this.expand, this.extraParams, + this.invoice, this.limit, this.startingAfter); } @@ -177,6 +186,12 @@ public Builder putAllExtraParam(Map map) { return this; } + /** Only return transactions that are related to the specified invoice. */ + public Builder setInvoice(String invoice) { + this.invoice = invoice; + return this; + } + /** * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the * default is 10. diff --git a/src/main/java/com/stripe/param/CustomerCashBalanceUpdateParams.java b/src/main/java/com/stripe/param/CustomerCashBalanceUpdateParams.java index 4d475cb4c67..7e38ea7f9cd 100644 --- a/src/main/java/com/stripe/param/CustomerCashBalanceUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerCashBalanceUpdateParams.java @@ -128,7 +128,7 @@ public static class Settings { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ @SerializedName("reconciliation_mode") ReconciliationMode reconciliationMode; @@ -184,7 +184,7 @@ public Builder putAllExtraParam(Map map) { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ public Builder setReconciliationMode( CustomerCashBalanceUpdateParams.Settings.ReconciliationMode reconciliationMode) { diff --git a/src/main/java/com/stripe/param/CustomerCreateParams.java b/src/main/java/com/stripe/param/CustomerCreateParams.java index 18b6d44d0ad..e12cebfad7c 100644 --- a/src/main/java/com/stripe/param/CustomerCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerCreateParams.java @@ -14,7 +14,11 @@ @Getter @EqualsAndHashCode(callSuper = false) public class CustomerCreateParams extends ApiRequestParams { - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ @SerializedName("address") Object address; @@ -78,7 +82,7 @@ public class CustomerCreateParams extends ApiRequestParams { InvoiceSettings invoiceSettings; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -264,13 +268,21 @@ public CustomerCreateParams build() { this.validate); } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(CustomerCreateParams.Address address) { this.address = address; return this; } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(EmptyParam address) { this.address = address; return this; @@ -431,7 +443,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -442,7 +454,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -610,7 +622,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -722,7 +737,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -820,7 +838,7 @@ public static class Settings { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ @SerializedName("reconciliation_mode") ReconciliationMode reconciliationMode; @@ -877,7 +895,7 @@ public Builder putAllExtraParam(Map map) { * Controls how funds transferred by the customer are applied to payment intents and * invoices. Valid options are {@code automatic}, {@code manual}, or {@code * merchant_default}. For more information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ public Builder setReconciliationMode( CustomerCreateParams.CashBalance.Settings.ReconciliationMode reconciliationMode) { @@ -1436,7 +1454,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1550,7 +1571,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/CustomerFundCashBalanceParams.java b/src/main/java/com/stripe/param/CustomerFundCashBalanceParams.java index 465e795ce09..7ec577c0d1d 100644 --- a/src/main/java/com/stripe/param/CustomerFundCashBalanceParams.java +++ b/src/main/java/com/stripe/param/CustomerFundCashBalanceParams.java @@ -16,7 +16,7 @@ public class CustomerFundCashBalanceParams extends ApiRequestParams { /** * Required. Amount to be used for this test cash balance transaction. A positive * integer representing how much to fund in the smallest currency unit (e.g., 100 + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., 100 * cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ @SerializedName("amount") @@ -46,7 +46,7 @@ public class CustomerFundCashBalanceParams extends ApiRequestParams { /** * A description of the test funding. This simulates free-text references supplied by customers * when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">reconciliation * algorithm applies to different user inputs. */ @SerializedName("reference") @@ -89,7 +89,7 @@ public CustomerFundCashBalanceParams build() { /** * Required. Amount to be used for this test cash balance transaction. A * positive integer representing how much to fund in the smallest currency unit (e.g., 100 + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., 100 * cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ public Builder setAmount(Long amount) { @@ -162,7 +162,7 @@ public Builder putAllExtraParam(Map map) { /** * A description of the test funding. This simulates free-text references supplied by customers * when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">reconciliation * algorithm applies to different user inputs. */ public Builder setReference(String reference) { diff --git a/src/main/java/com/stripe/param/CustomerPaymentSourceCreateParams.java b/src/main/java/com/stripe/param/CustomerPaymentSourceCreateParams.java index 524ec69394e..590f0d922b2 100644 --- a/src/main/java/com/stripe/param/CustomerPaymentSourceCreateParams.java +++ b/src/main/java/com/stripe/param/CustomerPaymentSourceCreateParams.java @@ -27,7 +27,7 @@ public class CustomerPaymentSourceCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -37,7 +37,7 @@ public class CustomerPaymentSourceCreateParams extends ApiRequestParams { /** * Required. Please refer to full documentation instead. + * href="https://api.stripe.com">documentation instead. */ @SerializedName("source") String source; @@ -159,7 +159,7 @@ public Builder putAllMetadata(Map map) { /** * Required. Please refer to full documentation instead. + * href="https://api.stripe.com">documentation instead. */ public Builder setSource(String source) { this.source = source; diff --git a/src/main/java/com/stripe/param/CustomerPaymentSourceUpdateParams.java b/src/main/java/com/stripe/param/CustomerPaymentSourceUpdateParams.java index cfb835b3cf1..e53e3318ba6 100644 --- a/src/main/java/com/stripe/param/CustomerPaymentSourceUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerPaymentSourceUpdateParams.java @@ -71,7 +71,7 @@ public class CustomerPaymentSourceUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -373,7 +373,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -384,7 +384,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -575,7 +575,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -721,13 +724,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/CustomerSearchParams.java b/src/main/java/com/stripe/param/CustomerSearchParams.java index 94d5ea3e197..b1232c34303 100644 --- a/src/main/java/com/stripe/param/CustomerSearchParams.java +++ b/src/main/java/com/stripe/param/CustomerSearchParams.java @@ -43,8 +43,8 @@ public class CustomerSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for customers. */ @SerializedName("query") @@ -153,8 +153,8 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for customers. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/CustomerUpdateParams.java b/src/main/java/com/stripe/param/CustomerUpdateParams.java index c7bc87791f2..a13789bca39 100644 --- a/src/main/java/com/stripe/param/CustomerUpdateParams.java +++ b/src/main/java/com/stripe/param/CustomerUpdateParams.java @@ -14,7 +14,11 @@ @Getter @EqualsAndHashCode(callSuper = false) public class CustomerUpdateParams extends ApiRequestParams { - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ @SerializedName("address") Object address; @@ -37,14 +41,14 @@ public class CustomerUpdateParams extends ApiRequestParams { /** * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method">invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * *

If you want to add a new payment source and make it the default, see the source property. + * href="https://docs.stripe.com/api/customers/update#update_customer-source">source property. */ @SerializedName("default_source") Object defaultSource; @@ -92,7 +96,7 @@ public class CustomerUpdateParams extends ApiRequestParams { InvoiceSettings invoiceSettings; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -257,13 +261,21 @@ public CustomerUpdateParams build() { this.validate); } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(CustomerUpdateParams.Address address) { this.address = address; return this; } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(EmptyParam address) { this.address = address; return this; @@ -300,14 +312,14 @@ public Builder setCashBalance(CustomerUpdateParams.CashBalance cashBalance) { /** * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method">invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * *

If you want to add a new payment source and make it the default, see the source + * href="https://docs.stripe.com/api/customers/update#update_customer-source">source * property. */ public Builder setDefaultSource(String defaultSource) { @@ -317,14 +329,14 @@ public Builder setDefaultSource(String defaultSource) { /** * If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method">invoice_settings.default_payment_method * parameter. * *

Provide the ID of a payment source already attached to this customer to make it this * customer's default payment source. * *

If you want to add a new payment source and make it the default, see the source + * href="https://docs.stripe.com/api/customers/update#update_customer-source">source * property. */ public Builder setDefaultSource(EmptyParam defaultSource) { @@ -485,7 +497,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -496,7 +508,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -644,7 +656,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -790,13 +805,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -894,7 +915,7 @@ public static class Settings { * Controls how funds transferred by the customer are applied to payment intents and invoices. * Valid options are {@code automatic}, {@code manual}, or {@code merchant_default}. For more * information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ @SerializedName("reconciliation_mode") ReconciliationMode reconciliationMode; @@ -951,7 +972,7 @@ public Builder putAllExtraParam(Map map) { * Controls how funds transferred by the customer are applied to payment intents and * invoices. Valid options are {@code automatic}, {@code manual}, or {@code * merchant_default}. For more information about these reconciliation modes, see Reconciliation. + * href="https://docs.stripe.com/payments/customer-balance/reconciliation">Reconciliation. */ public Builder setReconciliationMode( CustomerUpdateParams.CashBalance.Settings.ReconciliationMode reconciliationMode) { @@ -1560,7 +1581,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -1708,13 +1732,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/DisputeUpdateParams.java b/src/main/java/com/stripe/param/DisputeUpdateParams.java index 929ea6f494e..ab5151b7c81 100644 --- a/src/main/java/com/stripe/param/DisputeUpdateParams.java +++ b/src/main/java/com/stripe/param/DisputeUpdateParams.java @@ -40,7 +40,7 @@ public class DisputeUpdateParams extends ApiRequestParams { IntendedSubmissionMethod intendedSubmissionMethod; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -197,7 +197,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -208,7 +208,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1613,7 +1613,10 @@ public static class ShippingAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -1764,13 +1767,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -2099,7 +2108,10 @@ public static class ShippingAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -2250,13 +2262,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java b/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java index 10be16b80d6..32e1c82052c 100644 --- a/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountCollectionCreateParams.java @@ -26,7 +26,7 @@ public class ExternalAccountCollectionCreateParams extends ApiRequestParams { /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ @@ -43,7 +43,7 @@ public class ExternalAccountCollectionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -126,7 +126,7 @@ public Builder addAllExpand(List elements) { /** * Required. A token, like the ones returned by Stripe.js or a dictionary containing a user's external + * href="https://docs.stripe.com/js">Stripe.js or a dictionary containing a user's external * account details (with the options shown below). Please refer to full documentation instead. */ diff --git a/src/main/java/com/stripe/param/ExternalAccountCreateParams.java b/src/main/java/com/stripe/param/ExternalAccountCreateParams.java index a69d1028bc3..4004b267733 100644 --- a/src/main/java/com/stripe/param/ExternalAccountCreateParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountCreateParams.java @@ -26,7 +26,7 @@ public class ExternalAccountCreateParams extends ApiRequestParams { /** * Required. Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s external + * href="https://docs.stripe.com/js">Stripe.js, or a dictionary containing a user’s external * account details (with the options shown below). */ @SerializedName("external_account") @@ -42,7 +42,7 @@ public class ExternalAccountCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -125,7 +125,7 @@ public Builder addAllExpand(List elements) { /** * Required. Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s external + * href="https://docs.stripe.com/js">Stripe.js, or a dictionary containing a user’s external * account details (with the options shown below). */ public Builder setExternalAccount(String externalAccount) { @@ -135,7 +135,7 @@ public Builder setExternalAccount(String externalAccount) { /** * Required. Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s external + * href="https://docs.stripe.com/js">Stripe.js, or a dictionary containing a user’s external * account details (with the options shown below). */ public Builder setExternalAccount(ExternalAccountCreateParams.Card externalAccount) { @@ -145,7 +145,7 @@ public Builder setExternalAccount(ExternalAccountCreateParams.Card externalAccou /** * Required. Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s external + * href="https://docs.stripe.com/js">Stripe.js, or a dictionary containing a user’s external * account details (with the options shown below). */ public Builder setExternalAccount(ExternalAccountCreateParams.BankAccount externalAccount) { @@ -155,7 +155,7 @@ public Builder setExternalAccount(ExternalAccountCreateParams.BankAccount extern /** * Required. Either a token, like the ones returned by Stripe.js, or a dictionary containing a user’s external + * href="https://docs.stripe.com/js">Stripe.js, or a dictionary containing a user’s external * account details (with the options shown below). */ public Builder setExternalAccount(ExternalAccountCreateParams.CardToken externalAccount) { diff --git a/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java b/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java index d53d3b5111c..5b9e4e24e23 100644 --- a/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java +++ b/src/main/java/com/stripe/param/ExternalAccountUpdateParams.java @@ -86,7 +86,7 @@ public class ExternalAccountUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -425,7 +425,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -436,7 +436,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -556,9 +556,8 @@ public static class BankAccountOwnershipVerification { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; diff --git a/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java b/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java index 8f418d60536..fbce9061ecd 100644 --- a/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/FeeRefundCollectionCreateParams.java @@ -34,7 +34,7 @@ public class FeeRefundCollectionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/FeeRefundUpdateParams.java b/src/main/java/com/stripe/param/FeeRefundUpdateParams.java index 518fe6fee37..d5d95789a4b 100644 --- a/src/main/java/com/stripe/param/FeeRefundUpdateParams.java +++ b/src/main/java/com/stripe/param/FeeRefundUpdateParams.java @@ -28,7 +28,7 @@ public class FeeRefundUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/FileCreateParams.java b/src/main/java/com/stripe/param/FileCreateParams.java index 665a984b1b9..050660b7e08 100644 --- a/src/main/java/com/stripe/param/FileCreateParams.java +++ b/src/main/java/com/stripe/param/FileCreateParams.java @@ -38,14 +38,14 @@ public class FileCreateParams extends ApiRequestParams { /** * Optional parameters that automatically create a file link for the newly created file. + * href="https://api.stripe.com#file_links">file link for the newly created file. */ @SerializedName("file_link_data") FileLinkData fileLinkData; /** * Required. The purpose of the uploaded file. + * href="https://docs.stripe.com/file-upload#uploading-a-file">purpose of the uploaded file. */ @SerializedName("purpose") Purpose purpose; @@ -156,7 +156,7 @@ public Builder setFile(File file) { /** * Optional parameters that automatically create a file link for the newly created file. + * href="https://api.stripe.com#file_links">file link for the newly created file. */ public Builder setFileLinkData(FileCreateParams.FileLinkData fileLinkData) { this.fileLinkData = fileLinkData; @@ -165,7 +165,7 @@ public Builder setFileLinkData(FileCreateParams.FileLinkData fileLinkData) { /** * Required. The purpose of the uploaded file. + * href="https://docs.stripe.com/file-upload#uploading-a-file">purpose of the uploaded file. */ public Builder setPurpose(FileCreateParams.Purpose purpose) { this.purpose = purpose; @@ -201,7 +201,7 @@ public static class FileLinkData { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -310,7 +310,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -321,7 +321,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/FileLinkCreateParams.java b/src/main/java/com/stripe/param/FileLinkCreateParams.java index 29436ba56f9..2463f784c69 100644 --- a/src/main/java/com/stripe/param/FileLinkCreateParams.java +++ b/src/main/java/com/stripe/param/FileLinkCreateParams.java @@ -43,7 +43,7 @@ public class FileLinkCreateParams extends ApiRequestParams { String file; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -185,7 +185,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -196,7 +196,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/FileLinkUpdateParams.java b/src/main/java/com/stripe/param/FileLinkUpdateParams.java index eb0d23c9e1d..51856d3d725 100644 --- a/src/main/java/com/stripe/param/FileLinkUpdateParams.java +++ b/src/main/java/com/stripe/param/FileLinkUpdateParams.java @@ -35,7 +35,7 @@ public class FileLinkUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -177,7 +177,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -188,7 +188,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/InvoiceAddLinesParams.java b/src/main/java/com/stripe/param/InvoiceAddLinesParams.java index e69cadbcb43..10de188bab8 100644 --- a/src/main/java/com/stripe/param/InvoiceAddLinesParams.java +++ b/src/main/java/com/stripe/param/InvoiceAddLinesParams.java @@ -29,7 +29,7 @@ public class InvoiceAddLinesParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -152,7 +152,7 @@ public Builder putAllInvoiceMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -163,7 +163,7 @@ public Builder setInvoiceMetadata(EmptyParam invoiceMetadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -256,7 +256,7 @@ public static class Line { Object margins; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -267,16 +267,16 @@ public static class Line { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") Period period; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -294,10 +294,10 @@ public static class Line { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes * on your own or use a third-party to calculate them. You cannot set tax amounts if any line * item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ @SerializedName("tax_amounts") @@ -581,7 +581,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -592,7 +592,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -605,9 +605,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceAddLinesParams.Line.Period period) { @@ -616,7 +616,7 @@ public Builder setPeriod(InvoiceAddLinesParams.Line.Period period) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(InvoiceAddLinesParams.Line.PriceData priceData) { @@ -668,10 +668,10 @@ public Builder addAllTaxAmount(List elemen * A list of up to 10 tax amounts for this line item. This can be useful if you calculate * taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any * line item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(EmptyParam taxAmounts) { @@ -683,10 +683,10 @@ public Builder setTaxAmounts(EmptyParam taxAmounts) { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate * taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any * line item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(List taxAmounts) { @@ -1230,7 +1230,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1362,7 +1362,7 @@ public Builder setProductData( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1423,7 +1423,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1437,10 +1437,18 @@ public static class ProductData { @SerializedName("name") String name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1455,6 +1463,7 @@ private ProductData( Map metadata, String name, String taxCode, + TaxDetails taxDetails, String unitLabel) { this.description = description; this.extraParams = extraParams; @@ -1462,6 +1471,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -1482,6 +1492,8 @@ public static class Builder { private String taxCode; + private TaxDetails taxDetails; + private String unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -1493,6 +1505,7 @@ public InvoiceAddLinesParams.Line.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -1596,12 +1609,23 @@ public Builder setName(String name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + InvoiceAddLinesParams.Line.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1611,6 +1635,87 @@ public Builder setUnitLabel(String unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + String taxCode; + + private TaxDetails(Map extraParams, String taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceAddLinesParams.Line.PriceData.ProductData.TaxDetails build() { + return new InvoiceAddLinesParams.Line.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceAddLinesParams.Line.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceAddLinesParams.Line.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } public enum TaxBehavior implements ApiRequestParams.EnumParam { diff --git a/src/main/java/com/stripe/param/InvoiceAttachPaymentParams.java b/src/main/java/com/stripe/param/InvoiceAttachPaymentParams.java index 6d77592e000..04bdaf97dd7 100644 --- a/src/main/java/com/stripe/param/InvoiceAttachPaymentParams.java +++ b/src/main/java/com/stripe/param/InvoiceAttachPaymentParams.java @@ -191,7 +191,7 @@ public static class PaymentRecordData { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -330,7 +330,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -341,7 +341,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/InvoiceCreateParams.java b/src/main/java/com/stripe/param/InvoiceCreateParams.java index c7db5b18f95..a60f4b3d0aa 100644 --- a/src/main/java/com/stripe/param/InvoiceCreateParams.java +++ b/src/main/java/com/stripe/param/InvoiceCreateParams.java @@ -30,14 +30,14 @@ public class InvoiceCreateParams extends ApiRequestParams { * application owner's Stripe account. The request must be made with an OAuth key or the * Stripe-Account header in order to take an application fee. For more information, see the * application fees documentation. + * href="https://docs.stripe.com/billing/invoices/connect#collecting-fees">documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. If {@code false}, the invoice's state doesn't automatically * advance without an explicit action. Defaults to false. */ @@ -74,11 +74,11 @@ public class InvoiceCreateParams extends ApiRequestParams { @SerializedName("custom_fields") Object customFields; - /** The ID of the customer who will be billed. */ + /** The ID of the customer to bill. */ @SerializedName("customer") String customer; - /** The ID of the account who will be billed. */ + /** The ID of the account to bill. */ @SerializedName("customer_account") String customerAccount; @@ -164,7 +164,7 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * Revise an existing invoice. The new invoice will be created in {@code status=draft}. See the revision documentation for more + * href="https://docs.stripe.com/invoicing/invoice-revisions">revision documentation for more * details. */ @SerializedName("from_invoice") @@ -178,7 +178,7 @@ public class InvoiceCreateParams extends ApiRequestParams { Issuer issuer; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -200,7 +200,7 @@ public class InvoiceCreateParams extends ApiRequestParams { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -549,7 +549,7 @@ public Builder setAmountsDue(List amountsDue) { * the application owner's Stripe account. The request must be made with an OAuth key or the * Stripe-Account header in order to take an application fee. For more information, see the * application fees documentation. + * href="https://docs.stripe.com/billing/invoices/connect#collecting-fees">documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -558,7 +558,7 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. If {@code false}, the invoice's state doesn't automatically * advance without an explicit action. Defaults to false. */ @@ -642,13 +642,13 @@ public Builder setCustomFields(List customField return this; } - /** The ID of the customer who will be billed. */ + /** The ID of the customer to bill. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The ID of the account who will be billed. */ + /** The ID of the account to bill. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; @@ -871,7 +871,7 @@ public Builder setFooter(String footer) { /** * Revise an existing invoice. The new invoice will be created in {@code status=draft}. See the - * revision documentation for + * revision documentation for * more details. */ public Builder setFromInvoice(InvoiceCreateParams.FromInvoice fromInvoice) { @@ -917,7 +917,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -928,7 +928,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -954,7 +954,7 @@ public Builder setNumber(String number) { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ public Builder setOnBehalfOf(String onBehalfOf) { @@ -1161,7 +1161,7 @@ public static class AutomaticTax { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ @SerializedName("enabled") @@ -1209,7 +1209,7 @@ public InvoiceCreateParams.AutomaticTax build() { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ public Builder setEnabled(Boolean enabled) { @@ -2227,6 +2227,13 @@ public static class PaymentMethodOptions { @SerializedName("konbini") Object konbini; + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + @SerializedName("payto") + Object payto; + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -2263,6 +2270,7 @@ private PaymentMethodOptions( Map extraParams, Object idBankTransfer, Object konbini, + Object payto, Object pix, Object sepaDebit, Object upi, @@ -2274,6 +2282,7 @@ private PaymentMethodOptions( this.extraParams = extraParams; this.idBankTransfer = idBankTransfer; this.konbini = konbini; + this.payto = payto; this.pix = pix; this.sepaDebit = sepaDebit; this.upi = upi; @@ -2299,6 +2308,8 @@ public static class Builder { private Object konbini; + private Object payto; + private Object pix; private Object sepaDebit; @@ -2317,6 +2328,7 @@ public InvoiceCreateParams.PaymentSettings.PaymentMethodOptions build() { this.extraParams, this.idBankTransfer, this.konbini, + this.payto, this.pix, this.sepaDebit, this.upi, @@ -2466,6 +2478,25 @@ public Builder setKonbini(EmptyParam konbini) { return this; } + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + public Builder setPayto( + InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto payto) { + this.payto = payto; + return this; + } + + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + public Builder setPayto(EmptyParam payto) { + this.payto = payto; + return this; + } + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -2869,7 +2900,7 @@ public static class Card { * Installment configuration for payments attempted on this invoice. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ @SerializedName("installments") Installments installments; @@ -2877,10 +2908,10 @@ public static class Card { /** * 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. */ @@ -2947,7 +2978,7 @@ public Builder putAllExtraParam(Map map) { * Installment configuration for payments attempted on this invoice. * *

For more information, see the installments integration + * href="https://docs.stripe.com/payments/installments">installments integration * guide. */ public Builder setInstallments( @@ -2960,10 +2991,10 @@ public Builder setInstallments( /** * 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. */ @@ -3670,6 +3701,229 @@ public Builder putAllExtraParam(Map map) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Payto { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Additional fields for Mandate creation. */ + @SerializedName("mandate_options") + MandateOptions mandateOptions; + + private Payto(Map extraParams, MandateOptions mandateOptions) { + this.extraParams = extraParams; + this.mandateOptions = mandateOptions; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private MandateOptions mandateOptions; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto build() { + return new InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto( + this.extraParams, this.mandateOptions); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Additional fields for Mandate creation. */ + public Builder setMandateOptions( + InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + mandateOptions) { + this.mandateOptions = mandateOptions; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class MandateOptions { + /** + * 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; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + @SerializedName("purpose") + Purpose purpose; + + private MandateOptions(Long amount, Map extraParams, Purpose purpose) { + this.amount = amount; + this.extraParams = extraParams; + this.purpose = purpose; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Long amount; + + private Map extraParams; + + private Purpose purpose; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + build() { + return new InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions(this.amount, this.extraParams, this.purpose); + } + + /** + * The maximum amount that can be collected in a single invoice. If you don't specify a + * maximum, then there is no limit. + */ + public Builder setAmount(Long amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose( + InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + .Purpose + purpose) { + this.purpose = purpose; + return this; + } + } + + public enum Purpose implements ApiRequestParams.EnumParam { + @SerializedName("dependant_support") + DEPENDANT_SUPPORT("dependant_support"), + + @SerializedName("government") + GOVERNMENT("government"), + + @SerializedName("loan") + LOAN("loan"), + + @SerializedName("mortgage") + MORTGAGE("mortgage"), + + @SerializedName("other") + OTHER("other"), + + @SerializedName("pension") + PENSION("pension"), + + @SerializedName("personal") + PERSONAL("personal"), + + @SerializedName("retail") + RETAIL("retail"), + + @SerializedName("salary") + SALARY("salary"), + + @SerializedName("tax") + TAX("tax"), + + @SerializedName("utility") + UTILITY("utility"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Purpose(String value) { + this.value = value; + } + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Pix { @@ -4669,6 +4923,9 @@ public enum PaymentMethodType implements ApiRequestParams.EnumParam { @SerializedName("paypal") PAYPAL("paypal"), + @SerializedName("payto") + PAYTO("payto"), + @SerializedName("pix") PIX("pix"), @@ -5083,7 +5340,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -5099,7 +5356,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -5257,7 +5514,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { @@ -6052,7 +6309,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -6165,7 +6425,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/InvoiceCreatePreviewParams.java b/src/main/java/com/stripe/param/InvoiceCreatePreviewParams.java index 66be2939fa3..19b0f9dc27b 100644 --- a/src/main/java/com/stripe/param/InvoiceCreatePreviewParams.java +++ b/src/main/java/com/stripe/param/InvoiceCreatePreviewParams.java @@ -20,9 +20,9 @@ public class InvoiceCreatePreviewParams extends ApiRequestParams { AutomaticTax automaticTax; /** - * The identifier of the billing cadence for which you’d like to retrieve the upcoming - * invoice.Cannot be provided when {@code subscription}, {@code schedule}, {@code - * subscription_details} or {@code schedule_details} are provided. + * The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice. + * Cannot be provided when {@code subscription}, {@code schedule}, {@code subscription_details} or + * {@code schedule_details} are provided. */ @SerializedName("billing_cadence") String billingCadence; @@ -34,7 +34,7 @@ public class InvoiceCreatePreviewParams extends ApiRequestParams { String currency; /** - * The identifier of the customer whose upcoming invoice you'd like to retrieve. If {@code + * The identifier of the customer whose upcoming invoice you're retrieving. If {@code * automatic_tax} is enabled then one of {@code customer}, {@code customer_details}, {@code * subscription}, or {@code schedule} must be set. */ @@ -42,9 +42,10 @@ public class InvoiceCreatePreviewParams extends ApiRequestParams { String customer; /** - * The identifier of the account whose upcoming invoice you'd like to retrieve. If {@code - * automatic_tax} is enabled then one of {@code customer}, {@code customer_account}, {@code - * customer_details}, {@code subscription}, or {@code schedule} must be set. + * The identifier of the account representing the customer whose upcoming invoice you're + * retrieving. If {@code automatic_tax} is enabled then one of {@code customer}, {@code + * customer_account}, {@code customer_details}, {@code subscription}, or {@code schedule} must be + * set. */ @SerializedName("customer_account") String customerAccount; @@ -93,7 +94,7 @@ public class InvoiceCreatePreviewParams extends ApiRequestParams { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -242,9 +243,9 @@ public Builder setAutomaticTax(InvoiceCreatePreviewParams.AutomaticTax automatic } /** - * The identifier of the billing cadence for which you’d like to retrieve the upcoming - * invoice.Cannot be provided when {@code subscription}, {@code schedule}, {@code - * subscription_details} or {@code schedule_details} are provided. + * The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice. + * Cannot be provided when {@code subscription}, {@code schedule}, {@code subscription_details} + * or {@code schedule_details} are provided. */ public Builder setBillingCadence(String billingCadence) { this.billingCadence = billingCadence; @@ -261,7 +262,7 @@ public Builder setCurrency(String currency) { } /** - * The identifier of the customer whose upcoming invoice you'd like to retrieve. If {@code + * The identifier of the customer whose upcoming invoice you're retrieving. If {@code * automatic_tax} is enabled then one of {@code customer}, {@code customer_details}, {@code * subscription}, or {@code schedule} must be set. */ @@ -271,9 +272,10 @@ public Builder setCustomer(String customer) { } /** - * The identifier of the account whose upcoming invoice you'd like to retrieve. If {@code - * automatic_tax} is enabled then one of {@code customer}, {@code customer_account}, {@code - * customer_details}, {@code subscription}, or {@code schedule} must be set. + * The identifier of the account representing the customer whose upcoming invoice you're + * retrieving. If {@code automatic_tax} is enabled then one of {@code customer}, {@code + * customer_account}, {@code customer_details}, {@code subscription}, or {@code schedule} must + * be set. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; @@ -430,7 +432,7 @@ public Builder setIssuer(InvoiceCreatePreviewParams.Issuer issuer) { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ public Builder setOnBehalfOf(String onBehalfOf) { @@ -441,7 +443,7 @@ public Builder setOnBehalfOf(String onBehalfOf) { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { @@ -505,7 +507,7 @@ public static class AutomaticTax { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ @SerializedName("enabled") @@ -554,7 +556,7 @@ public InvoiceCreatePreviewParams.AutomaticTax build() { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ public Builder setEnabled(Boolean enabled) { @@ -704,7 +706,11 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class CustomerDetails { - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ @SerializedName("address") Object address; @@ -771,13 +777,21 @@ public InvoiceCreatePreviewParams.CustomerDetails build() { this.address, this.extraParams, this.shipping, this.tax, this.taxExempt, this.taxIds); } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(InvoiceCreatePreviewParams.CustomerDetails.Address address) { this.address = address; return this; } - /** The customer's address. */ + /** + * The customer's address. Learn about country-specific + * requirements for calculating tax. + */ public Builder setAddress(EmptyParam address) { this.address = address; return this; @@ -902,7 +916,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1015,7 +1032,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1159,7 +1179,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -1275,7 +1298,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -2270,7 +2296,7 @@ public static class InvoiceItem { String invoiceitem; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -2281,9 +2307,9 @@ public static class InvoiceItem { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") @@ -2294,7 +2320,7 @@ public static class InvoiceItem { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -2306,7 +2332,7 @@ public static class InvoiceItem { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2315,7 +2341,7 @@ public static class InvoiceItem { @SerializedName("tax_behavior") TaxBehavior taxBehavior; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -2579,7 +2605,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2590,7 +2616,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2603,9 +2629,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceCreatePreviewParams.InvoiceItem.Period period) { @@ -2620,7 +2646,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(InvoiceCreatePreviewParams.InvoiceItem.PriceData priceData) { @@ -2636,7 +2662,7 @@ public Builder setQuantity(Long quantity) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2648,13 +2674,13 @@ public Builder setTaxBehavior( return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; @@ -3214,7 +3240,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -3331,7 +3357,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -5950,7 +5976,7 @@ public static class Add { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value * to them. All keys can be unset by posting an empty value to {@code metadata}. @@ -9008,7 +9034,7 @@ public static class Phase { * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -9047,11 +9073,11 @@ public static class Phase { String defaultPaymentMethod; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ @SerializedName("default_tax_rates") @@ -9091,7 +9117,7 @@ public static class Phase { EffectiveAt effectiveAt; /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * The date at which this phase of the subscription schedule ends. If set, {@code duration} * must not be set. */ @SerializedName("end_date") @@ -9118,7 +9144,7 @@ public static class Phase { List items; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to a phase. Metadata on a schedule's phase will update the underlying subscription's * {@code metadata} when the phase is entered, adding new keys and replacing existing keys in * the subscription's {@code metadata}. Individual keys in the subscription's {@code metadata} @@ -9139,7 +9165,7 @@ public static class Phase { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -9147,10 +9173,10 @@ public static class Phase { /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's * different from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing * configuration (item price, quantity, etc.) of the current phase. */ @@ -9396,7 +9422,7 @@ public Builder setAutomaticTax( * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( InvoiceCreatePreviewParams.ScheduleDetails.Phase.BillingCycleAnchor @@ -9488,11 +9514,11 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { @@ -9501,11 +9527,11 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(List defaultTaxRates) { @@ -9612,8 +9638,8 @@ public Builder setEffectiveAt( } /** - * The date at which this phase of the subscription schedule ends. If set, {@code - * iterations} must not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code duration} + * must not be set. */ public Builder setEndDate(Long endDate) { this.endDate = endDate; @@ -9621,8 +9647,8 @@ public Builder setEndDate(Long endDate) { } /** - * The date at which this phase of the subscription schedule ends. If set, {@code - * iterations} must not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code duration} + * must not be set. */ public Builder setEndDate( InvoiceCreatePreviewParams.ScheduleDetails.Phase.EndDate endDate) { @@ -9731,7 +9757,7 @@ public Builder setOnBehalfOf(String onBehalfOf) { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn - * more about pausing + * more about pausing * collection. */ public Builder setPauseCollection( @@ -9742,10 +9768,10 @@ public Builder setPauseCollection( /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's * different from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing * configuration (item price, quantity, etc.) of the current phase. */ @@ -9845,7 +9871,7 @@ public static class AddInvoiceItem { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -9866,7 +9892,7 @@ public static class AddInvoiceItem { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -10046,7 +10072,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price + * Data used to generate a new Price * object inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData( @@ -10860,7 +10886,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} @@ -10982,7 +11008,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code * inclusive}, {@code exclusive}, or {@code unspecified}. Once specified as either @@ -12124,7 +12150,7 @@ public static class Item { Map extraParams; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to a configuration item. Metadata on a configuration item will update the * underlying subscription item's {@code metadata} when the phase is entered, adding new * keys and replacing existing keys. Individual keys in the subscription item's {@code @@ -12148,7 +12174,7 @@ public static class Item { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -12162,9 +12188,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -12388,7 +12414,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price + * Data used to generate a new Price * object inline. */ public Builder setPriceData( @@ -12437,9 +12463,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to * remove previously-defined tax rates. */ @@ -12449,9 +12475,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to * remove previously-defined tax rates. */ @@ -12490,7 +12516,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -12550,7 +12576,7 @@ public Builder putAllExtraParam(Map map) { * Required. Number of units that meets the billing threshold to * advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet * a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -12980,7 +13006,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} @@ -13116,7 +13142,7 @@ public Builder setRecurring( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code * inclusive}, {@code exclusive}, or {@code unspecified}. Once specified as either @@ -14418,7 +14444,7 @@ public enum ProrationBehavior implements ApiRequestParams.EnumParam { public static class SubscriptionDetails { /** * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle. This is used to * determine the date of the first full invoice, and, for plans with {@code month} or {@code * year} intervals, the day of the month for subsequent invoices. For existing subscriptions, * the value can only be set to {@code now} or {@code unchanged}. @@ -14481,7 +14507,7 @@ public static class SubscriptionDetails { /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -14610,7 +14636,7 @@ public InvoiceCreatePreviewParams.SubscriptionDetails build() { /** * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle. This is used * to determine the date of the first full invoice, and, for plans with {@code month} or * {@code year} intervals, the day of the month for subsequent invoices. For existing * subscriptions, the value can only be set to {@code now} or {@code unchanged}. @@ -14623,7 +14649,7 @@ public Builder setBillingCycleAnchor( /** * For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle. This is used * to determine the date of the first full invoice, and, for plans with {@code month} or * {@code year} intervals, the day of the month for subsequent invoices. For existing * subscriptions, the value can only be set to {@code now} or {@code unchanged}. @@ -14852,7 +14878,7 @@ public Builder setPrebilling( /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -15650,7 +15676,7 @@ public static class Item { String id; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -15671,7 +15697,7 @@ public static class Item { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -15682,9 +15708,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -15926,7 +15952,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -15937,7 +15963,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -15964,7 +15990,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData( @@ -16010,9 +16036,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -16022,9 +16048,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -16050,7 +16076,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -16109,7 +16135,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -16633,7 +16659,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -16768,7 +16794,7 @@ public Builder setRecurring( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} diff --git a/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java b/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java index 0d6a0a36f0f..34d6d6d547d 100644 --- a/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java +++ b/src/main/java/com/stripe/param/InvoiceFinalizeInvoiceParams.java @@ -15,7 +15,7 @@ public class InvoiceFinalizeInvoiceParams extends ApiRequestParams { /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. If {@code false}, the invoice's state doesn't automatically * advance without an explicit action. */ @@ -60,7 +60,7 @@ public InvoiceFinalizeInvoiceParams build() { /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. If {@code false}, the invoice's state doesn't automatically * advance without an explicit action. */ diff --git a/src/main/java/com/stripe/param/InvoiceItemCreateParams.java b/src/main/java/com/stripe/param/InvoiceItemCreateParams.java index 2896bc7a53e..69cbd571523 100644 --- a/src/main/java/com/stripe/param/InvoiceItemCreateParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemCreateParams.java @@ -30,11 +30,11 @@ public class InvoiceItemCreateParams extends ApiRequestParams { @SerializedName("currency") String currency; - /** The ID of the customer who will be billed when this invoice item is billed. */ + /** The ID of the customer to bill for this invoice item. */ @SerializedName("customer") String customer; - /** The ID of the account who will be billed when this invoice item is billed. */ + /** The ID of the account representing the customer to bill for this invoice item. */ @SerializedName("customer_account") String customerAccount; @@ -91,7 +91,7 @@ public class InvoiceItemCreateParams extends ApiRequestParams { List margins; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -102,16 +102,16 @@ public class InvoiceItemCreateParams extends ApiRequestParams { /** * The period associated with this invoice item. When set to different values, the period will be * rendered on the invoice. If you have Stripe Revenue Recognition enabled, the + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, the * period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") Period period; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -136,7 +136,7 @@ public class InvoiceItemCreateParams extends ApiRequestParams { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -145,7 +145,7 @@ public class InvoiceItemCreateParams extends ApiRequestParams { @SerializedName("tax_behavior") TaxBehavior taxBehavior; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -303,13 +303,13 @@ public Builder setCurrency(String currency) { return this; } - /** The ID of the customer who will be billed when this invoice item is billed. */ + /** The ID of the customer to bill for this invoice item. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The ID of the account who will be billed when this invoice item is billed. */ + /** The ID of the account representing the customer to bill for this invoice item. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; @@ -499,7 +499,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -510,7 +510,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -523,9 +523,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceItemCreateParams.Period period) { @@ -534,7 +534,7 @@ public Builder setPeriod(InvoiceItemCreateParams.Period period) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(InvoiceItemCreateParams.PriceData priceData) { @@ -568,7 +568,7 @@ public Builder setSubscription(String subscription) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -579,13 +579,13 @@ public Builder setTaxBehavior(InvoiceItemCreateParams.TaxBehavior taxBehavior) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; @@ -1101,7 +1101,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1216,7 +1216,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code diff --git a/src/main/java/com/stripe/param/InvoiceItemListParams.java b/src/main/java/com/stripe/param/InvoiceItemListParams.java index ed9d059ba39..0977a3bd709 100644 --- a/src/main/java/com/stripe/param/InvoiceItemListParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemListParams.java @@ -18,15 +18,15 @@ public class InvoiceItemListParams extends ApiRequestParams { Object created; /** - * The identifier of the customer whose invoice items to return. If none is provided, all invoice - * items will be returned. + * The identifier of the customer whose invoice items to return. If none is provided, returns all + * invoice items. */ @SerializedName("customer") String customer; /** - * The identifier of the account whose invoice items to return. If none is provided, all invoice - * items will be returned. + * The identifier of the account representing the customer whose invoice items to return. If none + * is provided, returns all invoice items. */ @SerializedName("customer_account") String customerAccount; @@ -160,8 +160,8 @@ public Builder setCreated(Long created) { } /** - * The identifier of the customer whose invoice items to return. If none is provided, all - * invoice items will be returned. + * The identifier of the customer whose invoice items to return. If none is provided, returns + * all invoice items. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -169,8 +169,8 @@ public Builder setCustomer(String customer) { } /** - * The identifier of the account whose invoice items to return. If none is provided, all invoice - * items will be returned. + * The identifier of the account representing the customer whose invoice items to return. If + * none is provided, returns all invoice items. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; diff --git a/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java b/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java index 394d195818e..8c0fc3f9030 100644 --- a/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java +++ b/src/main/java/com/stripe/param/InvoiceItemUpdateParams.java @@ -66,7 +66,7 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { Object margins; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -77,16 +77,16 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { /** * The period associated with this invoice item. When set to different values, the period will be * rendered on the invoice. If you have Stripe Revenue Recognition enabled, the + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, the * period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") Period period; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -102,7 +102,7 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -111,7 +111,7 @@ public class InvoiceItemUpdateParams extends ApiRequestParams { @SerializedName("tax_behavior") TaxBehavior taxBehavior; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -437,7 +437,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -448,7 +448,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -461,9 +461,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceItemUpdateParams.Period period) { @@ -472,7 +472,7 @@ public Builder setPeriod(InvoiceItemUpdateParams.Period period) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(InvoiceItemUpdateParams.PriceData priceData) { @@ -494,7 +494,7 @@ public Builder setQuantity(Long quantity) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -505,13 +505,13 @@ public Builder setTaxBehavior(InvoiceItemUpdateParams.TaxBehavior taxBehavior) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; @@ -1078,7 +1078,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1213,7 +1213,7 @@ public Builder setProduct(EmptyParam product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code diff --git a/src/main/java/com/stripe/param/InvoiceLineItemUpdateParams.java b/src/main/java/com/stripe/param/InvoiceLineItemUpdateParams.java index 1d748e81049..cffc4d9f7f7 100644 --- a/src/main/java/com/stripe/param/InvoiceLineItemUpdateParams.java +++ b/src/main/java/com/stripe/param/InvoiceLineItemUpdateParams.java @@ -65,11 +65,11 @@ public class InvoiceLineItemUpdateParams extends ApiRequestParams { Object margins; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this value, * in contrast to type=invoiceitem line items, @@ -81,16 +81,16 @@ public class InvoiceLineItemUpdateParams extends ApiRequestParams { /** * The period associated with this invoice item. When set to different values, the period will be * rendered on the invoice. If you have Stripe Revenue Recognition enabled, the + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, the * period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") Period period; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -108,10 +108,10 @@ public class InvoiceLineItemUpdateParams extends ApiRequestParams { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on * your own or use a third-party to calculate them. You cannot set tax amounts if any line item * has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty string + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty string * to remove previously defined tax amounts. */ @SerializedName("tax_amounts") @@ -419,11 +419,11 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line items, @@ -435,11 +435,11 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line items, @@ -453,9 +453,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceLineItemUpdateParams.Period period) { @@ -464,7 +464,7 @@ public Builder setPeriod(InvoiceLineItemUpdateParams.Period period) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(InvoiceLineItemUpdateParams.PriceData priceData) { @@ -516,10 +516,10 @@ public Builder addAllTaxAmount(List eleme * A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes * on your own or use a third-party to calculate them. You cannot set tax amounts if any line * item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(EmptyParam taxAmounts) { @@ -531,10 +531,10 @@ public Builder setTaxAmounts(EmptyParam taxAmounts) { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes * on your own or use a third-party to calculate them. You cannot set tax amounts if any line * item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(List taxAmounts) { @@ -1089,7 +1089,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1238,7 +1238,7 @@ public Builder setProductData(InvoiceLineItemUpdateParams.PriceData.ProductData /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1306,7 +1306,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1318,10 +1318,17 @@ public static class ProductData { @SerializedName("name") Object name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1336,6 +1343,7 @@ private ProductData( Map metadata, Object name, Object taxCode, + TaxDetails taxDetails, Object unitLabel) { this.description = description; this.extraParams = extraParams; @@ -1343,6 +1351,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -1363,6 +1372,8 @@ public static class Builder { private Object taxCode; + private TaxDetails taxDetails; + private Object unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -1374,6 +1385,7 @@ public InvoiceLineItemUpdateParams.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -1494,18 +1506,29 @@ public Builder setName(EmptyParam name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + InvoiceLineItemUpdateParams.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1524,6 +1547,96 @@ public Builder setUnitLabel(EmptyParam unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + Object taxCode; + + private TaxDetails(Map extraParams, Object taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceLineItemUpdateParams.PriceData.ProductData.TaxDetails build() { + return new InvoiceLineItemUpdateParams.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceLineItemUpdateParams.PriceData.ProductData.TaxDetails#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceLineItemUpdateParams.PriceData.ProductData.TaxDetails#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(EmptyParam taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } public enum TaxBehavior implements ApiRequestParams.EnumParam { diff --git a/src/main/java/com/stripe/param/InvoiceListParams.java b/src/main/java/com/stripe/param/InvoiceListParams.java index f3618f6d48e..136243f25db 100644 --- a/src/main/java/com/stripe/param/InvoiceListParams.java +++ b/src/main/java/com/stripe/param/InvoiceListParams.java @@ -32,7 +32,9 @@ public class InvoiceListParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** Only return invoices for the account specified by this account ID. */ + /** + * Only return invoices for the account representing the customer specified by this account ID. + */ @SerializedName("customer_account") String customerAccount; @@ -80,7 +82,7 @@ public class InvoiceListParams extends ApiRequestParams { /** * The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code * uncollectible}, or {@code void}. Learn more + * href="https://docs.stripe.com/billing/invoices/workflow#workflow-overview">Learn more */ @SerializedName("status") Status status; @@ -200,7 +202,9 @@ public Builder setCustomer(String customer) { return this; } - /** Only return invoices for the account specified by this account ID. */ + /** + * Only return invoices for the account representing the customer specified by this account ID. + */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; @@ -302,7 +306,7 @@ public Builder setStartingAfter(String startingAfter) { /** * The status of the invoice, one of {@code draft}, {@code open}, {@code paid}, {@code * uncollectible}, or {@code void}. Learn more + * href="https://docs.stripe.com/billing/invoices/workflow#workflow-overview">Learn more */ public Builder setStatus(InvoiceListParams.Status status) { this.status = status; diff --git a/src/main/java/com/stripe/param/InvoiceRemoveLinesParams.java b/src/main/java/com/stripe/param/InvoiceRemoveLinesParams.java index 0af67b525e3..dad87e65ecb 100644 --- a/src/main/java/com/stripe/param/InvoiceRemoveLinesParams.java +++ b/src/main/java/com/stripe/param/InvoiceRemoveLinesParams.java @@ -28,7 +28,7 @@ public class InvoiceRemoveLinesParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder putAllInvoiceMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -162,7 +162,7 @@ public Builder setInvoiceMetadata(EmptyParam invoiceMetadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/InvoiceSearchParams.java b/src/main/java/com/stripe/param/InvoiceSearchParams.java index 51301977c56..105daab600c 100644 --- a/src/main/java/com/stripe/param/InvoiceSearchParams.java +++ b/src/main/java/com/stripe/param/InvoiceSearchParams.java @@ -43,8 +43,8 @@ public class InvoiceSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for invoices. */ @SerializedName("query") @@ -153,8 +153,8 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for invoices. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/InvoiceUpdateLinesParams.java b/src/main/java/com/stripe/param/InvoiceUpdateLinesParams.java index f109dff513f..152754a31ae 100644 --- a/src/main/java/com/stripe/param/InvoiceUpdateLinesParams.java +++ b/src/main/java/com/stripe/param/InvoiceUpdateLinesParams.java @@ -29,11 +29,11 @@ public class InvoiceUpdateLinesParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this value, * in contrast to type=invoiceitem line items, @@ -157,11 +157,11 @@ public Builder putAllInvoiceMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line items, @@ -173,11 +173,11 @@ public Builder setInvoiceMetadata(EmptyParam invoiceMetadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line items, @@ -268,11 +268,11 @@ public static class Line { Object margins; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line items, @@ -284,16 +284,16 @@ public static class Line { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ @SerializedName("period") Period period; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -311,10 +311,10 @@ public static class Line { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes * on your own or use a third-party to calculate them. You cannot set tax amounts if any line * item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ @SerializedName("tax_amounts") @@ -595,11 +595,11 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line @@ -611,11 +611,11 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. For type=subscription + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type">type=subscription * line items, the incoming metadata specified on the request is directly used to set this * value, in contrast to type=invoiceitem line @@ -629,9 +629,9 @@ public Builder setMetadata(Map metadata) { /** * The period associated with this invoice item. When set to different values, the period will * be rendered on the invoice. If you have Stripe Revenue Recognition enabled, + * href="https://docs.stripe.com/revenue-recognition">Stripe Revenue Recognition enabled, * the period will be used to recognize and defer revenue. See the Revenue + * href="https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing">Revenue * Recognition documentation for details. */ public Builder setPeriod(InvoiceUpdateLinesParams.Line.Period period) { @@ -640,7 +640,7 @@ public Builder setPeriod(InvoiceUpdateLinesParams.Line.Period period) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(InvoiceUpdateLinesParams.Line.PriceData priceData) { @@ -692,10 +692,10 @@ public Builder addAllTaxAmount(List ele * A list of up to 10 tax amounts for this line item. This can be useful if you calculate * taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any * line item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(EmptyParam taxAmounts) { @@ -707,10 +707,10 @@ public Builder setTaxAmounts(EmptyParam taxAmounts) { * A list of up to 10 tax amounts for this line item. This can be useful if you calculate * taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any * line item has tax_rates + * href="https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates">tax_rates * or if the invoice has default_tax_rates - * or uses automatic tax. Pass an empty + * href="https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates">default_tax_rates + * or uses automatic tax. Pass an empty * string to remove previously defined tax amounts. */ public Builder setTaxAmounts(List taxAmounts) { @@ -1255,7 +1255,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1387,7 +1387,7 @@ public Builder setProductData( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1448,7 +1448,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1462,10 +1462,18 @@ public static class ProductData { @SerializedName("name") String name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1480,6 +1488,7 @@ private ProductData( Map metadata, String name, String taxCode, + TaxDetails taxDetails, String unitLabel) { this.description = description; this.extraParams = extraParams; @@ -1487,6 +1496,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -1507,6 +1517,8 @@ public static class Builder { private String taxCode; + private TaxDetails taxDetails; + private String unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -1518,6 +1530,7 @@ public InvoiceUpdateLinesParams.Line.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -1623,12 +1636,23 @@ public Builder setName(String name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + InvoiceUpdateLinesParams.Line.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -1638,6 +1662,87 @@ public Builder setUnitLabel(String unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + String taxCode; + + private TaxDetails(Map extraParams, String taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceUpdateLinesParams.Line.PriceData.ProductData.TaxDetails build() { + return new InvoiceUpdateLinesParams.Line.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceUpdateLinesParams.Line.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceUpdateLinesParams.Line.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } public enum TaxBehavior implements ApiRequestParams.EnumParam { diff --git a/src/main/java/com/stripe/param/InvoiceUpdateParams.java b/src/main/java/com/stripe/param/InvoiceUpdateParams.java index a3e39d75d0a..643aeedf58c 100644 --- a/src/main/java/com/stripe/param/InvoiceUpdateParams.java +++ b/src/main/java/com/stripe/param/InvoiceUpdateParams.java @@ -30,14 +30,14 @@ public class InvoiceUpdateParams extends ApiRequestParams { * application owner's Stripe account. The request must be made with an OAuth key or the * Stripe-Account header in order to take an application fee. For more information, see the * application fees documentation. + * href="https://docs.stripe.com/billing/invoices/connect#collecting-fees">documentation. */ @SerializedName("application_fee_amount") Long applicationFeeAmount; /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. */ @SerializedName("auto_advance") @@ -161,7 +161,7 @@ public class InvoiceUpdateParams extends ApiRequestParams { Issuer issuer; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -183,7 +183,7 @@ public class InvoiceUpdateParams extends ApiRequestParams { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ @SerializedName("on_behalf_of") @@ -488,7 +488,7 @@ public Builder setAmountsDue(List amountsDue) { * the application owner's Stripe account. The request must be made with an OAuth key or the * Stripe-Account header in order to take an application fee. For more information, see the * application fees documentation. + * href="https://docs.stripe.com/billing/invoices/connect#collecting-fees">documentation. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { this.applicationFeeAmount = applicationFeeAmount; @@ -497,7 +497,7 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { /** * Controls whether Stripe performs automatic + * href="https://docs.stripe.com/invoicing/integration/automatic-advancement-collection">automatic * collection of the invoice. */ public Builder setAutoAdvance(Boolean autoAdvance) { @@ -915,7 +915,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -926,7 +926,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -965,7 +965,7 @@ public Builder setNumber(EmptyParam number) { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ public Builder setOnBehalfOf(String onBehalfOf) { @@ -976,7 +976,7 @@ public Builder setOnBehalfOf(String onBehalfOf) { /** * The account (if any) for which the funds of the invoice payment are intended. If set, the * invoice will be presented with the branding and support information of the specified account. - * See the Invoices with Connect + * See the Invoices with Connect * documentation for details. */ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { @@ -1209,7 +1209,7 @@ public static class AutomaticTax { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ @SerializedName("enabled") @@ -1257,7 +1257,7 @@ public InvoiceUpdateParams.AutomaticTax build() { /** * Required. Whether Stripe automatically computes tax on this invoice. Note * that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code + * href="https://docs.stripe.com/api/tax_rates">tax rates, negative amounts, or {@code * tax_behavior=unspecified}) cannot be added to automatic tax invoices. */ public Builder setEnabled(Boolean enabled) { @@ -2221,6 +2221,13 @@ public static class PaymentMethodOptions { @SerializedName("konbini") Object konbini; + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + @SerializedName("payto") + Object payto; + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -2257,6 +2264,7 @@ private PaymentMethodOptions( Map extraParams, Object idBankTransfer, Object konbini, + Object payto, Object pix, Object sepaDebit, Object upi, @@ -2268,6 +2276,7 @@ private PaymentMethodOptions( this.extraParams = extraParams; this.idBankTransfer = idBankTransfer; this.konbini = konbini; + this.payto = payto; this.pix = pix; this.sepaDebit = sepaDebit; this.upi = upi; @@ -2293,6 +2302,8 @@ public static class Builder { private Object konbini; + private Object payto; + private Object pix; private Object sepaDebit; @@ -2311,6 +2322,7 @@ public InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions build() { this.extraParams, this.idBankTransfer, this.konbini, + this.payto, this.pix, this.sepaDebit, this.upi, @@ -2460,6 +2472,25 @@ public Builder setKonbini(EmptyParam konbini) { return this; } + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + public Builder setPayto( + InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto payto) { + this.payto = payto; + return this; + } + + /** + * If paying by {@code payto}, this sub-hash contains details about the PayTo payment method + * options to pass to the invoice’s PaymentIntent. + */ + public Builder setPayto(EmptyParam payto) { + this.payto = payto; + return this; + } + /** * If paying by {@code pix}, this sub-hash contains details about the Pix payment method * options to pass to the invoice’s PaymentIntent. @@ -2863,7 +2894,7 @@ public static class Card { * Installment configuration for payments attempted on this invoice. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ @SerializedName("installments") Installments installments; @@ -2871,10 +2902,10 @@ public static class Card { /** * 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. */ @@ -2941,7 +2972,7 @@ public Builder putAllExtraParam(Map map) { * Installment configuration for payments attempted on this invoice. * *

For more information, see the installments integration + * href="https://docs.stripe.com/payments/installments">installments integration * guide. */ public Builder setInstallments( @@ -2954,10 +2985,10 @@ public Builder setInstallments( /** * 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. */ @@ -3693,6 +3724,229 @@ public Builder putAllExtraParam(Map map) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Payto { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Additional fields for Mandate creation. */ + @SerializedName("mandate_options") + MandateOptions mandateOptions; + + private Payto(Map extraParams, MandateOptions mandateOptions) { + this.extraParams = extraParams; + this.mandateOptions = mandateOptions; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private MandateOptions mandateOptions; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto build() { + return new InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto( + this.extraParams, this.mandateOptions); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Additional fields for Mandate creation. */ + public Builder setMandateOptions( + InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + mandateOptions) { + this.mandateOptions = mandateOptions; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class MandateOptions { + /** + * 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; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + @SerializedName("purpose") + Purpose purpose; + + private MandateOptions(Long amount, Map extraParams, Purpose purpose) { + this.amount = amount; + this.extraParams = extraParams; + this.purpose = purpose; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Long amount; + + private Map extraParams; + + private Purpose purpose; + + /** Finalize and obtain parameter instance from this builder. */ + public InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + build() { + return new InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions(this.amount, this.extraParams, this.purpose); + } + + /** + * The maximum amount that can be collected in a single invoice. If you don't specify a + * maximum, then there is no limit. + */ + public Builder setAmount(Long amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose( + InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + .Purpose + purpose) { + this.purpose = purpose; + return this; + } + } + + public enum Purpose implements ApiRequestParams.EnumParam { + @SerializedName("dependant_support") + DEPENDANT_SUPPORT("dependant_support"), + + @SerializedName("government") + GOVERNMENT("government"), + + @SerializedName("loan") + LOAN("loan"), + + @SerializedName("mortgage") + MORTGAGE("mortgage"), + + @SerializedName("other") + OTHER("other"), + + @SerializedName("pension") + PENSION("pension"), + + @SerializedName("personal") + PERSONAL("personal"), + + @SerializedName("retail") + RETAIL("retail"), + + @SerializedName("salary") + SALARY("salary"), + + @SerializedName("tax") + TAX("tax"), + + @SerializedName("utility") + UTILITY("utility"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Purpose(String value) { + this.value = value; + } + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Pix { @@ -4707,6 +4961,9 @@ public enum PaymentMethodType implements ApiRequestParams.EnumParam { @SerializedName("paypal") PAYPAL("paypal"), + @SerializedName("payto") + PAYTO("payto"), + @SerializedName("pix") PIX("pix"), @@ -5133,7 +5390,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -5149,7 +5406,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -5316,7 +5573,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { @@ -5325,7 +5582,7 @@ public Builder setTaxCode(String taxCode) { } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(EmptyParam taxCode) { @@ -6137,7 +6394,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -6283,13 +6543,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/MandateListParams.java b/src/main/java/com/stripe/param/MandateListParams.java index b4da6882021..aae77b7658b 100644 --- a/src/main/java/com/stripe/param/MandateListParams.java +++ b/src/main/java/com/stripe/param/MandateListParams.java @@ -44,7 +44,7 @@ public class MandateListParams extends ApiRequestParams { /** * The Stripe account ID that the mandates are intended for. Learn more about the use case for connected accounts + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts * payments. */ @SerializedName("on_behalf_of") @@ -198,7 +198,7 @@ public Builder setLimit(Long limit) { /** * The Stripe account ID that the mandates are intended for. Learn more about the use case for connected accounts + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts * payments. */ public Builder setOnBehalfOf(String onBehalfOf) { diff --git a/src/main/java/com/stripe/param/MarginCreateParams.java b/src/main/java/com/stripe/param/MarginCreateParams.java index 39a0d373244..88037dd8461 100644 --- a/src/main/java/com/stripe/param/MarginCreateParams.java +++ b/src/main/java/com/stripe/param/MarginCreateParams.java @@ -35,7 +35,7 @@ public class MarginCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/MarginUpdateParams.java b/src/main/java/com/stripe/param/MarginUpdateParams.java index 7ee4afeabd3..c615136b254 100644 --- a/src/main/java/com/stripe/param/MarginUpdateParams.java +++ b/src/main/java/com/stripe/param/MarginUpdateParams.java @@ -32,7 +32,7 @@ public class MarginUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/OrderCreateParams.java b/src/main/java/com/stripe/param/OrderCreateParams.java index 24703f1ed65..0986ddc6119 100644 --- a/src/main/java/com/stripe/param/OrderCreateParams.java +++ b/src/main/java/com/stripe/param/OrderCreateParams.java @@ -71,7 +71,7 @@ public class OrderCreateParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -1294,7 +1294,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1413,7 +1413,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1504,7 +1504,7 @@ public static class ProductData { Object images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1524,7 +1524,7 @@ public static class ProductData { @SerializedName("shippable") Boolean shippable; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -1734,7 +1734,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1745,7 +1745,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1782,13 +1782,13 @@ public Builder setShippable(Boolean shippable) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; @@ -2030,7 +2030,7 @@ public static class Settings { PaymentMethodOptions paymentMethodOptions; /** - * The list of payment + * The list of payment * method types to provide to the order's PaymentIntent. Do not include this attribute if * you prefer to manage your payment methods from the Stripe Dashboard. @@ -3094,17 +3094,17 @@ public static class AfterpayClearpay { * 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 @@ -3207,17 +3207,17 @@ public Builder setReference(String reference) { * 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 @@ -3664,17 +3664,17 @@ public static class Card { * 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 @@ -3751,17 +3751,17 @@ public Builder putAllExtraParam(Map map) { * 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 @@ -12565,7 +12565,7 @@ public static class Paypal { List lineItems; /** - * Preferred + * Preferred * locale of the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -12766,7 +12766,7 @@ public Builder addAllLineItem( } /** - * Preferred + * Preferred * locale of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -14320,7 +14320,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -14336,7 +14336,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -14494,7 +14494,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { diff --git a/src/main/java/com/stripe/param/OrderUpdateParams.java b/src/main/java/com/stripe/param/OrderUpdateParams.java index 746ed45a3a5..60934ca5822 100644 --- a/src/main/java/com/stripe/param/OrderUpdateParams.java +++ b/src/main/java/com/stripe/param/OrderUpdateParams.java @@ -73,7 +73,7 @@ public class OrderUpdateParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -418,7 +418,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -429,7 +429,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1496,7 +1496,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1637,7 +1637,7 @@ public Builder setProduct(EmptyParam product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1738,7 +1738,7 @@ public static class ProductData { Object images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1758,7 +1758,7 @@ public static class ProductData { @SerializedName("shippable") Boolean shippable; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -1983,7 +1983,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1994,7 +1994,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -2039,13 +2039,13 @@ public Builder setShippable(Boolean shippable) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; @@ -2287,7 +2287,7 @@ public static class Settings { PaymentMethodOptions paymentMethodOptions; /** - * The list of payment + * The list of payment * method types to provide to the order's PaymentIntent. Do not include this attribute if * you prefer to manage your payment methods from the Stripe Dashboard. @@ -3546,17 +3546,17 @@ public static class AfterpayClearpay { * 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 @@ -3669,17 +3669,17 @@ public Builder setReference(EmptyParam reference) { * 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 @@ -4126,17 +4126,17 @@ public static class Card { * 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 @@ -4213,17 +4213,17 @@ public Builder putAllExtraParam(Map map) { * 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 @@ -13724,7 +13724,7 @@ public static class Paypal { List lineItems; /** - * Preferred + * Preferred * locale of the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -13925,7 +13925,7 @@ public Builder addAllLineItem( } /** - * Preferred + * Preferred * locale of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -15562,7 +15562,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -15578,7 +15578,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -15745,7 +15745,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { @@ -15754,7 +15754,7 @@ public Builder setTaxCode(String taxCode) { } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(EmptyParam taxCode) { diff --git a/src/main/java/com/stripe/param/PaymentIntentApplyCustomerBalanceParams.java b/src/main/java/com/stripe/param/PaymentIntentApplyCustomerBalanceParams.java index 03ae01feef8..0d7c3b913f1 100644 --- a/src/main/java/com/stripe/param/PaymentIntentApplyCustomerBalanceParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentApplyCustomerBalanceParams.java @@ -19,7 +19,7 @@ public class PaymentIntentApplyCustomerBalanceParams extends ApiRequestParams { * regardless of this parameter. * *

A positive integer representing how much to charge in the smallest currency unit (for example, + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (for example, * 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum * amount is the amount of the PaymentIntent. * @@ -82,7 +82,7 @@ public PaymentIntentApplyCustomerBalanceParams build() { * regardless of this parameter. * *

A positive integer representing how much to charge in the smallest currency unit (for + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (for * example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The * maximum amount is the amount of the PaymentIntent. * diff --git a/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java b/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java index 75fecbfd463..a7cd7866f96 100644 --- a/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentCaptureParams.java @@ -29,7 +29,7 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -52,7 +52,7 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { * Defaults to {@code true}. When capturing a PaymentIntent, setting {@code final_capture} to * {@code false} notifies Stripe to not release the remaining uncaptured funds to make sure that * they're captured in future requests. You can only use this setting when multicapture is available for + * href="https://docs.stripe.com/payments/multicapture">multicapture is available for * PaymentIntents. */ @SerializedName("final_capture") @@ -63,7 +63,7 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { Hooks hooks; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -101,7 +101,7 @@ public class PaymentIntentCaptureParams extends ApiRequestParams { /** * The parameters that you can use to automatically create a transfer after the payment is * captured. Learn more about the use case for connected accounts. + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts. */ @SerializedName("transfer_data") TransferData transferData; @@ -198,7 +198,7 @@ public Builder setAmountToCapture(Long amountToCapture) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -262,7 +262,7 @@ public Builder putAllExtraParam(Map map) { * Defaults to {@code true}. When capturing a PaymentIntent, setting {@code final_capture} to * {@code false} notifies Stripe to not release the remaining uncaptured funds to make sure that * they're captured in future requests. You can only use this setting when multicapture is available for + * href="https://docs.stripe.com/payments/multicapture">multicapture is available for * PaymentIntents. */ public Builder setFinalCapture(Boolean finalCapture) { @@ -305,7 +305,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -316,7 +316,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -368,7 +368,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters that you can use to automatically create a transfer after the payment is * captured. Learn more about the use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setTransferData(PaymentIntentCaptureParams.TransferData transferData) { @@ -382,7 +382,7 @@ public Builder setTransferData(PaymentIntentCaptureParams.TransferData transferD public static class AmountDetails { /** * 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 @@ -451,7 +451,7 @@ public PaymentIntentCaptureParams.AmountDetails build() { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -464,7 +464,7 @@ public Builder setDiscountAmount(Long discountAmount) { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -580,7 +580,7 @@ public Builder setTax(EmptyParam tax) { public static class LineItem { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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. @@ -631,7 +631,7 @@ public static class LineItem { /** * Required. The unit cost of the line item represented in the smallest currency unit. Required + * 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") @@ -701,7 +701,7 @@ public PaymentIntentCaptureParams.AmountDetails.LineItem build() { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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]} @@ -786,7 +786,7 @@ public Builder setTax(PaymentIntentCaptureParams.AmountDetails.LineItem.Tax tax) /** * Required. The unit cost of the line item represented in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. */ public Builder setUnitCost(Long unitCost) { @@ -1389,7 +1389,7 @@ public static class Tax { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency unit. + * the smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1448,7 +1448,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency + * the smallest currency * unit. Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1467,7 +1467,7 @@ public Builder setTotalTaxAmount(Long totalTaxAmount) { public static class Shipping { /** * 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") @@ -1528,7 +1528,7 @@ public PaymentIntentCaptureParams.AmountDetails.Shipping build() { /** * 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. */ public Builder setAmount(Long amount) { @@ -1538,7 +1538,7 @@ public Builder setAmount(Long amount) { /** * 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. */ public Builder setAmount(EmptyParam amount) { @@ -1626,7 +1626,7 @@ public static class Tax { /** * Required. 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 @@ -1685,7 +1685,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on the transaction represented in the - * smallest currency unit. + * smallest currency unit. * Required for L2 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1842,7 +1842,7 @@ public Builder setTax(PaymentIntentCaptureParams.Hooks.Inputs.Tax tax) { public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -1879,7 +1879,7 @@ public PaymentIntentCaptureParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -1888,7 +1888,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; @@ -3331,7 +3331,10 @@ public static class PickupAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3446,7 +3449,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3490,7 +3496,10 @@ public static class ReturnAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3605,7 +3614,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4544,7 +4556,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -4662,7 +4677,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4963,7 +4981,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -5081,7 +5102,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -6294,7 +6318,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -6409,7 +6436,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -9790,7 +9820,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -9903,7 +9936,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -11226,7 +11262,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -11344,7 +11383,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java b/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java index 02cb2ef9f33..383332536f1 100644 --- a/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentConfirmParams.java @@ -26,7 +26,7 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -49,7 +49,7 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code * requires_action}. This parameter is intended for simpler integrations that do not handle * customer actions, like saving cards without + * href="https://docs.stripe.com/payments/save-card-without-authentication">saving cards without * authentication. */ @SerializedName("error_on_requires_action") @@ -93,7 +93,7 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect card - * details and charge them + * details and charge them * later. */ @SerializedName("off_session") @@ -105,11 +105,11 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * ID of the payment method (a PaymentMethod, Card, or compatible + * href="https://docs.stripe.com/payments/payment-methods/transitioning#compatibility">compatible * Source object) to attach to this PaymentIntent. If the payment method is attached to a * Customer, it must match the customer that is set on - * this PaymentIntent. + * href="https://api.stripe.com#create_payment_intent-customer">customer that is set on this + * PaymentIntent. */ @SerializedName("payment_method") String paymentMethod; @@ -117,7 +117,7 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ @SerializedName("payment_method_data") @@ -139,7 +139,7 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { /** * Options to configure Radar. Learn more about Radar Sessions. + * href="https://docs.stripe.com/radar/radar-session">Radar Sessions. */ @SerializedName("radar_options") RadarOptions radarOptions; @@ -186,6 +186,10 @@ public class PaymentIntentConfirmParams extends ApiRequestParams { @SerializedName("setup_future_usage") ApiRequestParams.EnumParam setupFutureUsage; + /** ID of the SharedPaymentToken used to confirm this PaymentIntent. */ + @SerializedName("shared_payment_granted_token") + String sharedPaymentGrantedToken; + /** Shipping information for this PaymentIntent. */ @SerializedName("shipping") Object shipping; @@ -221,6 +225,7 @@ private PaymentIntentConfirmParams( Object receiptEmail, String returnUrl, ApiRequestParams.EnumParam setupFutureUsage, + String sharedPaymentGrantedToken, Object shipping, Boolean useStripeSdk) { this.allocatedFunds = allocatedFunds; @@ -246,6 +251,7 @@ private PaymentIntentConfirmParams( this.receiptEmail = receiptEmail; this.returnUrl = returnUrl; this.setupFutureUsage = setupFutureUsage; + this.sharedPaymentGrantedToken = sharedPaymentGrantedToken; this.shipping = shipping; this.useStripeSdk = useStripeSdk; } @@ -301,6 +307,8 @@ public static class Builder { private ApiRequestParams.EnumParam setupFutureUsage; + private String sharedPaymentGrantedToken; + private Object shipping; private Boolean useStripeSdk; @@ -331,6 +339,7 @@ public PaymentIntentConfirmParams build() { this.receiptEmail, this.returnUrl, this.setupFutureUsage, + this.sharedPaymentGrantedToken, this.shipping, this.useStripeSdk); } @@ -357,7 +366,7 @@ public Builder setAmountDetails(EmptyParam amountDetails) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -369,7 +378,7 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount) { @@ -399,7 +408,7 @@ public Builder setConfirmationToken(String confirmationToken) { * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code * requires_action}. This parameter is intended for simpler integrations that do not handle * customer actions, like saving cards without + * href="https://docs.stripe.com/payments/save-card-without-authentication">saving cards without * authentication. */ public Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction) { @@ -542,7 +551,7 @@ public Builder setMandateData(EmptyParam mandateData) { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect - * card details and charge + * card details and charge * them later. */ public Builder setOffSession(Boolean offSession) { @@ -553,7 +562,7 @@ public Builder setOffSession(Boolean offSession) { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect - * card details and charge + * card details and charge * them later. */ public Builder setOffSession(PaymentIntentConfirmParams.OffSession offSession) { @@ -575,11 +584,11 @@ public Builder setPaymentDetails(EmptyParam paymentDetails) { /** * ID of the payment method (a PaymentMethod, Card, or compatible + * href="https://docs.stripe.com/payments/payment-methods/transitioning#compatibility">compatible * Source object) to attach to this PaymentIntent. If the payment method is attached to a * Customer, it must match the customer that is set on - * this PaymentIntent. + * href="https://api.stripe.com#create_payment_intent-customer">customer that is set on this + * PaymentIntent. */ public Builder setPaymentMethod(String paymentMethod) { this.paymentMethod = paymentMethod; @@ -589,7 +598,7 @@ public Builder setPaymentMethod(String paymentMethod) { /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ public Builder setPaymentMethodData( @@ -633,7 +642,7 @@ public Builder addAllPaymentMethodType(List elements) { /** * Options to configure Radar. Learn more about Radar Sessions. + * href="https://docs.stripe.com/radar/radar-session">Radar Sessions. */ public Builder setRadarOptions(PaymentIntentConfirmParams.RadarOptions radarOptions) { this.radarOptions = radarOptions; @@ -728,6 +737,12 @@ public Builder setSetupFutureUsage(EmptyParam setupFutureUsage) { return this; } + /** ID of the SharedPaymentToken used to confirm this PaymentIntent. */ + public Builder setSharedPaymentGrantedToken(String sharedPaymentGrantedToken) { + this.sharedPaymentGrantedToken = sharedPaymentGrantedToken; + return this; + } + /** Shipping information for this PaymentIntent. */ public Builder setShipping(PaymentIntentConfirmParams.Shipping shipping) { this.shipping = shipping; @@ -825,7 +840,7 @@ public Builder putAllExtraParam(Map map) { public static class AmountDetails { /** * 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 @@ -894,7 +909,7 @@ public PaymentIntentConfirmParams.AmountDetails build() { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -907,7 +922,7 @@ public Builder setDiscountAmount(Long discountAmount) { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -1023,7 +1038,7 @@ public Builder setTax(EmptyParam tax) { public static class LineItem { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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. @@ -1074,7 +1089,7 @@ public static class LineItem { /** * Required. The unit cost of the line item represented in the smallest currency unit. Required + * 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") @@ -1144,7 +1159,7 @@ public PaymentIntentConfirmParams.AmountDetails.LineItem build() { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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]} @@ -1229,7 +1244,7 @@ public Builder setTax(PaymentIntentConfirmParams.AmountDetails.LineItem.Tax tax) /** * Required. The unit cost of the line item represented in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. */ public Builder setUnitCost(Long unitCost) { @@ -1832,7 +1847,7 @@ public static class Tax { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency unit. + * the smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1891,7 +1906,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency + * the smallest currency * unit. Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1910,7 +1925,7 @@ public Builder setTotalTaxAmount(Long totalTaxAmount) { public static class Shipping { /** * 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") @@ -1971,7 +1986,7 @@ public PaymentIntentConfirmParams.AmountDetails.Shipping build() { /** * 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. */ public Builder setAmount(Long amount) { @@ -1981,7 +1996,7 @@ public Builder setAmount(Long amount) { /** * 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. */ public Builder setAmount(EmptyParam amount) { @@ -2069,7 +2084,7 @@ public static class Tax { /** * Required. 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 @@ -2128,7 +2143,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on the transaction represented in the - * smallest currency unit. + * smallest currency unit. * Required for L2 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2285,7 +2300,7 @@ public Builder setTax(PaymentIntentConfirmParams.Hooks.Inputs.Tax tax) { public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -2322,7 +2337,7 @@ public PaymentIntentConfirmParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -2331,7 +2346,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; @@ -4310,7 +4325,10 @@ public static class PickupAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -4425,7 +4443,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4469,7 +4490,10 @@ public static class ReturnAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -4584,7 +4608,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -5523,7 +5550,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -5641,7 +5671,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -5942,7 +5975,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -6060,7 +6096,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -7273,7 +7312,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -7388,7 +7430,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -10769,7 +10814,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -10882,7 +10930,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -12205,7 +12256,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -12323,7 +12377,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -13710,7 +13767,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -13824,7 +13881,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -14739,7 +14796,7 @@ public Builder setQris(PaymentIntentConfirmParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -15757,7 +15814,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -15872,7 +15932,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -16904,6 +16967,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -18618,7 +18684,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -18674,7 +18740,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -24397,7 +24463,7 @@ public static class Card { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ @SerializedName("installments") Installments installments; @@ -24423,7 +24489,7 @@ public static class Card { /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ @SerializedName("request_decremental_authorization") @@ -24431,7 +24497,7 @@ public static class Card { /** * 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. */ @SerializedName("request_extended_authorization") @@ -24439,21 +24505,21 @@ public static class Card { /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ @SerializedName("request_incremental_authorization") RequestIncrementalAuthorization requestIncrementalAuthorization; /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ @SerializedName("request_multicapture") RequestMulticapture requestMulticapture; /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ @SerializedName("request_overcapture") @@ -24466,11 +24532,11 @@ public static class Card { /** * 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. */ @@ -24730,7 +24796,7 @@ public Builder putAllExtraParam(Map map) { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ public Builder setInstallments( PaymentIntentConfirmParams.PaymentMethodOptions.Card.Installments installments) { @@ -24767,7 +24833,7 @@ public Builder setNetwork( /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ public Builder setRequestDecrementalAuthorization( @@ -24779,7 +24845,7 @@ public Builder setRequestDecrementalAuthorization( /** * Request ability to capture beyond the + * href="https://docs.stripe.com/payments/extended-authorization">capture beyond the * standard authorization validity window for this PaymentIntent. */ public Builder setRequestExtendedAuthorization( @@ -24791,7 +24857,7 @@ public Builder setRequestExtendedAuthorization( /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ public Builder setRequestIncrementalAuthorization( @@ -24802,7 +24868,7 @@ public Builder setRequestIncrementalAuthorization( } /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ public Builder setRequestMulticapture( @@ -24813,7 +24879,7 @@ public Builder setRequestMulticapture( } /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ public Builder setRequestOvercapture( @@ -24834,11 +24900,11 @@ public Builder setRequestPartialAuthorization( /** * 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. */ @@ -25720,7 +25786,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -25837,7 +25906,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -26615,7 +26687,7 @@ public static class CardPresent { /** * 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") @@ -26623,10 +26695,10 @@ public static class CardPresent { /** * 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") @@ -26724,7 +26796,7 @@ public Builder putAllExtraParam(Map map) { /** * Request ability to capture this payment beyond the standard authorization + * href="https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity">authorization * validity window. */ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorization) { @@ -26734,10 +26806,10 @@ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorizat /** * 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. */ public Builder setRequestIncrementalAuthorizationSupport( @@ -38642,7 +38714,7 @@ public static class Paypal { List lineItems; /** - * Preferred locale of + * Preferred locale of * the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -38833,7 +38905,7 @@ public Builder addAllLineItem( } /** - * Preferred locale + * Preferred locale * of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -39677,7 +39749,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -39685,14 +39757,14 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. */ @SerializedName("end_date") - String endDate; + Object endDate; /** * Map of extra parameters for custom features not available in this client library. The @@ -39706,7 +39778,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -39714,23 +39786,23 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; private MandateOptions( - Long amount, - AmountType amountType, - String endDate, + Object amount, + ApiRequestParams.EnumParam amountType, + Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -39745,19 +39817,19 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; - private String endDate; + private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; /** Finalize and obtain parameter instance from this builder. */ public PaymentIntentConfirmParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -39780,6 +39852,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -39792,6 +39873,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -39801,6 +39892,15 @@ public Builder setEndDate(String endDate) { return this; } + /** + * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no + * end date. + */ + public Builder setEndDate(EmptyParam endDate) { + this.endDate = endDate; + return this; + } + /** * Add a key/value pair to `extraParams` map. A map is initialized for the first * `put/putAll` call, and subsequent calls add additional key/value pairs to the original @@ -39839,6 +39939,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -39849,6 +39955,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -39859,6 +39975,15 @@ public Builder setPurpose( this.purpose = purpose; return this; } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { @@ -43735,7 +43860,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -43789,7 +43914,7 @@ public Builder putAllExtraParam(Map map) { } /** - * 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. */ @@ -43973,7 +44098,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -44086,7 +44214,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentIntentCreateParams.java b/src/main/java/com/stripe/param/PaymentIntentCreateParams.java index 3c04d0ef5f0..f42ed094cb4 100644 --- a/src/main/java/com/stripe/param/PaymentIntentCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentCreateParams.java @@ -21,10 +21,10 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Required. Amount intended to be collected by this PaymentIntent. A positive * integer representing how much to charge in the smallest currency unit (e.g., 100 + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., 100 * cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is * $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -39,7 +39,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -58,10 +58,10 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Set to {@code true} to attempt to confirm this PaymentIntent + * href="https://docs.stripe.com/api/payment_intents/confirm">confirm this PaymentIntent * immediately. This parameter defaults to {@code false}. When creating and confirming a * PaymentIntent at the same time, you can also provide the parameters available in the Confirm API. + * href="https://docs.stripe.com/api/payment_intents/confirm">Confirm API. */ @SerializedName("confirm") Boolean confirm; @@ -96,7 +96,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { *

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 @@ -108,12 +108,12 @@ public class PaymentIntentCreateParams extends ApiRequestParams { String 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 @@ -132,9 +132,9 @@ public class PaymentIntentCreateParams extends ApiRequestParams { * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code * requires_action}. Use this parameter for simpler integrations that don't handle customer * actions, such as saving cards without + * href="https://docs.stripe.com/payments/save-card-without-authentication">saving cards without * authentication. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ @SerializedName("error_on_requires_action") @@ -170,7 +170,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * ID of the mandate that's used for this payment. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ @SerializedName("mandate") @@ -178,14 +178,14 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * This hash contains details about the Mandate to create. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ @SerializedName("mandate_data") Object mandateData; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -196,9 +196,9 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect card - * details and charge them + * details and charge them * later. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ @SerializedName("off_session") @@ -206,7 +206,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts. + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts. */ @SerializedName("on_behalf_of") String onBehalfOf; @@ -217,7 +217,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * ID of the payment method (a PaymentMethod, Card, or compatible Source + * href="https://docs.stripe.com/payments/payment-methods#compatibility">compatible Source * object) to attach to this PaymentIntent. * *

If you don't provide the {@code payment_method} parameter or the {@code source} parameter @@ -225,14 +225,14 @@ public class PaymentIntentCreateParams extends ApiRequestParams { * customer.default_source} to improve migration for users of the Charges API. We recommend that * you explicitly provide the {@code payment_method} moving forward. If the payment method is * attached to a Customer, you must also provide the ID of that Customer as the customer parameter of - * this PaymentIntent. end + * href="https://api.stripe.com#create_payment_intent-customer">customer parameter of this + * PaymentIntent. end */ @SerializedName("payment_method") String paymentMethod; /** - * The ID of the payment + * The ID of the payment * method configuration to use with this PaymentIntent. */ @SerializedName("payment_method_configuration") @@ -241,7 +241,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ @SerializedName("payment_method_data") @@ -270,7 +270,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * Options to configure Radar. Learn more about Radar Sessions. + * href="https://docs.stripe.com/radar/radar-session">Radar Sessions. */ @SerializedName("radar_options") RadarOptions radarOptions; @@ -287,7 +287,7 @@ public class PaymentIntentCreateParams extends ApiRequestParams { * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you can * alternatively supply an application URI scheme. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ @SerializedName("return_url") @@ -322,6 +322,10 @@ public class PaymentIntentCreateParams extends ApiRequestParams { @SerializedName("setup_future_usage") SetupFutureUsage setupFutureUsage; + /** ID of the SharedPaymentToken used to confirm this PaymentIntent. */ + @SerializedName("shared_payment_granted_token") + String sharedPaymentGrantedToken; + /** Shipping information for this PaymentIntent. */ @SerializedName("shipping") Shipping shipping; @@ -351,14 +355,14 @@ public class PaymentIntentCreateParams extends ApiRequestParams { /** * The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts. + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts. */ @SerializedName("transfer_data") TransferData transferData; /** * A string that identifies the resulting payment as part of a group. Learn more about the use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts. */ @SerializedName("transfer_group") @@ -408,6 +412,7 @@ private PaymentIntentCreateParams( String returnUrl, SecretKeyConfirmation secretKeyConfirmation, SetupFutureUsage setupFutureUsage, + String sharedPaymentGrantedToken, Shipping shipping, String statementDescriptor, String statementDescriptorSuffix, @@ -450,6 +455,7 @@ private PaymentIntentCreateParams( this.returnUrl = returnUrl; this.secretKeyConfirmation = secretKeyConfirmation; this.setupFutureUsage = setupFutureUsage; + this.sharedPaymentGrantedToken = sharedPaymentGrantedToken; this.shipping = shipping; this.statementDescriptor = statementDescriptor; this.statementDescriptorSuffix = statementDescriptorSuffix; @@ -535,6 +541,8 @@ public static class Builder { private SetupFutureUsage setupFutureUsage; + private String sharedPaymentGrantedToken; + private Shipping shipping; private String statementDescriptor; @@ -586,6 +594,7 @@ public PaymentIntentCreateParams build() { this.returnUrl, this.secretKeyConfirmation, this.setupFutureUsage, + this.sharedPaymentGrantedToken, this.shipping, this.statementDescriptor, this.statementDescriptorSuffix, @@ -603,10 +612,10 @@ public Builder setAllocatedFunds(PaymentIntentCreateParams.AllocatedFunds alloca /** * Required. Amount intended to be collected by this PaymentIntent. A positive * integer representing how much to charge in the smallest currency unit (e.g., 100 + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., 100 * cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is * $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -625,7 +634,7 @@ public Builder setAmountDetails(PaymentIntentCreateParams.AmountDetails amountDe * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -651,10 +660,10 @@ public Builder setCaptureMethod(PaymentIntentCreateParams.CaptureMethod captureM /** * Set to {@code true} to attempt to confirm this PaymentIntent + * href="https://docs.stripe.com/api/payment_intents/confirm">confirm this PaymentIntent * immediately. This parameter defaults to {@code false}. When creating and confirming a * PaymentIntent at the same time, you can also provide the parameters available in the Confirm API. + * href="https://docs.stripe.com/api/payment_intents/confirm">Confirm API. */ public Builder setConfirm(Boolean confirm) { this.confirm = confirm; @@ -699,7 +708,7 @@ public Builder setCurrency(String currency) { *

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 @@ -713,12 +722,13 @@ public Builder setCustomer(String 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 @@ -741,9 +751,9 @@ public Builder setDescription(String description) { * Set to {@code true} to fail the payment attempt if the PaymentIntent transitions into {@code * requires_action}. Use this parameter for simpler integrations that don't handle customer * actions, such as saving cards without + * href="https://docs.stripe.com/payments/save-card-without-authentication">saving cards without * authentication. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction) { @@ -848,7 +858,7 @@ public Builder setHooks(PaymentIntentCreateParams.Hooks hooks) { /** * ID of the mandate that's used for this payment. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setMandate(String mandate) { @@ -859,7 +869,7 @@ public Builder setMandate(String mandate) { /** * This hash contains details about the Mandate to create. This parameter can only be used with * {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setMandateData(PaymentIntentCreateParams.MandateData mandateData) { @@ -870,7 +880,7 @@ public Builder setMandateData(PaymentIntentCreateParams.MandateData mandateData) /** * This hash contains details about the Mandate to create. This parameter can only be used with * {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setMandateData(EmptyParam mandateData) { @@ -907,9 +917,9 @@ public Builder putAllMetadata(Map map) { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect - * card details and charge + * card details and charge * them later. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setOffSession(Boolean offSession) { @@ -920,9 +930,9 @@ public Builder setOffSession(Boolean offSession) { /** * Set to {@code true} to indicate that the customer isn't in your checkout flow during this * payment attempt and can't authenticate. Use this parameter in scenarios where you collect - * card details and charge + * card details and charge * them later. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setOffSession(PaymentIntentCreateParams.OffSession offSession) { @@ -932,7 +942,7 @@ public Builder setOffSession(PaymentIntentCreateParams.OffSession offSession) { /** * The Stripe account ID that these funds are intended for. Learn more about the use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setOnBehalfOf(String onBehalfOf) { @@ -948,7 +958,7 @@ public Builder setPaymentDetails(PaymentIntentCreateParams.PaymentDetails paymen /** * ID of the payment method (a PaymentMethod, Card, or compatible Source + * href="https://docs.stripe.com/payments/payment-methods#compatibility">compatible Source * object) to attach to this PaymentIntent. * *

If you don't provide the {@code payment_method} parameter or the {@code source} parameter @@ -956,8 +966,8 @@ public Builder setPaymentDetails(PaymentIntentCreateParams.PaymentDetails paymen * customer.default_source} to improve migration for users of the Charges API. We recommend that * you explicitly provide the {@code payment_method} moving forward. If the payment method is * attached to a Customer, you must also provide the ID of that Customer as the customer parameter of - * this PaymentIntent. end + * href="https://api.stripe.com#create_payment_intent-customer">customer parameter of this + * PaymentIntent. end */ public Builder setPaymentMethod(String paymentMethod) { this.paymentMethod = paymentMethod; @@ -965,7 +975,7 @@ public Builder setPaymentMethod(String paymentMethod) { } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this PaymentIntent. */ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) { @@ -976,7 +986,7 @@ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ public Builder setPaymentMethodData( @@ -1030,7 +1040,7 @@ public Builder setPaymentsOrchestration( /** * Options to configure Radar. Learn more about Radar Sessions. + * href="https://docs.stripe.com/radar/radar-session">Radar Sessions. */ public Builder setRadarOptions(PaymentIntentCreateParams.RadarOptions radarOptions) { this.radarOptions = radarOptions; @@ -1051,7 +1061,7 @@ public Builder setReceiptEmail(String receiptEmail) { * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. If you'd prefer to redirect to a mobile application, you * can alternatively supply an application URI scheme. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm">{@code * confirm=true}. */ public Builder setReturnUrl(String returnUrl) { @@ -1094,6 +1104,12 @@ public Builder setSetupFutureUsage( return this; } + /** ID of the SharedPaymentToken used to confirm this PaymentIntent. */ + public Builder setSharedPaymentGrantedToken(String sharedPaymentGrantedToken) { + this.sharedPaymentGrantedToken = sharedPaymentGrantedToken; + return this; + } + /** Shipping information for this PaymentIntent. */ public Builder setShipping(PaymentIntentCreateParams.Shipping shipping) { this.shipping = shipping; @@ -1129,7 +1145,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setTransferData(PaymentIntentCreateParams.TransferData transferData) { @@ -1139,7 +1155,7 @@ public Builder setTransferData(PaymentIntentCreateParams.TransferData transferDa /** * A string that identifies the resulting payment as part of a group. Learn more about the use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts. */ public Builder setTransferGroup(String transferGroup) { @@ -1232,7 +1248,7 @@ public Builder putAllExtraParam(Map map) { public static class AmountDetails { /** * 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 @@ -1301,7 +1317,7 @@ public PaymentIntentCreateParams.AmountDetails build() { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -1314,7 +1330,7 @@ public Builder setDiscountAmount(Long discountAmount) { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -1430,7 +1446,7 @@ public Builder setTax(EmptyParam tax) { public static class LineItem { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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. @@ -1481,7 +1497,7 @@ public static class LineItem { /** * Required. The unit cost of the line item represented in the smallest currency unit. Required + * 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") @@ -1551,7 +1567,7 @@ public PaymentIntentCreateParams.AmountDetails.LineItem build() { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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]} @@ -1636,7 +1652,7 @@ public Builder setTax(PaymentIntentCreateParams.AmountDetails.LineItem.Tax tax) /** * Required. The unit cost of the line item represented in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. */ public Builder setUnitCost(Long unitCost) { @@ -2236,7 +2252,7 @@ public static class Tax { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency unit. + * the smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2295,7 +2311,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency + * the smallest currency * unit. Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2314,7 +2330,7 @@ public Builder setTotalTaxAmount(Long totalTaxAmount) { public static class Shipping { /** * 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") @@ -2375,7 +2391,7 @@ public PaymentIntentCreateParams.AmountDetails.Shipping build() { /** * 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. */ public Builder setAmount(Long amount) { @@ -2385,7 +2401,7 @@ public Builder setAmount(Long amount) { /** * 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. */ public Builder setAmount(EmptyParam amount) { @@ -2473,7 +2489,7 @@ public static class Tax { /** * Required. 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 @@ -2532,7 +2548,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on the transaction represented in the - * smallest currency unit. + * smallest currency unit. * Required for L2 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2554,7 +2570,7 @@ public static class AutomaticPaymentMethods { * *

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. */ @@ -2603,7 +2619,7 @@ public PaymentIntentCreateParams.AutomaticPaymentMethods build() { * *

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. */ @@ -2806,7 +2822,7 @@ public Builder setTax(PaymentIntentCreateParams.Hooks.Inputs.Tax tax) { public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -2843,7 +2859,7 @@ public PaymentIntentCreateParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -2852,7 +2868,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; @@ -4847,7 +4863,10 @@ public static class PickupAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -4962,7 +4981,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -5006,7 +5028,10 @@ public static class ReturnAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -5121,7 +5146,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -6060,7 +6088,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -6178,7 +6209,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -6479,7 +6513,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -6597,7 +6634,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -7808,7 +7848,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -7923,7 +7966,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -11299,7 +11345,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -11412,7 +11461,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -12727,7 +12779,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -12845,7 +12900,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -14228,7 +14286,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -14342,7 +14400,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -15251,7 +15309,7 @@ public Builder setQris(PaymentIntentCreateParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -16263,7 +16321,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -16378,7 +16439,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -17409,6 +17473,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -19122,7 +19189,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -19178,7 +19245,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -24896,7 +24963,7 @@ public static class Card { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ @SerializedName("installments") Installments installments; @@ -24922,7 +24989,7 @@ public static class Card { /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ @SerializedName("request_decremental_authorization") @@ -24930,7 +24997,7 @@ public static class Card { /** * 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. */ @SerializedName("request_extended_authorization") @@ -24938,21 +25005,21 @@ public static class Card { /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ @SerializedName("request_incremental_authorization") RequestIncrementalAuthorization requestIncrementalAuthorization; /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ @SerializedName("request_multicapture") RequestMulticapture requestMulticapture; /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ @SerializedName("request_overcapture") @@ -24965,11 +25032,11 @@ public static class Card { /** * 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. */ @@ -25229,7 +25296,7 @@ public Builder putAllExtraParam(Map map) { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ public Builder setInstallments( PaymentIntentCreateParams.PaymentMethodOptions.Card.Installments installments) { @@ -25266,7 +25333,7 @@ public Builder setNetwork( /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ public Builder setRequestDecrementalAuthorization( @@ -25278,7 +25345,7 @@ public Builder setRequestDecrementalAuthorization( /** * Request ability to capture beyond the + * href="https://docs.stripe.com/payments/extended-authorization">capture beyond the * standard authorization validity window for this PaymentIntent. */ public Builder setRequestExtendedAuthorization( @@ -25290,7 +25357,7 @@ public Builder setRequestExtendedAuthorization( /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ public Builder setRequestIncrementalAuthorization( @@ -25301,7 +25368,7 @@ public Builder setRequestIncrementalAuthorization( } /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ public Builder setRequestMulticapture( @@ -25312,7 +25379,7 @@ public Builder setRequestMulticapture( } /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ public Builder setRequestOvercapture( @@ -25333,11 +25400,11 @@ public Builder setRequestPartialAuthorization( /** * 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. */ @@ -26215,7 +26282,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -26332,7 +26402,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -27110,7 +27183,7 @@ public static class CardPresent { /** * 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") @@ -27118,10 +27191,10 @@ public static class CardPresent { /** * 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") @@ -27219,7 +27292,7 @@ public Builder putAllExtraParam(Map map) { /** * Request ability to capture this payment beyond the standard authorization + * href="https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity">authorization * validity window. */ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorization) { @@ -27229,10 +27302,10 @@ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorizat /** * 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. */ public Builder setRequestIncrementalAuthorizationSupport( @@ -39130,7 +39203,7 @@ public static class Paypal { List lineItems; /** - * Preferred locale of + * Preferred locale of * the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -39321,7 +39394,7 @@ public Builder addAllLineItem( } /** - * Preferred locale + * Preferred locale * of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -40164,7 +40237,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -40172,14 +40245,14 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. */ @SerializedName("end_date") - String endDate; + Object endDate; /** * Map of extra parameters for custom features not available in this client library. The @@ -40193,7 +40266,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -40201,23 +40274,23 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; private MandateOptions( - Long amount, - AmountType amountType, - String endDate, + Object amount, + ApiRequestParams.EnumParam amountType, + Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -40232,19 +40305,19 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; - private String endDate; + private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; /** Finalize and obtain parameter instance from this builder. */ public PaymentIntentCreateParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -40267,6 +40340,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -40279,6 +40361,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -40288,6 +40380,15 @@ public Builder setEndDate(String endDate) { return this; } + /** + * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no + * end date. + */ + public Builder setEndDate(EmptyParam endDate) { + this.endDate = endDate; + return this; + } + /** * Add a key/value pair to `extraParams` map. A map is initialized for the first * `put/putAll` call, and subsequent calls add additional key/value pairs to the original @@ -40326,6 +40427,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -40336,6 +40443,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -40345,6 +40462,15 @@ public Builder setPurpose( this.purpose = purpose; return this; } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { @@ -44284,7 +44410,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -44337,7 +44463,7 @@ public Builder putAllExtraParam(Map map) { } /** - * 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. */ @@ -44521,7 +44647,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -44634,7 +44763,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -44652,7 +44784,7 @@ public static class TransferData { * transferred. * *

If you intend to collect a fee and you need a more robust reporting experience, using application_fee_amount + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-application_fee_amount">application_fee_amount * might be a better fit for your integration. */ @SerializedName("amount") @@ -44705,7 +44837,7 @@ public PaymentIntentCreateParams.TransferData build() { * transferred. * *

If you intend to collect a fee and you need a more robust reporting experience, using application_fee_amount + * href="https://docs.stripe.com/api/payment_intents/create#create_payment_intent-application_fee_amount">application_fee_amount * might be a better fit for your integration. */ public Builder setAmount(Long amount) { diff --git a/src/main/java/com/stripe/param/PaymentIntentDecrementAuthorizationParams.java b/src/main/java/com/stripe/param/PaymentIntentDecrementAuthorizationParams.java index ce331d85a26..5402ed3cc42 100644 --- a/src/main/java/com/stripe/param/PaymentIntentDecrementAuthorizationParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentDecrementAuthorizationParams.java @@ -26,7 +26,7 @@ public class PaymentIntentDecrementAuthorizationParams extends ApiRequestParams * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -54,7 +54,7 @@ public class PaymentIntentDecrementAuthorizationParams extends ApiRequestParams Hooks hooks; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -64,7 +64,7 @@ public class PaymentIntentDecrementAuthorizationParams extends ApiRequestParams /** * The parameters used to automatically create a transfer after the payment is captured. Learn - * more about the use case for + * more about the use case for * connected accounts. */ @SerializedName("transfer_data") @@ -137,7 +137,7 @@ public Builder setAmount(Long amount) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -238,7 +238,7 @@ public Builder putAllMetadata(Map map) { /** * The parameters used to automatically create a transfer after the payment is captured. Learn - * more about the use case for + * more about the use case for * connected accounts. */ public Builder setTransferData( @@ -393,7 +393,7 @@ public Builder setTax(PaymentIntentDecrementAuthorizationParams.Hooks.Inputs.Tax public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -430,7 +430,7 @@ public PaymentIntentDecrementAuthorizationParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -439,7 +439,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; diff --git a/src/main/java/com/stripe/param/PaymentIntentIncrementAuthorizationParams.java b/src/main/java/com/stripe/param/PaymentIntentIncrementAuthorizationParams.java index ee6585f11b4..9f6a0e99269 100644 --- a/src/main/java/com/stripe/param/PaymentIntentIncrementAuthorizationParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentIncrementAuthorizationParams.java @@ -29,7 +29,7 @@ public class PaymentIntentIncrementAuthorizationParams extends ApiRequestParams * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -57,7 +57,7 @@ public class PaymentIntentIncrementAuthorizationParams extends ApiRequestParams Hooks hooks; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -85,7 +85,7 @@ public class PaymentIntentIncrementAuthorizationParams extends ApiRequestParams /** * The parameters used to automatically create a transfer after the payment is captured. Learn - * more about the use case for + * more about the use case for * connected accounts. */ @SerializedName("transfer_data") @@ -184,7 +184,7 @@ public Builder setAmountDetails( * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -311,7 +311,7 @@ public Builder setStatementDescriptor(String statementDescriptor) { /** * The parameters used to automatically create a transfer after the payment is captured. Learn - * more about the use case for + * more about the use case for * connected accounts. */ public Builder setTransferData( @@ -326,7 +326,7 @@ public Builder setTransferData( public static class AmountDetails { /** * 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 @@ -395,7 +395,7 @@ public PaymentIntentIncrementAuthorizationParams.AmountDetails build() { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -408,7 +408,7 @@ public Builder setDiscountAmount(Long discountAmount) { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -533,7 +533,7 @@ public Builder setTax(EmptyParam tax) { public static class LineItem { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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. @@ -584,7 +584,7 @@ public static class LineItem { /** * Required. The unit cost of the line item represented in the smallest currency unit. Required + * 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") @@ -654,7 +654,7 @@ public PaymentIntentIncrementAuthorizationParams.AmountDetails.LineItem build() /** * The discount applied on this line item represented in the smallest currency unit. An + * 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]} @@ -742,7 +742,7 @@ public Builder setTax( /** * Required. The unit cost of the line item represented in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. */ public Builder setUnitCost(Long unitCost) { @@ -1357,7 +1357,7 @@ public static class Tax { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency unit. + * the smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1418,7 +1418,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency + * the smallest currency * unit. Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1437,7 +1437,7 @@ public Builder setTotalTaxAmount(Long totalTaxAmount) { public static class Shipping { /** * 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") @@ -1498,7 +1498,7 @@ public PaymentIntentIncrementAuthorizationParams.AmountDetails.Shipping build() /** * 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. */ public Builder setAmount(Long amount) { @@ -1508,7 +1508,7 @@ public Builder setAmount(Long amount) { /** * 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. */ public Builder setAmount(EmptyParam amount) { @@ -1598,7 +1598,7 @@ public static class Tax { /** * Required. 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 @@ -1657,7 +1657,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on the transaction represented in the - * smallest currency unit. + * smallest currency unit. * Required for L2 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -1816,7 +1816,7 @@ public Builder setTax(PaymentIntentIncrementAuthorizationParams.Hooks.Inputs.Tax public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -1853,7 +1853,7 @@ public PaymentIntentIncrementAuthorizationParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -1862,7 +1862,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; diff --git a/src/main/java/com/stripe/param/PaymentIntentListParams.java b/src/main/java/com/stripe/param/PaymentIntentListParams.java index 3f23b64071a..80af19d8a5d 100644 --- a/src/main/java/com/stripe/param/PaymentIntentListParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentListParams.java @@ -24,7 +24,9 @@ public class PaymentIntentListParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** Only return PaymentIntents for the account that this ID specifies. */ + /** + * Only return PaymentIntents for the account representing the customer that this ID specifies. + */ @SerializedName("customer_account") String customerAccount; @@ -143,7 +145,9 @@ public Builder setCustomer(String customer) { return this; } - /** Only return PaymentIntents for the account that this ID specifies. */ + /** + * Only return PaymentIntents for the account representing the customer that this ID specifies. + */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/PaymentIntentSearchParams.java b/src/main/java/com/stripe/param/PaymentIntentSearchParams.java index 8221c82d580..2d3c0a37d24 100644 --- a/src/main/java/com/stripe/param/PaymentIntentSearchParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentSearchParams.java @@ -43,9 +43,9 @@ public class PaymentIntentSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the + * href="https://docs.stripe.com/search#search-query-language">search query language and the * list of supported query fields for payment + * href="https://docs.stripe.com/search#query-fields-for-payment-intents">query fields for payment * intents. */ @SerializedName("query") @@ -154,9 +154,9 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the + * href="https://docs.stripe.com/search#search-query-language">search query language and the * list of supported query fields for + * href="https://docs.stripe.com/search#query-fields-for-payment-intents">query fields for * payment intents. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java b/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java index fe7f48d6c39..0df0c2f5353 100644 --- a/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentIntentUpdateParams.java @@ -20,10 +20,10 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how much - * to charge in the smallest currency + * to charge in the smallest currency * unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The * minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -38,7 +38,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { * The amount of the application fee (if any) that will be requested to be applied to the payment * and transferred to the application owner's Stripe account. The amount of the application fee * collected will be capped at the total amount captured. For more information, see the - * PaymentIntents use case for + * PaymentIntents use case for * connected accounts. */ @SerializedName("application_fee_amount") @@ -61,7 +61,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { *

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 @@ -73,12 +73,12 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { Object 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 @@ -126,7 +126,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { MandateData mandateData; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -142,7 +142,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { Object paymentMethod; /** - * The ID of the payment + * The ID of the payment * method configuration to use with this PaymentIntent. */ @SerializedName("payment_method_configuration") @@ -151,7 +151,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ @SerializedName("payment_method_data") @@ -233,7 +233,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * Use this parameter to automatically create a Transfer when the payment succeeds. Learn more - * about the use case for connected + * about the use case for connected * accounts. */ @SerializedName("transfer_data") @@ -242,7 +242,7 @@ public class PaymentIntentUpdateParams extends ApiRequestParams { /** * A string that identifies the resulting payment as part of a group. You can only provide {@code * transfer_group} if it hasn't been set. Learn more about the use case for connected accounts. + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected accounts. */ @SerializedName("transfer_group") Object transferGroup; @@ -413,10 +413,10 @@ public Builder setAllocatedFunds(PaymentIntentUpdateParams.AllocatedFunds alloca /** * Amount intended to be collected by this PaymentIntent. A positive integer representing how - * much to charge in the smallest + * much to charge in the smallest * currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal * currency). The minimum amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -441,7 +441,7 @@ public Builder setAmountDetails(EmptyParam amountDetails) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -453,7 +453,7 @@ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ public Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount) { @@ -493,7 +493,7 @@ public Builder setCurrency(EmptyParam currency) { *

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 @@ -512,7 +512,7 @@ public Builder setCustomer(String customer) { *

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 @@ -526,12 +526,13 @@ public Builder setCustomer(EmptyParam 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 @@ -545,12 +546,13 @@ public Builder setCustomerAccount(String customerAccount) { } /** - * 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 @@ -735,7 +737,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -746,7 +748,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -779,7 +781,7 @@ public Builder setPaymentMethod(EmptyParam paymentMethod) { } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this PaymentIntent. */ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) { @@ -788,7 +790,7 @@ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this PaymentIntent. */ public Builder setPaymentMethodConfiguration(EmptyParam paymentMethodConfiguration) { @@ -799,7 +801,7 @@ public Builder setPaymentMethodConfiguration(EmptyParam paymentMethodConfigurati /** * If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will * appear in the payment_method + * href="https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method">payment_method * property on the PaymentIntent. */ public Builder setPaymentMethodData( @@ -986,7 +988,7 @@ public Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix /** * Use this parameter to automatically create a Transfer when the payment succeeds. Learn more - * about the use case for + * about the use case for * connected accounts. */ public Builder setTransferData(PaymentIntentUpdateParams.TransferData transferData) { @@ -997,7 +999,7 @@ public Builder setTransferData(PaymentIntentUpdateParams.TransferData transferDa /** * A string that identifies the resulting payment as part of a group. You can only provide * {@code transfer_group} if it hasn't been set. Learn more about the use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setTransferGroup(String transferGroup) { @@ -1008,7 +1010,7 @@ public Builder setTransferGroup(String transferGroup) { /** * A string that identifies the resulting payment as part of a group. You can only provide * {@code transfer_group} if it hasn't been set. Learn more about the use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setTransferGroup(EmptyParam transferGroup) { @@ -1092,7 +1094,7 @@ public Builder putAllExtraParam(Map map) { public static class AmountDetails { /** * 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 @@ -1161,7 +1163,7 @@ public PaymentIntentUpdateParams.AmountDetails build() { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -1174,7 +1176,7 @@ public Builder setDiscountAmount(Long discountAmount) { /** * The total discount applied on the transaction represented in the smallest currency unit. An + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. An * integer greater than 0. * *

This field is mutually exclusive with the {@code @@ -1290,7 +1292,7 @@ public Builder setTax(EmptyParam tax) { public static class LineItem { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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. @@ -1341,7 +1343,7 @@ public static class LineItem { /** * Required. The unit cost of the line item represented in the smallest currency unit. Required + * 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") @@ -1411,7 +1413,7 @@ public PaymentIntentUpdateParams.AmountDetails.LineItem build() { /** * The discount applied on this line item represented in the smallest currency unit. An + * 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]} @@ -1517,7 +1519,7 @@ public Builder setTax(PaymentIntentUpdateParams.AmountDetails.LineItem.Tax tax) /** * Required. The unit cost of the line item represented in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. */ public Builder setUnitCost(Long unitCost) { @@ -2180,7 +2182,7 @@ public static class Tax { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency unit. + * the smallest currency unit. * Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2239,7 +2241,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on a single line item represented in - * the smallest currency + * the smallest currency * unit. Required for L3 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2258,7 +2260,7 @@ public Builder setTotalTaxAmount(Long totalTaxAmount) { public static class Shipping { /** * 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") @@ -2319,7 +2321,7 @@ public PaymentIntentUpdateParams.AmountDetails.Shipping build() { /** * 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. */ public Builder setAmount(Long amount) { @@ -2329,7 +2331,7 @@ public Builder setAmount(Long amount) { /** * 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. */ public Builder setAmount(EmptyParam amount) { @@ -2417,7 +2419,7 @@ public static class Tax { /** * Required. 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 @@ -2476,7 +2478,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The total amount of tax on the transaction represented in the - * smallest currency unit. + * smallest currency unit. * Required for L2 rates. An integer greater than or equal to 0. * *

This field is mutually exclusive with the {@code @@ -2633,7 +2635,7 @@ public Builder setTax(PaymentIntentUpdateParams.Hooks.Inputs.Tax tax) { public static class Tax { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ @SerializedName("calculation") Object calculation; @@ -2670,7 +2672,7 @@ public PaymentIntentUpdateParams.Hooks.Inputs.Tax build() { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(String calculation) { this.calculation = calculation; @@ -2679,7 +2681,7 @@ public Builder setCalculation(String calculation) { /** * Required. The TaxCalculation id + * href="https://docs.stripe.com/api/tax/calculations">TaxCalculation id */ public Builder setCalculation(EmptyParam calculation) { this.calculation = calculation; @@ -4681,7 +4683,10 @@ public static class PickupAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -4829,13 +4834,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -4879,7 +4890,10 @@ public static class ReturnAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -5027,13 +5041,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -6032,7 +6052,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -6186,13 +6209,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -6511,7 +6540,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -6665,13 +6697,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -7942,7 +7980,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -8090,13 +8131,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -11771,7 +11818,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -11917,13 +11967,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -13349,7 +13405,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -13503,13 +13562,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -14943,7 +15008,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -15057,7 +15122,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -15966,7 +16031,7 @@ public Builder setQris(PaymentIntentUpdateParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -17029,7 +17094,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -17177,13 +17245,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -18223,6 +18297,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -19992,7 +20069,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -20048,7 +20125,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -20058,7 +20135,7 @@ public Builder setSession(String session) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -25872,7 +25949,7 @@ public static class Card { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ @SerializedName("installments") Installments installments; @@ -25898,7 +25975,7 @@ public static class Card { /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ @SerializedName("request_decremental_authorization") @@ -25906,7 +25983,7 @@ public static class Card { /** * 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. */ @SerializedName("request_extended_authorization") @@ -25914,21 +25991,21 @@ public static class Card { /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ @SerializedName("request_incremental_authorization") RequestIncrementalAuthorization requestIncrementalAuthorization; /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ @SerializedName("request_multicapture") RequestMulticapture requestMulticapture; /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ @SerializedName("request_overcapture") @@ -25941,11 +26018,11 @@ public static class Card { /** * 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. */ @@ -26215,7 +26292,7 @@ public Builder putAllExtraParam(Map map) { * Installment configuration for payments attempted on this PaymentIntent. * *

For more information, see the installments integration guide. + * href="https://docs.stripe.com/payments/installments">installments integration guide. */ public Builder setInstallments( PaymentIntentUpdateParams.PaymentMethodOptions.Card.Installments installments) { @@ -26252,7 +26329,7 @@ public Builder setNetwork( /** * Request ability to decrement the + * href="https://docs.stripe.com/payments/decremental-authorization">decrement the * authorization for this PaymentIntent. */ public Builder setRequestDecrementalAuthorization( @@ -26264,7 +26341,7 @@ public Builder setRequestDecrementalAuthorization( /** * Request ability to capture beyond the + * href="https://docs.stripe.com/payments/extended-authorization">capture beyond the * standard authorization validity window for this PaymentIntent. */ public Builder setRequestExtendedAuthorization( @@ -26276,7 +26353,7 @@ public Builder setRequestExtendedAuthorization( /** * Request ability to increment the + * href="https://docs.stripe.com/payments/incremental-authorization">increment the * authorization for this PaymentIntent. */ public Builder setRequestIncrementalAuthorization( @@ -26287,7 +26364,7 @@ public Builder setRequestIncrementalAuthorization( } /** - * Request ability to make multiple + * Request ability to make multiple * captures for this PaymentIntent. */ public Builder setRequestMulticapture( @@ -26298,7 +26375,7 @@ public Builder setRequestMulticapture( } /** - * Request ability to overcapture + * Request ability to overcapture * for this PaymentIntent. */ public Builder setRequestOvercapture( @@ -26319,11 +26396,11 @@ public Builder setRequestPartialAuthorization( /** * 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. */ @@ -27222,7 +27299,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -27372,13 +27452,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -28195,7 +28281,7 @@ public static class CardPresent { /** * 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") @@ -28203,10 +28289,10 @@ public static class CardPresent { /** * 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") @@ -28304,7 +28390,7 @@ public Builder putAllExtraParam(Map map) { /** * Request ability to capture this payment beyond the standard authorization + * href="https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity">authorization * validity window. */ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorization) { @@ -28314,10 +28400,10 @@ public Builder setRequestExtendedAuthorization(Boolean requestExtendedAuthorizat /** * 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. */ public Builder setRequestIncrementalAuthorizationSupport( @@ -40920,7 +41006,7 @@ public static class Paypal { List lineItems; /** - * Preferred locale of + * Preferred locale of * the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -41111,7 +41197,7 @@ public Builder addAllLineItem( } /** - * Preferred locale + * Preferred locale * of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -42006,7 +42092,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -42014,7 +42100,7 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no @@ -42035,7 +42121,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -42043,23 +42129,23 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; private MandateOptions( - Long amount, - AmountType amountType, + Object amount, + ApiRequestParams.EnumParam amountType, Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -42074,19 +42160,19 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; /** Finalize and obtain parameter instance from this builder. */ public PaymentIntentUpdateParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -42109,6 +42195,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -42121,6 +42216,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -42177,6 +42282,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -42187,6 +42298,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -42196,6 +42317,15 @@ public Builder setPurpose( this.purpose = purpose; return this; } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { @@ -46330,7 +46460,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -46476,13 +46609,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentLinkCreateParams.java b/src/main/java/com/stripe/param/PaymentLinkCreateParams.java index fe94aaaa8c2..0e4efdf3443 100644 --- a/src/main/java/com/stripe/param/PaymentLinkCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentLinkCreateParams.java @@ -72,9 +72,9 @@ public class PaymentLinkCreateParams extends ApiRequestParams { CustomText customText; /** - * Configures whether checkout + * Configures whether checkout * sessions created by this payment link create a Customer. + * href="https://docs.stripe.com/api/customers">Customer. */ @SerializedName("customer_creation") CustomerCreation customerCreation; @@ -108,12 +108,12 @@ public class PaymentLinkCreateParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. Metadata associated with this Payment * Link will automatically be copied to checkout sessions created by this + * href="https://docs.stripe.com/api/checkout/sessions">checkout sessions created by this * payment link. */ @SerializedName("metadata") @@ -129,7 +129,7 @@ public class PaymentLinkCreateParams extends ApiRequestParams { /** * A list of optional items the customer can add to their order at checkout. Use this parameter to - * pass one-time or recurring Prices. There is a + * pass one-time or recurring Prices. There is a * maximum of 10 optional items allowed on a payment link, and the existing limits on the number * of line items allowed on a payment link apply to the combined number of line items and optional * items. There is a maximum of 20 combined line items and optional items. @@ -152,7 +152,7 @@ public class PaymentLinkCreateParams extends ApiRequestParams { *

Can only be set in {@code subscription} mode. Defaults to {@code always}. * *

If you'd like information on how to collect a payment method outside of Checkout, read the - * guide on configuring + * guide on configuring * subscriptions with a free trial. */ @SerializedName("payment_method_collection") @@ -163,7 +163,7 @@ public class PaymentLinkCreateParams extends ApiRequestParams { * dynamically show relevant payment methods from your payment method settings (20+ * payment methods supported). + * href="https://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support">supported). */ @SerializedName("payment_method_types") List paymentMethodTypes; @@ -186,7 +186,7 @@ public class PaymentLinkCreateParams extends ApiRequestParams { /** * The shipping rate options to apply to checkout sessions created by this + * href="https://docs.stripe.com/api/checkout/sessions">checkout sessions created by this * payment link. */ @SerializedName("shipping_options") @@ -195,7 +195,7 @@ public class PaymentLinkCreateParams extends ApiRequestParams { /** * Describes the type of transaction being performed in order to customize relevant text on the * page, such as the submit button. Changing this value will also affect the hostname in the url property + * href="https://docs.stripe.com/api/payment_links/payment_links/object#url">url property * (example: {@code donate.stripe.com}). */ @SerializedName("submit_type") @@ -483,9 +483,9 @@ public Builder setCustomText(PaymentLinkCreateParams.CustomText customText) { } /** - * Configures whether checkout + * Configures whether checkout * sessions created by this payment link create a Customer. + * href="https://docs.stripe.com/api/customers">Customer. */ public Builder setCustomerCreation(PaymentLinkCreateParams.CustomerCreation customerCreation) { this.customerCreation = customerCreation; @@ -664,7 +664,7 @@ public Builder setPaymentIntentData( *

Can only be set in {@code subscription} mode. Defaults to {@code always}. * *

If you'd like information on how to collect a payment method outside of Checkout, read the - * guide on configuring + * guide on configuring * subscriptions with a free trial. */ public Builder setPaymentMethodCollection( @@ -753,7 +753,7 @@ public Builder addAllShippingOption(List /** * Describes the type of transaction being performed in order to customize relevant text on the * page, such as the submit button. Changing this value will also affect the hostname in the url property + * href="https://docs.stripe.com/api/payment_links/payment_links/object#url">url property * (example: {@code donate.stripe.com}). */ public Builder setSubmitType(PaymentLinkCreateParams.SubmitType submitType) { @@ -981,7 +981,7 @@ public static class Redirect { * Required. The URL the customer will be redirected to after the purchase is * complete. You can embed {@code {CHECKOUT_SESSION_ID}} into the URL to have the {@code id} * of the completed checkout + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id">checkout * session included. */ @SerializedName("url") @@ -1038,7 +1038,7 @@ public Builder putAllExtraParam(Map map) { * Required. The URL the customer will be redirected to after the purchase * is complete. You can embed {@code {CHECKOUT_SESSION_ID}} into the URL to have the {@code * id} of the completed checkout + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id">checkout * session included. */ public Builder setUrl(String url) { @@ -2809,7 +2809,7 @@ public static class InvoiceData { Issuer issuer; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -3048,7 +3048,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -3059,7 +3059,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -3438,15 +3438,15 @@ public static class LineItem { Map extraParams; /** - * The ID of the Price or Plan object. One of {@code price} or {@code + * The ID of the Price or Plan object. One of {@code price} or {@code * price_data} is required. */ @SerializedName("price") String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -3527,8 +3527,8 @@ public Builder putAllExtraParam(Map map) { } /** - * The ID of the Price or Plan object. One of {@code price} or {@code + * The ID of the Price or Plan object. One of {@code price} or {@code * price_data} is required. */ public Builder setPrice(String price) { @@ -3537,7 +3537,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(PaymentLinkCreateParams.LineItem.PriceData priceData) { @@ -3712,7 +3712,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -3858,7 +3858,7 @@ public Builder setRecurring( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -3919,7 +3919,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -3933,10 +3933,18 @@ public static class ProductData { @SerializedName("name") String name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -3951,6 +3959,7 @@ private ProductData( Map metadata, String name, String taxCode, + TaxDetails taxDetails, String unitLabel) { this.description = description; this.extraParams = extraParams; @@ -3958,6 +3967,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -3978,6 +3988,8 @@ public static class Builder { private String taxCode; + private TaxDetails taxDetails; + private String unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -3989,6 +4001,7 @@ public PaymentLinkCreateParams.LineItem.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -4094,12 +4107,23 @@ public Builder setName(String name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + PaymentLinkCreateParams.LineItem.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -4109,6 +4133,87 @@ public Builder setUnitLabel(String unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + String taxCode; + + private TaxDetails(Map extraParams, String taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public PaymentLinkCreateParams.LineItem.PriceData.ProductData.TaxDetails build() { + return new PaymentLinkCreateParams.LineItem.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * PaymentLinkCreateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for + * the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * PaymentLinkCreateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for + * the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } @Getter @@ -4552,8 +4657,8 @@ public static class OptionalItem { /** * Required. The ID of the Price or Plan object. + * href="https://docs.stripe.com/api/prices">Price or Plan object. */ @SerializedName("price") String price; @@ -4633,8 +4738,8 @@ public Builder putAllExtraParam(Map map) { /** * Required. The ID of the Price or Plan object. + * href="https://docs.stripe.com/api/prices">Price or Plan object. */ public Builder setPrice(String price) { this.price = price; @@ -4792,8 +4897,8 @@ public static class PaymentIntentData { Map extraParams; /** - * Set of key-value pairs that will - * declaratively set metadata on Payment + * Set of key-value pairs that will + * declaratively set metadata on Payment * Intents generated from this payment link. Unlike object-level metadata, this field is * declarative. Updates will clear prior values. */ @@ -4802,7 +4907,7 @@ public static class PaymentIntentData { /** * Indicates that you intend to make future payments + * href="https://docs.stripe.com/payments/payment-intents#future-usage">make future payments * with the payment method collected by this Checkout Session. * *

When setting this to {@code on_session}, Checkout will show a notice to the customer that @@ -4849,7 +4954,7 @@ public static class PaymentIntentData { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts for details. */ @SerializedName("transfer_group") @@ -4976,7 +5081,7 @@ public Builder putAllMetadata(Map map) { /** * Indicates that you intend to make future + * href="https://docs.stripe.com/payments/payment-intents#future-usage">make future * payments with the payment method collected by this Checkout Session. * *

When setting this to {@code on_session}, Checkout will show a notice to the customer @@ -5031,7 +5136,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents - * use case for + * use case for * connected accounts for details. */ public Builder setTransferGroup(String transferGroup) { @@ -6215,9 +6320,9 @@ public static class SubscriptionData { InvoiceSettings invoiceSettings; /** - * Set of key-value pairs that will + * Set of key-value pairs that will * declaratively set metadata on Subscriptions generated from this + * href="https://docs.stripe.com/api/subscriptions">Subscriptions generated from this * payment link. Unlike object-level metadata, this field is declarative. Updates will clear * prior values. */ diff --git a/src/main/java/com/stripe/param/PaymentLinkUpdateParams.java b/src/main/java/com/stripe/param/PaymentLinkUpdateParams.java index c732d0704e5..cdb986b412c 100644 --- a/src/main/java/com/stripe/param/PaymentLinkUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentLinkUpdateParams.java @@ -49,9 +49,9 @@ public class PaymentLinkUpdateParams extends ApiRequestParams { CustomText customText; /** - * Configures whether checkout + * Configures whether checkout * sessions created by this payment link create a Customer. + * href="https://docs.stripe.com/api/customers">Customer. */ @SerializedName("customer_creation") CustomerCreation customerCreation; @@ -85,12 +85,12 @@ public class PaymentLinkUpdateParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. Metadata associated with this Payment * Link will automatically be copied to checkout sessions created by this + * href="https://docs.stripe.com/api/checkout/sessions">checkout sessions created by this * payment link. */ @SerializedName("metadata") @@ -115,7 +115,7 @@ public class PaymentLinkUpdateParams extends ApiRequestParams { *

Can only be set in {@code subscription} mode. Defaults to {@code always}. * *

If you'd like information on how to collect a payment method outside of Checkout, read the - * guide on configuring + * guide on configuring * subscriptions with a free trial. */ @SerializedName("payment_method_collection") @@ -148,7 +148,7 @@ public class PaymentLinkUpdateParams extends ApiRequestParams { /** * Describes the type of transaction being performed in order to customize relevant text on the * page, such as the submit button. Changing this value will also affect the hostname in the url property + * href="https://docs.stripe.com/api/payment_links/payment_links/object#url">url property * (example: {@code donate.stripe.com}). */ @SerializedName("submit_type") @@ -385,9 +385,9 @@ public Builder setCustomText(PaymentLinkUpdateParams.CustomText customText) { } /** - * Configures whether checkout + * Configures whether checkout * sessions created by this payment link create a Customer. + * href="https://docs.stripe.com/api/customers">Customer. */ public Builder setCustomerCreation(PaymentLinkUpdateParams.CustomerCreation customerCreation) { this.customerCreation = customerCreation; @@ -546,7 +546,7 @@ public Builder setPaymentIntentData( *

Can only be set in {@code subscription} mode. Defaults to {@code always}. * *

If you'd like information on how to collect a payment method outside of Checkout, read the - * guide on configuring + * guide on configuring * subscriptions with a free trial. */ public Builder setPaymentMethodCollection( @@ -644,7 +644,7 @@ public Builder setShippingAddressCollection(EmptyParam shippingAddressCollection /** * Describes the type of transaction being performed in order to customize relevant text on the * page, such as the submit button. Changing this value will also affect the hostname in the url property + * href="https://docs.stripe.com/api/payment_links/payment_links/object#url">url property * (example: {@code donate.stripe.com}). */ public Builder setSubmitType(PaymentLinkUpdateParams.SubmitType submitType) { @@ -869,7 +869,7 @@ public static class Redirect { * Required. The URL the customer will be redirected to after the purchase is * complete. You can embed {@code {CHECKOUT_SESSION_ID}} into the URL to have the {@code id} * of the completed checkout + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id">checkout * session included. */ @SerializedName("url") @@ -926,7 +926,7 @@ public Builder putAllExtraParam(Map map) { * Required. The URL the customer will be redirected to after the purchase * is complete. You can embed {@code {CHECKOUT_SESSION_ID}} into the URL to have the {@code * id} of the completed checkout + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id">checkout * session included. */ public Builder setUrl(String url) { @@ -938,7 +938,7 @@ public Builder setUrl(String url) { * Required. The URL the customer will be redirected to after the purchase * is complete. You can embed {@code {CHECKOUT_SESSION_ID}} into the URL to have the {@code * id} of the completed checkout + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id">checkout * session included. */ public Builder setUrl(EmptyParam url) { @@ -2534,7 +2534,7 @@ public static class InvoiceData { Issuer issuer; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2785,7 +2785,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -2796,7 +2796,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -3710,8 +3710,8 @@ public static class PaymentIntentData { Map extraParams; /** - * Set of key-value pairs that will - * declaratively set metadata on Payment + * Set of key-value pairs that will + * declaratively set metadata on Payment * Intents generated from this payment link. Unlike object-level metadata, this field is * declarative. Updates will clear prior values. */ @@ -3743,7 +3743,7 @@ public static class PaymentIntentData { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts for details. */ @SerializedName("transfer_group") @@ -3860,8 +3860,8 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that will - * declaratively set metadata on Payment + * Set of key-value pairs that will + * declaratively set metadata on Payment * Intents generated from this payment link. Unlike object-level metadata, this field is * declarative. Updates will clear prior values. */ @@ -3871,8 +3871,8 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that will - * declaratively set metadata on Payment + * Set of key-value pairs that will + * declaratively set metadata on Payment * Intents generated from this payment link. Unlike object-level metadata, this field is * declarative. Updates will clear prior values. */ @@ -3937,7 +3937,7 @@ public Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents - * use case for + * use case for * connected accounts for details. */ public Builder setTransferGroup(String transferGroup) { @@ -3947,7 +3947,7 @@ public Builder setTransferGroup(String transferGroup) { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents - * use case for + * use case for * connected accounts for details. */ public Builder setTransferGroup(EmptyParam transferGroup) { @@ -5021,9 +5021,9 @@ public static class SubscriptionData { InvoiceSettings invoiceSettings; /** - * Set of key-value pairs that will + * Set of key-value pairs that will * declaratively set metadata on Subscriptions generated from this + * href="https://docs.stripe.com/api/subscriptions">Subscriptions generated from this * payment link. Unlike object-level metadata, this field is declarative. Updates will clear * prior values. */ @@ -5142,9 +5142,9 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that will + * Set of key-value pairs that will * declaratively set metadata on Subscriptions generated from this + * href="https://docs.stripe.com/api/subscriptions">Subscriptions generated from this * payment link. Unlike object-level metadata, this field is declarative. Updates will clear * prior values. */ @@ -5154,9 +5154,9 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that will + * Set of key-value pairs that will * declaratively set metadata on Subscriptions generated from this + * href="https://docs.stripe.com/api/subscriptions">Subscriptions generated from this * payment link. Unlike object-level metadata, this field is declarative. Updates will clear * prior values. */ diff --git a/src/main/java/com/stripe/param/PaymentMethodAttachParams.java b/src/main/java/com/stripe/param/PaymentMethodAttachParams.java index abe5db3e3dd..d0f2362559d 100644 --- a/src/main/java/com/stripe/param/PaymentMethodAttachParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodAttachParams.java @@ -17,7 +17,7 @@ public class PaymentMethodAttachParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** The ID of the account to which to attach the PaymentMethod. */ + /** The ID of the Account representing the customer to which to attach the PaymentMethod. */ @SerializedName("customer_account") String customerAccount; @@ -70,7 +70,7 @@ public Builder setCustomer(String customer) { return this; } - /** The ID of the account to which to attach the PaymentMethod. */ + /** The ID of the Account representing the customer to which to attach the PaymentMethod. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/PaymentMethodConfigurationCreateParams.java b/src/main/java/com/stripe/param/PaymentMethodConfigurationCreateParams.java index 9046e4215fb..c0ccf557547 100644 --- a/src/main/java/com/stripe/param/PaymentMethodConfigurationCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodConfigurationCreateParams.java @@ -15,7 +15,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Canadian pre-authorized debit payments, check this page for more details like country + * href="https://docs.stripe.com/payments/acss-debit">page for more details like country * availability. */ @SerializedName("acss_debit") @@ -25,7 +25,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Affirm gives your customers a way to split purchases over * a series of payments. Depending on the purchase, they can pay with four interest-free payments * (Split Pay) or pay over a longer term (Installments), which might include interest. Check this - * page for more details like country + * page for more details like country * availability. */ @SerializedName("affirm") @@ -33,7 +33,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like + * href="https://docs.stripe.com/payments/afterpay-clearpay">page for more details like * country availability. Afterpay is particularly popular among businesses selling fashion, * beauty, and sports products. */ @@ -44,7 +44,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay * users can pay on the web or on a mobile device using login credentials or their Alipay app. * Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's - * login credentials. Check this page for + * login credentials. Check this page for * more details. */ @SerializedName("alipay") @@ -69,7 +69,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. * There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions. Check - * this page for more details. + * this page for more details. */ @SerializedName("apple_pay") ApplePay applePay; @@ -84,7 +84,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with an Australian bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/au-becs-debit">page for more details. */ @SerializedName("au_becs_debit") AuBecsDebit auBecsDebit; @@ -92,17 +92,17 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank * account, check this page for more details. + * href="https://docs.stripe.com/payments/payment-methods/bacs-debit">page for more details. */ @SerializedName("bacs_debit") BacsDebit bacsDebit; /** * Bancontact is the most popular online payment method in Belgium, with over 15 million cards in - * circulation. Customers use a Bancontact + * circulation. Customers use a Bancontact * card or mobile app linked to a Belgian bank account to make online payments that are secure, * guaranteed, and confirmed immediately. Check this page for more details. + * href="https://docs.stripe.com/payments/bancontact">page for more details. */ @SerializedName("bancontact") Bancontact bancontact; @@ -119,18 +119,18 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { Billie billie; /** - * BLIK is a single use + * BLIK is a single use * payment method that requires customers to authenticate their payments. When customers want to * pay online using BLIK, they request a six-digit code from their banking application and enter * it into the payment collection form. Check this page for more details. + * href="https://docs.stripe.com/payments/blik">page for more details. */ @SerializedName("blik") Blik blik; /** * Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check - * this page for more details. + * this page for more details. */ @SerializedName("boleto") Boleto boleto; @@ -146,7 +146,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded * with either Visa or Mastercard, meaning you can process these cards over either Cartes * Bancaires or the Visa or Mastercard networks. Check this page for more details. + * href="https://docs.stripe.com/payments/cartes-bancaires">page for more details. */ @SerializedName("cartes_bancaires") CartesBancaires cartesBancaires; @@ -154,22 +154,22 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and * receive money using their digital wallet. Check this page for more details. + * href="https://docs.stripe.com/payments/cash-app-pay">page for more details. */ @SerializedName("cashapp") Cashapp cashapp; /** - * Stablecoin payments enable + * Stablecoin payments enable * customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. */ @SerializedName("crypto") Crypto crypto; /** - * Uses a customer’s cash balance + * Uses a customer’s cash balance * for the payment. The cash balance can be funded via a bank transfer. Check this page for more details. + * href="https://docs.stripe.com/payments/bank-transfers">page for more details. */ @SerializedName("customer_balance") CustomerBalance customerBalance; @@ -178,7 +178,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * EPS is an Austria-based payment method that allows customers to complete transactions online * using their bank credentials. EPS is supported by all Austrian banks and is accepted by over * 80% of Austrian online retailers. Check this page for more details. + * href="https://docs.stripe.com/payments/eps">page for more details. */ @SerializedName("eps") Eps eps; @@ -202,7 +202,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members * of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment * methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this - * page for more details. + * page for more details. */ @SerializedName("fpx") Fpx fpx; @@ -210,7 +210,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered * by employers for their employees to purchase prepared food and beverages on working days. Check - * this page for more + * this page for more * details. */ @SerializedName("fr_meal_voucher_conecs") @@ -221,7 +221,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * customers to complete transactions online using their online banking environment, with funds * debited from their bank account. Depending on their bank, customers confirm payments on giropay * using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts - * in Germany. Check this page for more + * in Germany. Check this page for more * details. */ @SerializedName("giropay") @@ -231,14 +231,14 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Google Pay allows customers to make payments in your app or website using any credit or debit * card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an * Android device. Use the Google Pay API to request any credit or debit card stored in your - * customer's Google account. Check this page for + * customer's Google account. Check this page for * more details. */ @SerializedName("google_pay") GooglePay googlePay; /** - * GoPay is a single use + * GoPay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Gojek app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to @@ -251,7 +251,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - * customers maintain a balance in their wallets that they pay out with. Check this page for more details. + * href="https://docs.stripe.com/payments/grabpay">page for more details. */ @SerializedName("grabpay") Grabpay grabpay; @@ -268,7 +268,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * online using their bank credentials. All major Dutch banks are members of Currence, the scheme * that operates iDEAL, making it the most popular online payment method in the Netherlands with a * share of online transactions close to 55%. Check this page for more details. + * href="https://docs.stripe.com/payments/ideal">page for more details. */ @SerializedName("ideal") Ideal ideal; @@ -290,10 +290,10 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Klarna gives customers a range of payment options during + * href="https://docs.stripe.com/payments/klarna#payment-options">payment options during * checkout. Available payment options vary depending on the customer's billing address and the * transaction amount. These payment options make it convenient for customers to purchase items in - * all price ranges. Check this page for + * all price ranges. Check this page for * more details. */ @SerializedName("klarna") @@ -301,7 +301,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Konbini allows customers in Japan to pay for bills and online purchases at convenience stores - * with cash. Check this page for more + * with cash. Check this page for more * details. */ @SerializedName("konbini") @@ -312,7 +312,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { KrCard krCard; /** - * Link is a payment method network. With + * Link is a payment method network. With * Link, users save their payment details once, then reuse that information to pay with one click * for any business on the network. */ @@ -322,17 +322,17 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * MB WAY is the most popular wallet in Portugal. After entering their phone number in your * checkout, customers approve the payment directly in their MB WAY app. Check this page for more details. + * href="https://docs.stripe.com/payments/mb-way">page for more details. */ @SerializedName("mb_way") MbWay mbWay; /** - * MobilePay is a single-use + * MobilePay is a single-use * card wallet payment method used in Denmark and Finland. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the MobilePay app. Check this page for more details. + * href="https://docs.stripe.com/payments/mobilepay">page for more details. */ @SerializedName("mobilepay") Mobilepay mobilepay; @@ -356,7 +356,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with a New Zeland bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/nz-bank-account">page for more details. */ @SerializedName("nz_bank_account") NzBankAccount nzBankAccount; @@ -365,7 +365,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America * and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills * and online purchases in-store with cash. Check this page for more details. + * href="https://docs.stripe.com/payments/oxxo">page for more details. */ @SerializedName("oxxo") Oxxo oxxo; @@ -374,7 +374,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * Przelewy24 is a Poland-based payment method aggregator that allows customers to complete * transactions online using bank transfers and other methods. Bank transfers account for 30% of * online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 - * banks. Check this page for more details. + * banks. Check this page for more details. */ @SerializedName("p24") P24 p24; @@ -402,7 +402,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * PayNow is a Singapore-based payment method that allows customers to make a payment using their * preferred app from participating banks and participating non-bank financial institutions. Check - * this page for more details. + * this page for more details. */ @SerializedName("paynow") Paynow paynow; @@ -410,7 +410,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to * pay using their PayPal account. Check this page for more details. + * href="https://docs.stripe.com/payments/paypal">page for more details. */ @SerializedName("paypal") Paypal paypal; @@ -439,7 +439,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * PromptPay is a Thailand-based payment method that allows customers to make a payment using * their preferred app from participating banks. Check this page for more details. + * href="https://docs.stripe.com/payments/promptpay">page for more details. */ @SerializedName("promptpay") Promptpay promptpay; @@ -484,13 +484,13 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * (SEPA) is an initiative of the European Union to simplify payments within and across member * countries. SEPA established and enforced banking standards to allow for the direct debiting of * every EUR-denominated bank account within the SEPA region, check this page for more details. + * href="https://docs.stripe.com/payments/sepa-debit">page for more details. */ @SerializedName("sepa_debit") SepaDebit sepaDebit; /** - * ShopeePay is a single use + * ShopeePay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Shopee app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to @@ -504,17 +504,17 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * href="https://stripe.com/docs/payments/payment-intents">Payment Intents API—a single * integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details. + * href="https://docs.stripe.com/payments/sofort">page for more details. */ @SerializedName("sofort") Sofort sofort; /** - * Swish is a real-time payment method + * Swish is a real-time payment method * popular in Sweden. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the Swish mobile app and the Swedish BankID mobile app. Check this - * page for more details. + * page for more details. */ @SerializedName("swish") Swish swish; @@ -529,7 +529,7 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { /** * Stripe users in the United States can accept ACH direct debit payments from customers with a US * bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check - * this page for more details. + * this page for more details. */ @SerializedName("us_bank_account") UsBankAccount usBankAccount; @@ -539,14 +539,14 @@ public class PaymentMethodConfigurationCreateParams extends ApiRequestParams { * users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' * apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online * education, and food/nutrition. Check this page for more details. + * href="https://docs.stripe.com/payments/wechat-pay">page for more details. */ @SerializedName("wechat_pay") WechatPay wechatPay; /** * Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country + * href="https://docs.stripe.com/payments/zip">page for more details like country * availability. */ @SerializedName("zip") @@ -892,7 +892,7 @@ public PaymentMethodConfigurationCreateParams build() { /** * Canadian pre-authorized debit payments, check this page for more details like country + * href="https://docs.stripe.com/payments/acss-debit">page for more details like country * availability. */ public Builder setAcssDebit(PaymentMethodConfigurationCreateParams.AcssDebit acssDebit) { @@ -904,7 +904,7 @@ public Builder setAcssDebit(PaymentMethodConfigurationCreateParams.AcssDebit acs * Affirm gives your customers a way to split purchases * over a series of payments. Depending on the purchase, they can pay with four interest-free * payments (Split Pay) or pay over a longer term (Installments), which might include interest. - * Check this page for more details like + * Check this page for more details like * country availability. */ public Builder setAffirm(PaymentMethodConfigurationCreateParams.Affirm affirm) { @@ -914,7 +914,7 @@ public Builder setAffirm(PaymentMethodConfigurationCreateParams.Affirm affirm) { /** * Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like + * href="https://docs.stripe.com/payments/afterpay-clearpay">page for more details like * country availability. Afterpay is particularly popular among businesses selling fashion, * beauty, and sports products. */ @@ -929,7 +929,7 @@ public Builder setAfterpayClearpay( * Alipay users can pay on the web or on a mobile device using login credentials or their Alipay * app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the * customer's login credentials. Check this page for more details. + * href="https://docs.stripe.com/payments/alipay">page for more details. */ public Builder setAlipay(PaymentMethodConfigurationCreateParams.Alipay alipay) { this.alipay = alipay; @@ -959,7 +959,7 @@ public Builder setAmazonPay(PaymentMethodConfigurationCreateParams.AmazonPay ama * applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS * Sierra. There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions. Check - * this page for more details. + * this page for more details. */ public Builder setApplePay(PaymentMethodConfigurationCreateParams.ApplePay applePay) { this.applePay = applePay; @@ -979,7 +979,7 @@ public Builder setApplePayLater( /** * Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with an Australian bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/au-becs-debit">page for more details. */ public Builder setAuBecsDebit(PaymentMethodConfigurationCreateParams.AuBecsDebit auBecsDebit) { this.auBecsDebit = auBecsDebit; @@ -989,7 +989,7 @@ public Builder setAuBecsDebit(PaymentMethodConfigurationCreateParams.AuBecsDebit /** * Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank * account, check this page for more details. + * href="https://docs.stripe.com/payments/payment-methods/bacs-debit">page for more details. */ public Builder setBacsDebit(PaymentMethodConfigurationCreateParams.BacsDebit bacsDebit) { this.bacsDebit = bacsDebit; @@ -998,10 +998,10 @@ public Builder setBacsDebit(PaymentMethodConfigurationCreateParams.BacsDebit bac /** * Bancontact is the most popular online payment method in Belgium, with over 15 million cards - * in circulation. Customers use a + * in circulation. Customers use a * Bancontact card or mobile app linked to a Belgian bank account to make online payments that * are secure, guaranteed, and confirmed immediately. Check this page for more details. + * href="https://docs.stripe.com/payments/bancontact">page for more details. */ public Builder setBancontact(PaymentMethodConfigurationCreateParams.Bancontact bancontact) { this.bancontact = bancontact; @@ -1022,11 +1022,11 @@ public Builder setBillie(PaymentMethodConfigurationCreateParams.Billie billie) { } /** - * BLIK is a single use + * BLIK is a single use * payment method that requires customers to authenticate their payments. When customers want to * pay online using BLIK, they request a six-digit code from their banking application and enter * it into the payment collection form. Check this page for more details. + * href="https://docs.stripe.com/payments/blik">page for more details. */ public Builder setBlik(PaymentMethodConfigurationCreateParams.Blik blik) { this.blik = blik; @@ -1035,7 +1035,7 @@ public Builder setBlik(PaymentMethodConfigurationCreateParams.Blik blik) { /** * Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. - * Check this page for more details. + * Check this page for more details. */ public Builder setBoleto(PaymentMethodConfigurationCreateParams.Boleto boleto) { this.boleto = boleto; @@ -1055,7 +1055,7 @@ public Builder setCard(PaymentMethodConfigurationCreateParams.Card card) { * Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded * with either Visa or Mastercard, meaning you can process these cards over either Cartes * Bancaires or the Visa or Mastercard networks. Check this page for more details. + * href="https://docs.stripe.com/payments/cartes-bancaires">page for more details. */ public Builder setCartesBancaires( PaymentMethodConfigurationCreateParams.CartesBancaires cartesBancaires) { @@ -1066,7 +1066,7 @@ public Builder setCartesBancaires( /** * Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and * receive money using their digital wallet. Check this page for more details. + * href="https://docs.stripe.com/payments/cash-app-pay">page for more details. */ public Builder setCashapp(PaymentMethodConfigurationCreateParams.Cashapp cashapp) { this.cashapp = cashapp; @@ -1074,7 +1074,7 @@ public Builder setCashapp(PaymentMethodConfigurationCreateParams.Cashapp cashapp } /** - * Stablecoin payments enable + * Stablecoin payments enable * customers to pay in stablecoins like USDC from 100s of wallets including Phantom and * Metamask. */ @@ -1084,9 +1084,9 @@ public Builder setCrypto(PaymentMethodConfigurationCreateParams.Crypto crypto) { } /** - * Uses a customer’s cash + * Uses a customer’s cash * balance for the payment. The cash balance can be funded via a bank transfer. Check this - * page for more details. + * page for more details. */ public Builder setCustomerBalance( PaymentMethodConfigurationCreateParams.CustomerBalance customerBalance) { @@ -1098,7 +1098,7 @@ public Builder setCustomerBalance( * EPS is an Austria-based payment method that allows customers to complete transactions online * using their bank credentials. EPS is supported by all Austrian banks and is accepted by over * 80% of Austrian online retailers. Check this page for more details. + * href="https://docs.stripe.com/payments/eps">page for more details. */ public Builder setEps(PaymentMethodConfigurationCreateParams.Eps eps) { this.eps = eps; @@ -1163,7 +1163,7 @@ public Builder putAllExtraParam(Map map) { * Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members * of the PayNet Group, which owns and operates FPX. It is one of the most popular online * payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. - * Check this page for more details. + * Check this page for more details. */ public Builder setFpx(PaymentMethodConfigurationCreateParams.Fpx fpx) { this.fpx = fpx; @@ -1173,7 +1173,7 @@ public Builder setFpx(PaymentMethodConfigurationCreateParams.Fpx fpx) { /** * Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered * by employers for their employees to purchase prepared food and beverages on working days. - * Check this page for + * Check this page for * more details. */ public Builder setFrMealVoucherConecs( @@ -1187,7 +1187,7 @@ public Builder setFrMealVoucherConecs( * customers to complete transactions online using their online banking environment, with funds * debited from their bank account. Depending on their bank, customers confirm payments on * giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online - * checkouts in Germany. Check this page + * checkouts in Germany. Check this page * for more details. */ public Builder setGiropay(PaymentMethodConfigurationCreateParams.Giropay giropay) { @@ -1199,7 +1199,7 @@ public Builder setGiropay(PaymentMethodConfigurationCreateParams.Giropay giropay * Google Pay allows customers to make payments in your app or website using any credit or debit * card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an * Android device. Use the Google Pay API to request any credit or debit card stored in your - * customer's Google account. Check this page + * customer's Google account. Check this page * for more details. */ public Builder setGooglePay(PaymentMethodConfigurationCreateParams.GooglePay googlePay) { @@ -1208,7 +1208,7 @@ public Builder setGooglePay(PaymentMethodConfigurationCreateParams.GooglePay goo } /** - * GoPay is a single use + * GoPay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Gojek app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to @@ -1223,7 +1223,7 @@ public Builder setGopay(PaymentMethodConfigurationCreateParams.Gopay gopay) { * GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - * customers maintain a balance in their wallets that they pay out with. Check this page for more details. + * href="https://docs.stripe.com/payments/grabpay">page for more details. */ public Builder setGrabpay(PaymentMethodConfigurationCreateParams.Grabpay grabpay) { this.grabpay = grabpay; @@ -1245,7 +1245,7 @@ public Builder setIdBankTransfer( * online using their bank credentials. All major Dutch banks are members of Currence, the * scheme that operates iDEAL, making it the most popular online payment method in the * Netherlands with a share of online transactions close to 55%. Check this page for more details. + * href="https://docs.stripe.com/payments/ideal">page for more details. */ public Builder setIdeal(PaymentMethodConfigurationCreateParams.Ideal ideal) { this.ideal = ideal; @@ -1273,10 +1273,10 @@ public Builder setKakaoPay(PaymentMethodConfigurationCreateParams.KakaoPay kakao /** * Klarna gives customers a range of payment options during + * href="https://docs.stripe.com/payments/klarna#payment-options">payment options during * checkout. Available payment options vary depending on the customer's billing address and the * transaction amount. These payment options make it convenient for customers to purchase items - * in all price ranges. Check this page + * in all price ranges. Check this page * for more details. */ public Builder setKlarna(PaymentMethodConfigurationCreateParams.Klarna klarna) { @@ -1286,7 +1286,7 @@ public Builder setKlarna(PaymentMethodConfigurationCreateParams.Klarna klarna) { /** * Konbini allows customers in Japan to pay for bills and online purchases at convenience stores - * with cash. Check this page for more + * with cash. Check this page for more * details. */ public Builder setKonbini(PaymentMethodConfigurationCreateParams.Konbini konbini) { @@ -1301,7 +1301,7 @@ public Builder setKrCard(PaymentMethodConfigurationCreateParams.KrCard krCard) { } /** - * Link is a payment method network. With + * Link is a payment method network. With * Link, users save their payment details once, then reuse that information to pay with one * click for any business on the network. */ @@ -1313,7 +1313,7 @@ public Builder setLink(PaymentMethodConfigurationCreateParams.Link link) { /** * MB WAY is the most popular wallet in Portugal. After entering their phone number in your * checkout, customers approve the payment directly in their MB WAY app. Check this page for more details. + * href="https://docs.stripe.com/payments/mb-way">page for more details. */ public Builder setMbWay(PaymentMethodConfigurationCreateParams.MbWay mbWay) { this.mbWay = mbWay; @@ -1322,11 +1322,11 @@ public Builder setMbWay(PaymentMethodConfigurationCreateParams.MbWay mbWay) { /** * MobilePay is a single-use card wallet + * href="https://docs.stripe.com/payments/payment-methods#usage">single-use card wallet * payment method used in Denmark and Finland. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the MobilePay app. Check this page for more details. + * href="https://docs.stripe.com/payments/mobilepay">page for more details. */ public Builder setMobilepay(PaymentMethodConfigurationCreateParams.Mobilepay mobilepay) { this.mobilepay = mobilepay; @@ -1358,7 +1358,7 @@ public Builder setNaverPay(PaymentMethodConfigurationCreateParams.NaverPay naver /** * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with a New Zeland bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/nz-bank-account">page for more details. */ public Builder setNzBankAccount( PaymentMethodConfigurationCreateParams.NzBankAccount nzBankAccount) { @@ -1370,7 +1370,7 @@ public Builder setNzBankAccount( * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin * America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to * pay bills and online purchases in-store with cash. Check this page for more details. + * href="https://docs.stripe.com/payments/oxxo">page for more details. */ public Builder setOxxo(PaymentMethodConfigurationCreateParams.Oxxo oxxo) { this.oxxo = oxxo; @@ -1381,7 +1381,7 @@ public Builder setOxxo(PaymentMethodConfigurationCreateParams.Oxxo oxxo) { * Przelewy24 is a Poland-based payment method aggregator that allows customers to complete * transactions online using bank transfers and other methods. Bank transfers account for 30% of * online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 - * banks. Check this page for more details. + * banks. Check this page for more details. */ public Builder setP24(PaymentMethodConfigurationCreateParams.P24 p24) { this.p24 = p24; @@ -1417,7 +1417,7 @@ public Builder setPayco(PaymentMethodConfigurationCreateParams.Payco payco) { /** * PayNow is a Singapore-based payment method that allows customers to make a payment using * their preferred app from participating banks and participating non-bank financial - * institutions. Check this page for more + * institutions. Check this page for more * details. */ public Builder setPaynow(PaymentMethodConfigurationCreateParams.Paynow paynow) { @@ -1428,7 +1428,7 @@ public Builder setPaynow(PaymentMethodConfigurationCreateParams.Paynow paynow) { /** * PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to * pay using their PayPal account. Check this page for more details. + * href="https://docs.stripe.com/payments/paypal">page for more details. */ public Builder setPaypal(PaymentMethodConfigurationCreateParams.Paypal paypal) { this.paypal = paypal; @@ -1465,7 +1465,7 @@ public Builder setPix(PaymentMethodConfigurationCreateParams.Pix pix) { /** * PromptPay is a Thailand-based payment method that allows customers to make a payment using * their preferred app from participating banks. Check this page for more details. + * href="https://docs.stripe.com/payments/promptpay">page for more details. */ public Builder setPromptpay(PaymentMethodConfigurationCreateParams.Promptpay promptpay) { this.promptpay = promptpay; @@ -1520,7 +1520,7 @@ public Builder setSatispay(PaymentMethodConfigurationCreateParams.Satispay satis * Area (SEPA) is an initiative of the European Union to simplify payments within and across * member countries. SEPA established and enforced banking standards to allow for the direct * debiting of every EUR-denominated bank account within the SEPA region, check this page for more details. + * href="https://docs.stripe.com/payments/sepa-debit">page for more details. */ public Builder setSepaDebit(PaymentMethodConfigurationCreateParams.SepaDebit sepaDebit) { this.sepaDebit = sepaDebit; @@ -1528,7 +1528,7 @@ public Builder setSepaDebit(PaymentMethodConfigurationCreateParams.SepaDebit sep } /** - * ShopeePay is a single + * ShopeePay is a single * use digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Shopee app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app @@ -1544,7 +1544,7 @@ public Builder setShopeepay(PaymentMethodConfigurationCreateParams.Shopeepay sho * href="https://stripe.com/docs/payments/payment-intents">Payment Intents API—a single * integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details. + * href="https://docs.stripe.com/payments/sofort">page for more details. */ public Builder setSofort(PaymentMethodConfigurationCreateParams.Sofort sofort) { this.sofort = sofort; @@ -1552,11 +1552,11 @@ public Builder setSofort(PaymentMethodConfigurationCreateParams.Sofort sofort) { } /** - * Swish is a real-time payment method + * Swish is a real-time payment method * popular in Sweden. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the Swish mobile app and the Swedish BankID mobile app. Check this - * page for more details. + * page for more details. */ public Builder setSwish(PaymentMethodConfigurationCreateParams.Swish swish) { this.swish = swish; @@ -1576,7 +1576,7 @@ public Builder setTwint(PaymentMethodConfigurationCreateParams.Twint twint) { /** * Stripe users in the United States can accept ACH direct debit payments from customers with a * US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. - * Check this page for more + * Check this page for more * details. */ public Builder setUsBankAccount( @@ -1590,7 +1590,7 @@ public Builder setUsBankAccount( * users. Chinese consumers can use WeChat Pay to pay for goods and services inside of * businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, * travel, online education, and food/nutrition. Check this page for more details. + * href="https://docs.stripe.com/payments/wechat-pay">page for more details. */ public Builder setWechatPay(PaymentMethodConfigurationCreateParams.WechatPay wechatPay) { this.wechatPay = wechatPay; @@ -1599,7 +1599,7 @@ public Builder setWechatPay(PaymentMethodConfigurationCreateParams.WechatPay wec /** * Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country + * href="https://docs.stripe.com/payments/zip">page for more details like country * availability. */ public Builder setZip(PaymentMethodConfigurationCreateParams.Zip zip) { diff --git a/src/main/java/com/stripe/param/PaymentMethodConfigurationUpdateParams.java b/src/main/java/com/stripe/param/PaymentMethodConfigurationUpdateParams.java index 1b7324c79fc..8a1892d094e 100644 --- a/src/main/java/com/stripe/param/PaymentMethodConfigurationUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodConfigurationUpdateParams.java @@ -16,7 +16,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Canadian pre-authorized debit payments, check this page for more details like country + * href="https://docs.stripe.com/payments/acss-debit">page for more details like country * availability. */ @SerializedName("acss_debit") @@ -30,7 +30,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Affirm gives your customers a way to split purchases over * a series of payments. Depending on the purchase, they can pay with four interest-free payments * (Split Pay) or pay over a longer term (Installments), which might include interest. Check this - * page for more details like country + * page for more details like country * availability. */ @SerializedName("affirm") @@ -38,7 +38,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like + * href="https://docs.stripe.com/payments/afterpay-clearpay">page for more details like * country availability. Afterpay is particularly popular among businesses selling fashion, * beauty, and sports products. */ @@ -49,7 +49,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay * users can pay on the web or on a mobile device using login credentials or their Alipay app. * Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's - * login credentials. Check this page for + * login credentials. Check this page for * more details. */ @SerializedName("alipay") @@ -74,7 +74,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. * There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions. Check - * this page for more details. + * this page for more details. */ @SerializedName("apple_pay") ApplePay applePay; @@ -89,7 +89,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with an Australian bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/au-becs-debit">page for more details. */ @SerializedName("au_becs_debit") AuBecsDebit auBecsDebit; @@ -97,17 +97,17 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank * account, check this page for more details. + * href="https://docs.stripe.com/payments/payment-methods/bacs-debit">page for more details. */ @SerializedName("bacs_debit") BacsDebit bacsDebit; /** * Bancontact is the most popular online payment method in Belgium, with over 15 million cards in - * circulation. Customers use a Bancontact + * circulation. Customers use a Bancontact * card or mobile app linked to a Belgian bank account to make online payments that are secure, * guaranteed, and confirmed immediately. Check this page for more details. + * href="https://docs.stripe.com/payments/bancontact">page for more details. */ @SerializedName("bancontact") Bancontact bancontact; @@ -124,18 +124,18 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { Billie billie; /** - * BLIK is a single use + * BLIK is a single use * payment method that requires customers to authenticate their payments. When customers want to * pay online using BLIK, they request a six-digit code from their banking application and enter * it into the payment collection form. Check this page for more details. + * href="https://docs.stripe.com/payments/blik">page for more details. */ @SerializedName("blik") Blik blik; /** * Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check - * this page for more details. + * this page for more details. */ @SerializedName("boleto") Boleto boleto; @@ -151,7 +151,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded * with either Visa or Mastercard, meaning you can process these cards over either Cartes * Bancaires or the Visa or Mastercard networks. Check this page for more details. + * href="https://docs.stripe.com/payments/cartes-bancaires">page for more details. */ @SerializedName("cartes_bancaires") CartesBancaires cartesBancaires; @@ -159,22 +159,22 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and * receive money using their digital wallet. Check this page for more details. + * href="https://docs.stripe.com/payments/cash-app-pay">page for more details. */ @SerializedName("cashapp") Cashapp cashapp; /** - * Stablecoin payments enable + * Stablecoin payments enable * customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. */ @SerializedName("crypto") Crypto crypto; /** - * Uses a customer’s cash balance + * Uses a customer’s cash balance * for the payment. The cash balance can be funded via a bank transfer. Check this page for more details. + * href="https://docs.stripe.com/payments/bank-transfers">page for more details. */ @SerializedName("customer_balance") CustomerBalance customerBalance; @@ -183,7 +183,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * EPS is an Austria-based payment method that allows customers to complete transactions online * using their bank credentials. EPS is supported by all Austrian banks and is accepted by over * 80% of Austrian online retailers. Check this page for more details. + * href="https://docs.stripe.com/payments/eps">page for more details. */ @SerializedName("eps") Eps eps; @@ -207,7 +207,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members * of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment * methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this - * page for more details. + * page for more details. */ @SerializedName("fpx") Fpx fpx; @@ -215,7 +215,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered * by employers for their employees to purchase prepared food and beverages on working days. Check - * this page for more + * this page for more * details. */ @SerializedName("fr_meal_voucher_conecs") @@ -226,7 +226,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * customers to complete transactions online using their online banking environment, with funds * debited from their bank account. Depending on their bank, customers confirm payments on giropay * using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts - * in Germany. Check this page for more + * in Germany. Check this page for more * details. */ @SerializedName("giropay") @@ -236,14 +236,14 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Google Pay allows customers to make payments in your app or website using any credit or debit * card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an * Android device. Use the Google Pay API to request any credit or debit card stored in your - * customer's Google account. Check this page for + * customer's Google account. Check this page for * more details. */ @SerializedName("google_pay") GooglePay googlePay; /** - * GoPay is a single use + * GoPay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Gojek app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to @@ -256,7 +256,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - * customers maintain a balance in their wallets that they pay out with. Check this page for more details. + * href="https://docs.stripe.com/payments/grabpay">page for more details. */ @SerializedName("grabpay") Grabpay grabpay; @@ -273,7 +273,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * online using their bank credentials. All major Dutch banks are members of Currence, the scheme * that operates iDEAL, making it the most popular online payment method in the Netherlands with a * share of online transactions close to 55%. Check this page for more details. + * href="https://docs.stripe.com/payments/ideal">page for more details. */ @SerializedName("ideal") Ideal ideal; @@ -295,10 +295,10 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Klarna gives customers a range of payment options during + * href="https://docs.stripe.com/payments/klarna#payment-options">payment options during * checkout. Available payment options vary depending on the customer's billing address and the * transaction amount. These payment options make it convenient for customers to purchase items in - * all price ranges. Check this page for + * all price ranges. Check this page for * more details. */ @SerializedName("klarna") @@ -306,7 +306,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Konbini allows customers in Japan to pay for bills and online purchases at convenience stores - * with cash. Check this page for more + * with cash. Check this page for more * details. */ @SerializedName("konbini") @@ -317,7 +317,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { KrCard krCard; /** - * Link is a payment method network. With + * Link is a payment method network. With * Link, users save their payment details once, then reuse that information to pay with one click * for any business on the network. */ @@ -327,17 +327,17 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * MB WAY is the most popular wallet in Portugal. After entering their phone number in your * checkout, customers approve the payment directly in their MB WAY app. Check this page for more details. + * href="https://docs.stripe.com/payments/mb-way">page for more details. */ @SerializedName("mb_way") MbWay mbWay; /** - * MobilePay is a single-use + * MobilePay is a single-use * card wallet payment method used in Denmark and Finland. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the MobilePay app. Check this page for more details. + * href="https://docs.stripe.com/payments/mobilepay">page for more details. */ @SerializedName("mobilepay") Mobilepay mobilepay; @@ -361,7 +361,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with a New Zeland bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/nz-bank-account">page for more details. */ @SerializedName("nz_bank_account") NzBankAccount nzBankAccount; @@ -370,7 +370,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America * and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills * and online purchases in-store with cash. Check this page for more details. + * href="https://docs.stripe.com/payments/oxxo">page for more details. */ @SerializedName("oxxo") Oxxo oxxo; @@ -379,7 +379,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * Przelewy24 is a Poland-based payment method aggregator that allows customers to complete * transactions online using bank transfers and other methods. Bank transfers account for 30% of * online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 - * banks. Check this page for more details. + * banks. Check this page for more details. */ @SerializedName("p24") P24 p24; @@ -403,7 +403,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * PayNow is a Singapore-based payment method that allows customers to make a payment using their * preferred app from participating banks and participating non-bank financial institutions. Check - * this page for more details. + * this page for more details. */ @SerializedName("paynow") Paynow paynow; @@ -411,7 +411,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to * pay using their PayPal account. Check this page for more details. + * href="https://docs.stripe.com/payments/paypal">page for more details. */ @SerializedName("paypal") Paypal paypal; @@ -440,7 +440,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * PromptPay is a Thailand-based payment method that allows customers to make a payment using * their preferred app from participating banks. Check this page for more details. + * href="https://docs.stripe.com/payments/promptpay">page for more details. */ @SerializedName("promptpay") Promptpay promptpay; @@ -485,13 +485,13 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * (SEPA) is an initiative of the European Union to simplify payments within and across member * countries. SEPA established and enforced banking standards to allow for the direct debiting of * every EUR-denominated bank account within the SEPA region, check this page for more details. + * href="https://docs.stripe.com/payments/sepa-debit">page for more details. */ @SerializedName("sepa_debit") SepaDebit sepaDebit; /** - * ShopeePay is a single use + * ShopeePay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Shopee app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to @@ -505,17 +505,17 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * href="https://stripe.com/docs/payments/payment-intents">Payment Intents API—a single * integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details. + * href="https://docs.stripe.com/payments/sofort">page for more details. */ @SerializedName("sofort") Sofort sofort; /** - * Swish is a real-time payment method + * Swish is a real-time payment method * popular in Sweden. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the Swish mobile app and the Swedish BankID mobile app. Check this - * page for more details. + * page for more details. */ @SerializedName("swish") Swish swish; @@ -530,7 +530,7 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { /** * Stripe users in the United States can accept ACH direct debit payments from customers with a US * bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check - * this page for more details. + * this page for more details. */ @SerializedName("us_bank_account") UsBankAccount usBankAccount; @@ -540,14 +540,14 @@ public class PaymentMethodConfigurationUpdateParams extends ApiRequestParams { * users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' * apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online * education, and food/nutrition. Check this page for more details. + * href="https://docs.stripe.com/payments/wechat-pay">page for more details. */ @SerializedName("wechat_pay") WechatPay wechatPay; /** * Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country + * href="https://docs.stripe.com/payments/zip">page for more details like country * availability. */ @SerializedName("zip") @@ -893,7 +893,7 @@ public PaymentMethodConfigurationUpdateParams build() { /** * Canadian pre-authorized debit payments, check this page for more details like country + * href="https://docs.stripe.com/payments/acss-debit">page for more details like country * availability. */ public Builder setAcssDebit(PaymentMethodConfigurationUpdateParams.AcssDebit acssDebit) { @@ -911,7 +911,7 @@ public Builder setActive(Boolean active) { * Affirm gives your customers a way to split purchases * over a series of payments. Depending on the purchase, they can pay with four interest-free * payments (Split Pay) or pay over a longer term (Installments), which might include interest. - * Check this page for more details like + * Check this page for more details like * country availability. */ public Builder setAffirm(PaymentMethodConfigurationUpdateParams.Affirm affirm) { @@ -921,7 +921,7 @@ public Builder setAffirm(PaymentMethodConfigurationUpdateParams.Affirm affirm) { /** * Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like + * href="https://docs.stripe.com/payments/afterpay-clearpay">page for more details like * country availability. Afterpay is particularly popular among businesses selling fashion, * beauty, and sports products. */ @@ -936,7 +936,7 @@ public Builder setAfterpayClearpay( * Alipay users can pay on the web or on a mobile device using login credentials or their Alipay * app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the * customer's login credentials. Check this page for more details. + * href="https://docs.stripe.com/payments/alipay">page for more details. */ public Builder setAlipay(PaymentMethodConfigurationUpdateParams.Alipay alipay) { this.alipay = alipay; @@ -966,7 +966,7 @@ public Builder setAmazonPay(PaymentMethodConfigurationUpdateParams.AmazonPay ama * applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS * Sierra. There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions. Check - * this page for more details. + * this page for more details. */ public Builder setApplePay(PaymentMethodConfigurationUpdateParams.ApplePay applePay) { this.applePay = applePay; @@ -986,7 +986,7 @@ public Builder setApplePayLater( /** * Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with an Australian bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/au-becs-debit">page for more details. */ public Builder setAuBecsDebit(PaymentMethodConfigurationUpdateParams.AuBecsDebit auBecsDebit) { this.auBecsDebit = auBecsDebit; @@ -996,7 +996,7 @@ public Builder setAuBecsDebit(PaymentMethodConfigurationUpdateParams.AuBecsDebit /** * Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank * account, check this page for more details. + * href="https://docs.stripe.com/payments/payment-methods/bacs-debit">page for more details. */ public Builder setBacsDebit(PaymentMethodConfigurationUpdateParams.BacsDebit bacsDebit) { this.bacsDebit = bacsDebit; @@ -1005,10 +1005,10 @@ public Builder setBacsDebit(PaymentMethodConfigurationUpdateParams.BacsDebit bac /** * Bancontact is the most popular online payment method in Belgium, with over 15 million cards - * in circulation. Customers use a + * in circulation. Customers use a * Bancontact card or mobile app linked to a Belgian bank account to make online payments that * are secure, guaranteed, and confirmed immediately. Check this page for more details. + * href="https://docs.stripe.com/payments/bancontact">page for more details. */ public Builder setBancontact(PaymentMethodConfigurationUpdateParams.Bancontact bancontact) { this.bancontact = bancontact; @@ -1029,11 +1029,11 @@ public Builder setBillie(PaymentMethodConfigurationUpdateParams.Billie billie) { } /** - * BLIK is a single use + * BLIK is a single use * payment method that requires customers to authenticate their payments. When customers want to * pay online using BLIK, they request a six-digit code from their banking application and enter * it into the payment collection form. Check this page for more details. + * href="https://docs.stripe.com/payments/blik">page for more details. */ public Builder setBlik(PaymentMethodConfigurationUpdateParams.Blik blik) { this.blik = blik; @@ -1042,7 +1042,7 @@ public Builder setBlik(PaymentMethodConfigurationUpdateParams.Blik blik) { /** * Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. - * Check this page for more details. + * Check this page for more details. */ public Builder setBoleto(PaymentMethodConfigurationUpdateParams.Boleto boleto) { this.boleto = boleto; @@ -1062,7 +1062,7 @@ public Builder setCard(PaymentMethodConfigurationUpdateParams.Card card) { * Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded * with either Visa or Mastercard, meaning you can process these cards over either Cartes * Bancaires or the Visa or Mastercard networks. Check this page for more details. + * href="https://docs.stripe.com/payments/cartes-bancaires">page for more details. */ public Builder setCartesBancaires( PaymentMethodConfigurationUpdateParams.CartesBancaires cartesBancaires) { @@ -1073,7 +1073,7 @@ public Builder setCartesBancaires( /** * Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and * receive money using their digital wallet. Check this page for more details. + * href="https://docs.stripe.com/payments/cash-app-pay">page for more details. */ public Builder setCashapp(PaymentMethodConfigurationUpdateParams.Cashapp cashapp) { this.cashapp = cashapp; @@ -1081,7 +1081,7 @@ public Builder setCashapp(PaymentMethodConfigurationUpdateParams.Cashapp cashapp } /** - * Stablecoin payments enable + * Stablecoin payments enable * customers to pay in stablecoins like USDC from 100s of wallets including Phantom and * Metamask. */ @@ -1091,9 +1091,9 @@ public Builder setCrypto(PaymentMethodConfigurationUpdateParams.Crypto crypto) { } /** - * Uses a customer’s cash + * Uses a customer’s cash * balance for the payment. The cash balance can be funded via a bank transfer. Check this - * page for more details. + * page for more details. */ public Builder setCustomerBalance( PaymentMethodConfigurationUpdateParams.CustomerBalance customerBalance) { @@ -1105,7 +1105,7 @@ public Builder setCustomerBalance( * EPS is an Austria-based payment method that allows customers to complete transactions online * using their bank credentials. EPS is supported by all Austrian banks and is accepted by over * 80% of Austrian online retailers. Check this page for more details. + * href="https://docs.stripe.com/payments/eps">page for more details. */ public Builder setEps(PaymentMethodConfigurationUpdateParams.Eps eps) { this.eps = eps; @@ -1170,7 +1170,7 @@ public Builder putAllExtraParam(Map map) { * Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members * of the PayNet Group, which owns and operates FPX. It is one of the most popular online * payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. - * Check this page for more details. + * Check this page for more details. */ public Builder setFpx(PaymentMethodConfigurationUpdateParams.Fpx fpx) { this.fpx = fpx; @@ -1180,7 +1180,7 @@ public Builder setFpx(PaymentMethodConfigurationUpdateParams.Fpx fpx) { /** * Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered * by employers for their employees to purchase prepared food and beverages on working days. - * Check this page for + * Check this page for * more details. */ public Builder setFrMealVoucherConecs( @@ -1194,7 +1194,7 @@ public Builder setFrMealVoucherConecs( * customers to complete transactions online using their online banking environment, with funds * debited from their bank account. Depending on their bank, customers confirm payments on * giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online - * checkouts in Germany. Check this page + * checkouts in Germany. Check this page * for more details. */ public Builder setGiropay(PaymentMethodConfigurationUpdateParams.Giropay giropay) { @@ -1206,7 +1206,7 @@ public Builder setGiropay(PaymentMethodConfigurationUpdateParams.Giropay giropay * Google Pay allows customers to make payments in your app or website using any credit or debit * card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an * Android device. Use the Google Pay API to request any credit or debit card stored in your - * customer's Google account. Check this page + * customer's Google account. Check this page * for more details. */ public Builder setGooglePay(PaymentMethodConfigurationUpdateParams.GooglePay googlePay) { @@ -1215,7 +1215,7 @@ public Builder setGooglePay(PaymentMethodConfigurationUpdateParams.GooglePay goo } /** - * GoPay is a single use + * GoPay is a single use * digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Gojek app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to @@ -1230,7 +1230,7 @@ public Builder setGopay(PaymentMethodConfigurationUpdateParams.Gopay gopay) { * GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - * customers maintain a balance in their wallets that they pay out with. Check this page for more details. + * href="https://docs.stripe.com/payments/grabpay">page for more details. */ public Builder setGrabpay(PaymentMethodConfigurationUpdateParams.Grabpay grabpay) { this.grabpay = grabpay; @@ -1252,7 +1252,7 @@ public Builder setIdBankTransfer( * online using their bank credentials. All major Dutch banks are members of Currence, the * scheme that operates iDEAL, making it the most popular online payment method in the * Netherlands with a share of online transactions close to 55%. Check this page for more details. + * href="https://docs.stripe.com/payments/ideal">page for more details. */ public Builder setIdeal(PaymentMethodConfigurationUpdateParams.Ideal ideal) { this.ideal = ideal; @@ -1280,10 +1280,10 @@ public Builder setKakaoPay(PaymentMethodConfigurationUpdateParams.KakaoPay kakao /** * Klarna gives customers a range of payment options during + * href="https://docs.stripe.com/payments/klarna#payment-options">payment options during * checkout. Available payment options vary depending on the customer's billing address and the * transaction amount. These payment options make it convenient for customers to purchase items - * in all price ranges. Check this page + * in all price ranges. Check this page * for more details. */ public Builder setKlarna(PaymentMethodConfigurationUpdateParams.Klarna klarna) { @@ -1293,7 +1293,7 @@ public Builder setKlarna(PaymentMethodConfigurationUpdateParams.Klarna klarna) { /** * Konbini allows customers in Japan to pay for bills and online purchases at convenience stores - * with cash. Check this page for more + * with cash. Check this page for more * details. */ public Builder setKonbini(PaymentMethodConfigurationUpdateParams.Konbini konbini) { @@ -1308,7 +1308,7 @@ public Builder setKrCard(PaymentMethodConfigurationUpdateParams.KrCard krCard) { } /** - * Link is a payment method network. With + * Link is a payment method network. With * Link, users save their payment details once, then reuse that information to pay with one * click for any business on the network. */ @@ -1320,7 +1320,7 @@ public Builder setLink(PaymentMethodConfigurationUpdateParams.Link link) { /** * MB WAY is the most popular wallet in Portugal. After entering their phone number in your * checkout, customers approve the payment directly in their MB WAY app. Check this page for more details. + * href="https://docs.stripe.com/payments/mb-way">page for more details. */ public Builder setMbWay(PaymentMethodConfigurationUpdateParams.MbWay mbWay) { this.mbWay = mbWay; @@ -1329,11 +1329,11 @@ public Builder setMbWay(PaymentMethodConfigurationUpdateParams.MbWay mbWay) { /** * MobilePay is a single-use card wallet + * href="https://docs.stripe.com/payments/payment-methods#usage">single-use card wallet * payment method used in Denmark and Finland. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the MobilePay app. Check this page for more details. + * href="https://docs.stripe.com/payments/mobilepay">page for more details. */ public Builder setMobilepay(PaymentMethodConfigurationUpdateParams.Mobilepay mobilepay) { this.mobilepay = mobilepay; @@ -1371,7 +1371,7 @@ public Builder setNaverPay(PaymentMethodConfigurationUpdateParams.NaverPay naver /** * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit * payments from customers with a New Zeland bank account. Check this page for more details. + * href="https://docs.stripe.com/payments/nz-bank-account">page for more details. */ public Builder setNzBankAccount( PaymentMethodConfigurationUpdateParams.NzBankAccount nzBankAccount) { @@ -1383,7 +1383,7 @@ public Builder setNzBankAccount( * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin * America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to * pay bills and online purchases in-store with cash. Check this page for more details. + * href="https://docs.stripe.com/payments/oxxo">page for more details. */ public Builder setOxxo(PaymentMethodConfigurationUpdateParams.Oxxo oxxo) { this.oxxo = oxxo; @@ -1394,7 +1394,7 @@ public Builder setOxxo(PaymentMethodConfigurationUpdateParams.Oxxo oxxo) { * Przelewy24 is a Poland-based payment method aggregator that allows customers to complete * transactions online using bank transfers and other methods. Bank transfers account for 30% of * online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 - * banks. Check this page for more details. + * banks. Check this page for more details. */ public Builder setP24(PaymentMethodConfigurationUpdateParams.P24 p24) { this.p24 = p24; @@ -1424,7 +1424,7 @@ public Builder setPayco(PaymentMethodConfigurationUpdateParams.Payco payco) { /** * PayNow is a Singapore-based payment method that allows customers to make a payment using * their preferred app from participating banks and participating non-bank financial - * institutions. Check this page for more + * institutions. Check this page for more * details. */ public Builder setPaynow(PaymentMethodConfigurationUpdateParams.Paynow paynow) { @@ -1435,7 +1435,7 @@ public Builder setPaynow(PaymentMethodConfigurationUpdateParams.Paynow paynow) { /** * PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to * pay using their PayPal account. Check this page for more details. + * href="https://docs.stripe.com/payments/paypal">page for more details. */ public Builder setPaypal(PaymentMethodConfigurationUpdateParams.Paypal paypal) { this.paypal = paypal; @@ -1472,7 +1472,7 @@ public Builder setPix(PaymentMethodConfigurationUpdateParams.Pix pix) { /** * PromptPay is a Thailand-based payment method that allows customers to make a payment using * their preferred app from participating banks. Check this page for more details. + * href="https://docs.stripe.com/payments/promptpay">page for more details. */ public Builder setPromptpay(PaymentMethodConfigurationUpdateParams.Promptpay promptpay) { this.promptpay = promptpay; @@ -1527,7 +1527,7 @@ public Builder setSatispay(PaymentMethodConfigurationUpdateParams.Satispay satis * Area (SEPA) is an initiative of the European Union to simplify payments within and across * member countries. SEPA established and enforced banking standards to allow for the direct * debiting of every EUR-denominated bank account within the SEPA region, check this page for more details. + * href="https://docs.stripe.com/payments/sepa-debit">page for more details. */ public Builder setSepaDebit(PaymentMethodConfigurationUpdateParams.SepaDebit sepaDebit) { this.sepaDebit = sepaDebit; @@ -1535,7 +1535,7 @@ public Builder setSepaDebit(PaymentMethodConfigurationUpdateParams.SepaDebit sep } /** - * ShopeePay is a single + * ShopeePay is a single * use digital wallet payment method popular in Indonesia. When paying with GoPay, customers * authenticate and approve payments using the Shopee app. Desktop checkout is performed by * scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app @@ -1551,7 +1551,7 @@ public Builder setShopeepay(PaymentMethodConfigurationUpdateParams.Shopeepay sho * href="https://stripe.com/docs/payments/payment-intents">Payment Intents API—a single * integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details. + * href="https://docs.stripe.com/payments/sofort">page for more details. */ public Builder setSofort(PaymentMethodConfigurationUpdateParams.Sofort sofort) { this.sofort = sofort; @@ -1559,11 +1559,11 @@ public Builder setSofort(PaymentMethodConfigurationUpdateParams.Sofort sofort) { } /** - * Swish is a real-time payment method + * Swish is a real-time payment method * popular in Sweden. It allows customers to authenticate and + * href="https://docs.stripe.com/payments/payment-methods#customer-actions">authenticate and * approve payments using the Swish mobile app and the Swedish BankID mobile app. Check this - * page for more details. + * page for more details. */ public Builder setSwish(PaymentMethodConfigurationUpdateParams.Swish swish) { this.swish = swish; @@ -1583,7 +1583,7 @@ public Builder setTwint(PaymentMethodConfigurationUpdateParams.Twint twint) { /** * Stripe users in the United States can accept ACH direct debit payments from customers with a * US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. - * Check this page for more + * Check this page for more * details. */ public Builder setUsBankAccount( @@ -1597,7 +1597,7 @@ public Builder setUsBankAccount( * users. Chinese consumers can use WeChat Pay to pay for goods and services inside of * businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, * travel, online education, and food/nutrition. Check this page for more details. + * href="https://docs.stripe.com/payments/wechat-pay">page for more details. */ public Builder setWechatPay(PaymentMethodConfigurationUpdateParams.WechatPay wechatPay) { this.wechatPay = wechatPay; @@ -1606,7 +1606,7 @@ public Builder setWechatPay(PaymentMethodConfigurationUpdateParams.WechatPay wec /** * Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country + * href="https://docs.stripe.com/payments/zip">page for more details like country * availability. */ public Builder setZip(PaymentMethodConfigurationUpdateParams.Zip zip) { diff --git a/src/main/java/com/stripe/param/PaymentMethodCreateParams.java b/src/main/java/com/stripe/param/PaymentMethodCreateParams.java index b0d66c5cb36..cc4b58519ee 100644 --- a/src/main/java/com/stripe/param/PaymentMethodCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodCreateParams.java @@ -263,7 +263,7 @@ public class PaymentMethodCreateParams extends ApiRequestParams { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -381,7 +381,7 @@ public class PaymentMethodCreateParams extends ApiRequestParams { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -1375,7 +1375,7 @@ public Builder setQris(PaymentMethodCreateParams.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions(PaymentMethodCreateParams.RadarOptions radarOptions) { @@ -2359,7 +2359,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -2472,7 +2475,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3780,6 +3786,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -5448,7 +5457,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -5501,7 +5510,7 @@ public Builder putAllExtraParam(Map map) { } /** - * 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/param/PaymentMethodUpdateParams.java b/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java index 4c887f09849..4c5f7005907 100644 --- a/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java +++ b/src/main/java/com/stripe/param/PaymentMethodUpdateParams.java @@ -48,7 +48,7 @@ public class PaymentMethodUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -230,7 +230,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -241,7 +241,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -472,7 +472,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -618,13 +621,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptInformationalParams.java b/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptInformationalParams.java index 1aaf61e2087..d2c0cd4377a 100644 --- a/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptInformationalParams.java +++ b/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptInformationalParams.java @@ -36,7 +36,7 @@ public class PaymentRecordReportPaymentAttemptInformationalParams extends ApiReq Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -194,7 +194,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -205,7 +205,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -477,7 +477,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -593,7 +596,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptParams.java b/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptParams.java index aedcfec9878..8d960fabddc 100644 --- a/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptParams.java +++ b/src/main/java/com/stripe/param/PaymentRecordReportPaymentAttemptParams.java @@ -47,7 +47,7 @@ public class PaymentRecordReportPaymentAttemptParams extends ApiRequestParams { Long initiatedAt; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -238,7 +238,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -249,7 +249,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -716,7 +716,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -833,7 +836,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1080,7 +1086,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1195,7 +1204,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentRecordReportPaymentParams.java b/src/main/java/com/stripe/param/PaymentRecordReportPaymentParams.java index 9ec23aaca3d..2194f0f91db 100644 --- a/src/main/java/com/stripe/param/PaymentRecordReportPaymentParams.java +++ b/src/main/java/com/stripe/param/PaymentRecordReportPaymentParams.java @@ -59,7 +59,7 @@ public class PaymentRecordReportPaymentParams extends ApiRequestParams { Long initiatedAt; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -295,7 +295,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -306,7 +306,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -366,7 +366,7 @@ public static class AmountRequested { /** * Required. 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") @@ -434,7 +434,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. 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. */ public Builder setValue(Long value) { @@ -986,7 +986,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -1102,7 +1105,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1527,7 +1533,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1640,7 +1649,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/PaymentRecordReportRefundParams.java b/src/main/java/com/stripe/param/PaymentRecordReportRefundParams.java index 992e5c875ce..3d4f5354b69 100644 --- a/src/main/java/com/stripe/param/PaymentRecordReportRefundParams.java +++ b/src/main/java/com/stripe/param/PaymentRecordReportRefundParams.java @@ -15,7 +15,7 @@ @EqualsAndHashCode(callSuper = false) public class PaymentRecordReportRefundParams extends ApiRequestParams { /** - * A positive integer in the smallest + * A positive integer in the smallest * currency unit representing how much of this payment to refund. Can refund only up to the * remaining, unrefunded amount of the payment. */ @@ -40,7 +40,7 @@ public class PaymentRecordReportRefundParams extends ApiRequestParams { Long initiatedAt; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -114,7 +114,7 @@ public PaymentRecordReportRefundParams build() { } /** - * A positive integer in the smallest + * A positive integer in the smallest * currency unit representing how much of this payment to refund. Can refund only up to the * remaining, unrefunded amount of the payment. */ @@ -210,7 +210,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -221,7 +221,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -273,7 +273,7 @@ public static class Amount { /** * Required. 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") @@ -340,7 +340,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. 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. */ public Builder setValue(Long value) { diff --git a/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java b/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java index abaa14739d8..4d1b2d79eae 100644 --- a/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/PaymentSourceCollectionCreateParams.java @@ -27,7 +27,7 @@ public class PaymentSourceCollectionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -37,7 +37,7 @@ public class PaymentSourceCollectionCreateParams extends ApiRequestParams { /** * Required. Please refer to full documentation instead. + * href="https://api.stripe.com">documentation instead. */ @SerializedName("source") String source; @@ -159,7 +159,7 @@ public Builder putAllMetadata(Map map) { /** * Required. Please refer to full documentation instead. + * href="https://api.stripe.com">documentation instead. */ public Builder setSource(String source) { this.source = source; diff --git a/src/main/java/com/stripe/param/PayoutCreateParams.java b/src/main/java/com/stripe/param/PayoutCreateParams.java index 9502c4927ee..9b3edaca1b0 100644 --- a/src/main/java/com/stripe/param/PayoutCreateParams.java +++ b/src/main/java/com/stripe/param/PayoutCreateParams.java @@ -50,7 +50,7 @@ public class PayoutCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/PayoutReverseParams.java b/src/main/java/com/stripe/param/PayoutReverseParams.java index e0d629c37b5..3a6c1e78143 100644 --- a/src/main/java/com/stripe/param/PayoutReverseParams.java +++ b/src/main/java/com/stripe/param/PayoutReverseParams.java @@ -27,7 +27,7 @@ public class PayoutReverseParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/PayoutUpdateParams.java b/src/main/java/com/stripe/param/PayoutUpdateParams.java index 9dea9a44472..50cf36f89d4 100644 --- a/src/main/java/com/stripe/param/PayoutUpdateParams.java +++ b/src/main/java/com/stripe/param/PayoutUpdateParams.java @@ -28,7 +28,7 @@ public class PayoutUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/PersonCollectionCreateParams.java b/src/main/java/com/stripe/param/PersonCollectionCreateParams.java index cd64656d514..ef6db2b6f34 100644 --- a/src/main/java/com/stripe/param/PersonCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/PersonCollectionCreateParams.java @@ -117,7 +117,7 @@ public class PersonCollectionCreateParams extends ApiRequestParams { String maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -599,7 +599,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -610,7 +610,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -931,7 +931,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1042,7 +1045,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1611,9 +1617,8 @@ public static class CompanyAuthorization { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1709,9 +1714,8 @@ public static class Passport { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1804,9 +1808,8 @@ public static class Visa { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1922,7 +1925,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -2034,7 +2040,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -2981,7 +2990,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -2999,7 +3008,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3031,7 +3040,7 @@ public PersonCollectionCreateParams.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3070,7 +3079,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3086,7 +3095,7 @@ public Builder setFront(String front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3104,7 +3113,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3136,7 +3145,7 @@ public PersonCollectionCreateParams.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3175,7 +3184,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. diff --git a/src/main/java/com/stripe/param/PersonUpdateParams.java b/src/main/java/com/stripe/param/PersonUpdateParams.java index 3dbca0535c8..52bf3b27a29 100644 --- a/src/main/java/com/stripe/param/PersonUpdateParams.java +++ b/src/main/java/com/stripe/param/PersonUpdateParams.java @@ -117,7 +117,7 @@ public class PersonUpdateParams extends ApiRequestParams { Object maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -679,7 +679,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -690,7 +690,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1039,7 +1039,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -1183,13 +1186,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -1845,9 +1854,8 @@ public static class CompanyAuthorization { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -1941,9 +1949,8 @@ public static class Passport { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -2036,9 +2043,8 @@ public static class Visa { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} value - * of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -2154,7 +2160,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -2298,13 +2307,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -3287,7 +3302,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3305,7 +3320,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3337,7 +3352,7 @@ public PersonUpdateParams.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3348,7 +3363,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3387,7 +3402,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3398,7 +3413,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3414,7 +3429,7 @@ public Builder setFront(EmptyParam front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3432,7 +3447,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3464,7 +3479,7 @@ public PersonUpdateParams.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3475,7 +3490,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3514,7 +3529,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -3525,7 +3540,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. diff --git a/src/main/java/com/stripe/param/PlanCreateParams.java b/src/main/java/com/stripe/param/PlanCreateParams.java index 81c26dd8bb0..874c7c03d7b 100644 --- a/src/main/java/com/stripe/param/PlanCreateParams.java +++ b/src/main/java/com/stripe/param/PlanCreateParams.java @@ -89,7 +89,7 @@ public class PlanCreateParams extends ApiRequestParams { Long intervalCount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -132,7 +132,7 @@ public class PlanCreateParams extends ApiRequestParams { /** * Default number of trial days when subscribing a customer to this plan using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ @SerializedName("trial_period_days") @@ -412,7 +412,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -423,7 +423,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -502,7 +502,7 @@ public Builder setTransformUsage(PlanCreateParams.TransformUsage transformUsage) /** * Default number of trial days when subscribing a customer to this plan using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { @@ -546,7 +546,7 @@ public static class Product { 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -570,7 +570,7 @@ public static class Product { @SerializedName("statement_descriptor") String statementDescriptor; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; @@ -721,7 +721,7 @@ public Builder setStatementDescriptor(String statementDescriptor) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; diff --git a/src/main/java/com/stripe/param/PlanUpdateParams.java b/src/main/java/com/stripe/param/PlanUpdateParams.java index 6f12398ff53..d047c8663fc 100644 --- a/src/main/java/com/stripe/param/PlanUpdateParams.java +++ b/src/main/java/com/stripe/param/PlanUpdateParams.java @@ -32,7 +32,7 @@ public class PlanUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -53,7 +53,7 @@ public class PlanUpdateParams extends ApiRequestParams { /** * Default number of trial days when subscribing a customer to this plan using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ @SerializedName("trial_period_days") @@ -194,7 +194,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -205,7 +205,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -247,7 +247,7 @@ public Builder setProduct(EmptyParam product) { /** * Default number of trial days when subscribing a customer to this plan using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { diff --git a/src/main/java/com/stripe/param/PriceCreateParams.java b/src/main/java/com/stripe/param/PriceCreateParams.java index e677afe0b47..3748c9890a8 100644 --- a/src/main/java/com/stripe/param/PriceCreateParams.java +++ b/src/main/java/com/stripe/param/PriceCreateParams.java @@ -73,7 +73,7 @@ public class PriceCreateParams extends ApiRequestParams { String lookupKey; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -102,7 +102,7 @@ public class PriceCreateParams extends ApiRequestParams { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -449,7 +449,7 @@ public Builder setRecurring(PriceCreateParams.Recurring recurring) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -556,7 +556,7 @@ public static class CurrencyOption { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -668,7 +668,7 @@ public Builder putAllExtraParam(Map map) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1204,7 +1204,7 @@ public static class ProductData { 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1228,7 +1228,7 @@ public static class ProductData { @SerializedName("statement_descriptor") String statementDescriptor; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; @@ -1379,7 +1379,7 @@ public Builder setStatementDescriptor(String statementDescriptor) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; @@ -1429,7 +1429,7 @@ public static class Recurring { /** * Default number of trial days when subscribing a customer to this price using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ @SerializedName("trial_period_days") @@ -1540,7 +1540,7 @@ public Builder setMeter(String meter) { /** * Default number of trial days when subscribing a customer to this price using {@code + * href="https://docs.stripe.com/api#create_subscription-trial_from_plan">{@code * trial_from_plan=true}. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { diff --git a/src/main/java/com/stripe/param/PriceSearchParams.java b/src/main/java/com/stripe/param/PriceSearchParams.java index e7819665d1b..86e1cfffdda 100644 --- a/src/main/java/com/stripe/param/PriceSearchParams.java +++ b/src/main/java/com/stripe/param/PriceSearchParams.java @@ -43,8 +43,8 @@ public class PriceSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query fields + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query fields * for prices. */ @SerializedName("query") @@ -153,8 +153,8 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for prices. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/PriceUpdateParams.java b/src/main/java/com/stripe/param/PriceUpdateParams.java index 1c80e0949ad..81a991ef6f3 100644 --- a/src/main/java/com/stripe/param/PriceUpdateParams.java +++ b/src/main/java/com/stripe/param/PriceUpdateParams.java @@ -48,7 +48,7 @@ public class PriceUpdateParams extends ApiRequestParams { Object lookupKey; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -68,7 +68,7 @@ public class PriceUpdateParams extends ApiRequestParams { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -301,7 +301,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -312,7 +312,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -352,7 +352,7 @@ public Builder setNickname(EmptyParam nickname) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -394,7 +394,7 @@ public static class CurrencyOption { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -506,7 +506,7 @@ public Builder putAllExtraParam(Map map) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code diff --git a/src/main/java/com/stripe/param/ProductCreateParams.java b/src/main/java/com/stripe/param/ProductCreateParams.java index 42bccd8261a..c2606bbeffb 100644 --- a/src/main/java/com/stripe/param/ProductCreateParams.java +++ b/src/main/java/com/stripe/param/ProductCreateParams.java @@ -19,7 +19,7 @@ public class ProductCreateParams extends ApiRequestParams { Boolean active; /** - * Data used to generate a new Price object. This + * Data used to generate a new Price object. This * Price will be set as the default price for this product. */ @SerializedName("default_price_data") @@ -59,13 +59,13 @@ public class ProductCreateParams extends ApiRequestParams { /** * A list of up to 15 marketing features for this product. These are displayed in pricing tables. + * href="https://docs.stripe.com/payments/checkout/pricing-table">pricing tables. */ @SerializedName("marketing_features") List marketingFeatures; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -98,10 +98,17 @@ public class ProductCreateParams extends ApiRequestParams { @SerializedName("statement_descriptor") String statementDescriptor; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * The type of the product. Defaults to {@code service} if not explicitly specified, enabling use * of this product with Subscriptions and Plans. Set this parameter to {@code good} to use this @@ -137,6 +144,7 @@ private ProductCreateParams( Boolean shippable, String statementDescriptor, String taxCode, + TaxDetails taxDetails, Type type, String unitLabel, String url) { @@ -154,6 +162,7 @@ private ProductCreateParams( this.shippable = shippable; this.statementDescriptor = statementDescriptor; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.type = type; this.unitLabel = unitLabel; this.url = url; @@ -192,6 +201,8 @@ public static class Builder { private String taxCode; + private TaxDetails taxDetails; + private Type type; private String unitLabel; @@ -215,6 +226,7 @@ public ProductCreateParams build() { this.shippable, this.statementDescriptor, this.taxCode, + this.taxDetails, this.type, this.unitLabel, this.url); @@ -227,7 +239,7 @@ public Builder setActive(Boolean active) { } /** - * Data used to generate a new Price object. + * Data used to generate a new Price object. * This Price will be set as the default price for this product. */ public Builder setDefaultPriceData(ProductCreateParams.DefaultPriceData defaultPriceData) { @@ -417,12 +429,21 @@ public Builder setStatementDescriptor(String statementDescriptor) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + public Builder setTaxDetails(ProductCreateParams.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * The type of the product. Defaults to {@code service} if not explicitly specified, enabling * use of this product with Subscriptions and Plans. Set this parameter to {@code good} to use @@ -486,7 +507,7 @@ public static class DefaultPriceData { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -500,7 +521,7 @@ public static class DefaultPriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -695,7 +716,7 @@ public Builder setRecurring(ProductCreateParams.DefaultPriceData.Recurring recur /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -748,7 +769,7 @@ public static class CurrencyOption { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -862,7 +883,7 @@ public Builder putAllExtraParam(Map map) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1711,6 +1732,81 @@ public Builder setWidth(BigDecimal width) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + String taxCode; + + private TaxDetails(Map extraParams, String taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public ProductCreateParams.TaxDetails build() { + return new ProductCreateParams.TaxDetails(this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ProductCreateParams.TaxDetails#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ProductCreateParams.TaxDetails#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + } + } + public enum Type implements ApiRequestParams.EnumParam { @SerializedName("good") GOOD("good"), diff --git a/src/main/java/com/stripe/param/ProductFeatureCreateParams.java b/src/main/java/com/stripe/param/ProductFeatureCreateParams.java index 2d2b96386ee..8361ee5bcc4 100644 --- a/src/main/java/com/stripe/param/ProductFeatureCreateParams.java +++ b/src/main/java/com/stripe/param/ProductFeatureCreateParams.java @@ -15,7 +15,7 @@ public class ProductFeatureCreateParams extends ApiRequestParams { /** * Required. The ID of the Feature object attached to this + * href="https://docs.stripe.com/api/entitlements/feature">Feature object attached to this * product. */ @SerializedName("entitlement_feature") @@ -59,7 +59,7 @@ public ProductFeatureCreateParams build() { /** * Required. The ID of the Feature object attached to this + * href="https://docs.stripe.com/api/entitlements/feature">Feature object attached to this * product. */ public Builder setEntitlementFeature(String entitlementFeature) { diff --git a/src/main/java/com/stripe/param/ProductListParams.java b/src/main/java/com/stripe/param/ProductListParams.java index 135328cf223..aea6a9f299d 100644 --- a/src/main/java/com/stripe/param/ProductListParams.java +++ b/src/main/java/com/stripe/param/ProductListParams.java @@ -48,8 +48,8 @@ public class ProductListParams extends ApiRequestParams { /** * Only return products with the given IDs. Cannot be used with starting_after or ending_before. + * href="https://api.stripe.com#list_products-starting_after">starting_after or ending_before. */ @SerializedName("ids") List ids; diff --git a/src/main/java/com/stripe/param/ProductSearchParams.java b/src/main/java/com/stripe/param/ProductSearchParams.java index 8ee382db26a..7b4d11d511c 100644 --- a/src/main/java/com/stripe/param/ProductSearchParams.java +++ b/src/main/java/com/stripe/param/ProductSearchParams.java @@ -43,8 +43,8 @@ public class ProductSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for products. */ @SerializedName("query") @@ -153,8 +153,8 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for products. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/ProductUpdateParams.java b/src/main/java/com/stripe/param/ProductUpdateParams.java index 4a15e4131a3..6dbc4dfb4d1 100644 --- a/src/main/java/com/stripe/param/ProductUpdateParams.java +++ b/src/main/java/com/stripe/param/ProductUpdateParams.java @@ -20,7 +20,7 @@ public class ProductUpdateParams extends ApiRequestParams { Boolean active; /** - * The ID of the Price object that is the default + * The ID of the Price object that is the default * price for this product. */ @SerializedName("default_price") @@ -53,13 +53,13 @@ public class ProductUpdateParams extends ApiRequestParams { /** * A list of up to 15 marketing features for this product. These are displayed in pricing tables. + * href="https://docs.stripe.com/payments/checkout/pricing-table">pricing tables. */ @SerializedName("marketing_features") Object marketingFeatures; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -92,10 +92,17 @@ public class ProductUpdateParams extends ApiRequestParams { @SerializedName("statement_descriptor") Object statementDescriptor; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + @SerializedName("tax_details") + Object taxDetails; + /** * A label that represents units of this product. When set, this will be included in customers' * receipts, invoices, Checkout, and the customer portal. May only be set if {@code type=service}. @@ -121,6 +128,7 @@ private ProductUpdateParams( Boolean shippable, Object statementDescriptor, Object taxCode, + Object taxDetails, Object unitLabel, Object url) { this.active = active; @@ -136,6 +144,7 @@ private ProductUpdateParams( this.shippable = shippable; this.statementDescriptor = statementDescriptor; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; this.url = url; } @@ -171,6 +180,8 @@ public static class Builder { private Object taxCode; + private Object taxDetails; + private Object unitLabel; private Object url; @@ -191,6 +202,7 @@ public ProductUpdateParams build() { this.shippable, this.statementDescriptor, this.taxCode, + this.taxDetails, this.unitLabel, this.url); } @@ -202,7 +214,7 @@ public Builder setActive(Boolean active) { } /** - * The ID of the Price object that is the + * The ID of the Price object that is the * default price for this product. */ public Builder setDefaultPrice(String defaultPrice) { @@ -211,7 +223,7 @@ public Builder setDefaultPrice(String defaultPrice) { } /** - * The ID of the Price object that is the + * The ID of the Price object that is the * default price for this product. */ public Builder setDefaultPrice(EmptyParam defaultPrice) { @@ -365,7 +377,7 @@ public Builder addAllMarketingFeature(List /** * A list of up to 15 marketing features for this product. These are displayed in pricing tables. + * href="https://docs.stripe.com/payments/checkout/pricing-table">pricing tables. */ public Builder setMarketingFeatures(EmptyParam marketingFeatures) { this.marketingFeatures = marketingFeatures; @@ -374,7 +386,7 @@ public Builder setMarketingFeatures(EmptyParam marketingFeatures) { /** * A list of up to 15 marketing features for this product. These are displayed in pricing tables. + * href="https://docs.stripe.com/payments/checkout/pricing-table">pricing tables. */ public Builder setMarketingFeatures( List marketingFeatures) { @@ -411,7 +423,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -422,7 +434,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -494,18 +506,36 @@ public Builder setStatementDescriptor(EmptyParam statementDescriptor) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + public Builder setTaxDetails(ProductUpdateParams.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + + /** + * Tax details for this product, including the tax + * code and an optional performance location. + */ + public Builder setTaxDetails(EmptyParam taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in customers' * receipts, invoices, Checkout, and the customer portal. May only be set if {@code @@ -727,4 +757,88 @@ public Builder setWidth(BigDecimal width) { } } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + Object taxCode; + + private TaxDetails(Map extraParams, Object taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public ProductUpdateParams.TaxDetails build() { + return new ProductUpdateParams.TaxDetails(this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ProductUpdateParams.TaxDetails#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ProductUpdateParams.TaxDetails#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(EmptyParam taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } diff --git a/src/main/java/com/stripe/param/PromotionCodeCreateParams.java b/src/main/java/com/stripe/param/PromotionCodeCreateParams.java index ae40efcba17..0cf5e0616d1 100644 --- a/src/main/java/com/stripe/param/PromotionCodeCreateParams.java +++ b/src/main/java/com/stripe/param/PromotionCodeCreateParams.java @@ -28,15 +28,15 @@ public class PromotionCodeCreateParams extends ApiRequestParams { String code; /** - * The customer that this promotion code can be used by. If not set, the promotion code can be - * used by all customers. + * The customer who can use this promotion code. If not set, all customers can use the promotion + * code. */ @SerializedName("customer") String customer; /** - * The account that this promotion code can be used by. If not set, the promotion code can be used - * by all accounts. + * The account representing the customer who can use this promotion code. If not set, all + * customers can use the promotion code. */ @SerializedName("customer_account") String customerAccount; @@ -70,7 +70,7 @@ public class PromotionCodeCreateParams extends ApiRequestParams { Long maxRedemptions; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -173,8 +173,8 @@ public Builder setCode(String code) { } /** - * The customer that this promotion code can be used by. If not set, the promotion code can be - * used by all customers. + * The customer who can use this promotion code. If not set, all customers can use the promotion + * code. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -182,8 +182,8 @@ public Builder setCustomer(String customer) { } /** - * The account that this promotion code can be used by. If not set, the promotion code can be - * used by all accounts. + * The account representing the customer who can use this promotion code. If not set, all + * customers can use the promotion code. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; diff --git a/src/main/java/com/stripe/param/PromotionCodeListParams.java b/src/main/java/com/stripe/param/PromotionCodeListParams.java index 3a7910a51e4..e5ef7694dce 100644 --- a/src/main/java/com/stripe/param/PromotionCodeListParams.java +++ b/src/main/java/com/stripe/param/PromotionCodeListParams.java @@ -36,7 +36,7 @@ public class PromotionCodeListParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** Only return promotion codes that are restricted to this account. */ + /** Only return promotion codes that are restricted to this account representing the customer. */ @SerializedName("customer_account") String customerAccount; @@ -190,7 +190,9 @@ public Builder setCustomer(String customer) { return this; } - /** Only return promotion codes that are restricted to this account. */ + /** + * Only return promotion codes that are restricted to this account representing the customer. + */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/PromotionCodeUpdateParams.java b/src/main/java/com/stripe/param/PromotionCodeUpdateParams.java index ae279ba4057..ba997102900 100644 --- a/src/main/java/com/stripe/param/PromotionCodeUpdateParams.java +++ b/src/main/java/com/stripe/param/PromotionCodeUpdateParams.java @@ -35,7 +35,7 @@ public class PromotionCodeUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -171,7 +171,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -182,7 +182,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/QuoteCreateParams.java b/src/main/java/com/stripe/param/QuoteCreateParams.java index a501aaf96c7..a7a7d27a578 100644 --- a/src/main/java/com/stripe/param/QuoteCreateParams.java +++ b/src/main/java/com/stripe/param/QuoteCreateParams.java @@ -149,7 +149,7 @@ public class QuoteCreateParams extends ApiRequestParams { List lines; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -2504,7 +2504,7 @@ public static class AddItem { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -5633,7 +5633,7 @@ public static class LineItem { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -5766,7 +5766,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(QuoteCreateParams.LineItem.PriceData priceData) { @@ -6223,7 +6223,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6353,7 +6353,7 @@ public Builder setRecurring(QuoteCreateParams.LineItem.PriceData.Recurring recur /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6602,7 +6602,7 @@ public static class SubscriptionData { String fromSubscription; /** - * Set of key-value pairs that will set + * Set of key-value pairs that will set * metadata on the subscription or subscription schedule when the quote is accepted. If a * recurring price is included in {@code line_items}, this field will be passed to the resulting * subscription's {@code metadata} field. If {@code subscription_data.effective_date} is used, @@ -6633,7 +6633,7 @@ public static class SubscriptionData { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, or @@ -6641,7 +6641,7 @@ public static class SubscriptionData { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -6971,7 +6971,7 @@ public Builder setPrebilling(EmptyParam prebilling) { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, @@ -6979,7 +6979,7 @@ public Builder setPrebilling(EmptyParam prebilling) { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -8993,7 +8993,7 @@ public static class SubscriptionDataOverride { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, or @@ -9001,7 +9001,7 @@ public static class SubscriptionDataOverride { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -9201,7 +9201,7 @@ public Builder setPhaseEffectiveAt( /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, @@ -9209,7 +9209,7 @@ public Builder setPhaseEffectiveAt( * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * diff --git a/src/main/java/com/stripe/param/QuoteListParams.java b/src/main/java/com/stripe/param/QuoteListParams.java index 57120d9cc46..cb4305cb429 100644 --- a/src/main/java/com/stripe/param/QuoteListParams.java +++ b/src/main/java/com/stripe/param/QuoteListParams.java @@ -13,11 +13,11 @@ @Getter @EqualsAndHashCode(callSuper = false) public class QuoteListParams extends ApiRequestParams { - /** The ID of the customer whose quotes will be retrieved. */ + /** The ID of the customer whose quotes you're retrieving. */ @SerializedName("customer") String customer; - /** The ID of the account whose quotes will be retrieved. */ + /** The ID of the account representing the customer whose quotes you're retrieving. */ @SerializedName("customer_account") String customerAccount; @@ -137,13 +137,13 @@ public QuoteListParams build() { this.testClock); } - /** The ID of the customer whose quotes will be retrieved. */ + /** The ID of the customer whose quotes you're retrieving. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The ID of the account whose quotes will be retrieved. */ + /** The ID of the account representing the customer whose quotes you're retrieving. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/QuoteUpdateParams.java b/src/main/java/com/stripe/param/QuoteUpdateParams.java index 7564dd5a360..e7918ce7043 100644 --- a/src/main/java/com/stripe/param/QuoteUpdateParams.java +++ b/src/main/java/com/stripe/param/QuoteUpdateParams.java @@ -127,7 +127,7 @@ public class QuoteUpdateParams extends ApiRequestParams { List lines; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -2456,7 +2456,7 @@ public static class AddItem { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -5739,7 +5739,7 @@ public static class LineItem { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -5895,7 +5895,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(QuoteUpdateParams.LineItem.PriceData priceData) { @@ -6370,7 +6370,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6520,7 +6520,7 @@ public Builder setRecurring(QuoteUpdateParams.LineItem.PriceData.Recurring recur /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6767,7 +6767,7 @@ public static class SubscriptionData { Map extraParams; /** - * Set of key-value pairs that will set + * Set of key-value pairs that will set * metadata on the subscription or subscription schedule when the quote is accepted. If a * recurring price is included in {@code line_items}, this field will be passed to the resulting * subscription's {@code metadata} field. If {@code subscription_data.effective_date} is used, @@ -6798,7 +6798,7 @@ public static class SubscriptionData { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, or @@ -6806,7 +6806,7 @@ public static class SubscriptionData { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -7151,7 +7151,7 @@ public Builder setPrebilling(EmptyParam prebilling) { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, @@ -7159,7 +7159,7 @@ public Builder setPrebilling(EmptyParam prebilling) { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -8998,7 +8998,7 @@ public static class SubscriptionDataOverride { /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, or @@ -9006,7 +9006,7 @@ public static class SubscriptionDataOverride { * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * @@ -9250,7 +9250,7 @@ public Builder setPhaseEffectiveAt( /** * Determines how to handle prorations. When + * href="https://docs.stripe.com/subscriptions/billing-cycle#prorations">prorations. When * creating a subscription, valid values are {@code create_prorations} or {@code none}. * *

When updating a subscription, valid values are {@code create_prorations}, {@code none}, @@ -9258,7 +9258,7 @@ public Builder setPhaseEffectiveAt( * *

Passing {@code create_prorations} will cause proration invoice items to be created when * applicable. These proration items will only be invoiced immediately under certain + * href="https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment">certain * conditions. In order to always invoice immediately for prorations, pass {@code * always_invoice}. * diff --git a/src/main/java/com/stripe/param/RefundCreateParams.java b/src/main/java/com/stripe/param/RefundCreateParams.java index 15722e33649..e403f7e75ee 100644 --- a/src/main/java/com/stripe/param/RefundCreateParams.java +++ b/src/main/java/com/stripe/param/RefundCreateParams.java @@ -53,7 +53,7 @@ public class RefundCreateParams extends ApiRequestParams { String instructionsEmail; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -73,7 +73,7 @@ public class RefundCreateParams extends ApiRequestParams { * String indicating the reason for the refund. If set, possible values are {@code duplicate}, * {@code fraudulent}, and {@code requested_by_customer}. If you believe the charge to be * fraudulent, specifying {@code fraudulent} as the reason will add the associated card and email - * to your block lists, and will also help us + * to your block lists, and will also help us * improve our fraud detection algorithms. */ @SerializedName("reason") @@ -293,7 +293,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -304,7 +304,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -330,7 +330,7 @@ public Builder setPaymentIntent(String paymentIntent) { * String indicating the reason for the refund. If set, possible values are {@code duplicate}, * {@code fraudulent}, and {@code requested_by_customer}. If you believe the charge to be * fraudulent, specifying {@code fraudulent} as the reason will add the associated card and - * email to your block lists, and will also + * email to your block lists, and will also * help us improve our fraud detection algorithms. */ public Builder setReason(RefundCreateParams.Reason reason) { diff --git a/src/main/java/com/stripe/param/RefundUpdateParams.java b/src/main/java/com/stripe/param/RefundUpdateParams.java index d169830b825..ff28c3b7174 100644 --- a/src/main/java/com/stripe/param/RefundUpdateParams.java +++ b/src/main/java/com/stripe/param/RefundUpdateParams.java @@ -28,7 +28,7 @@ public class RefundUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/SetupIntentConfirmParams.java b/src/main/java/com/stripe/param/SetupIntentConfirmParams.java index 65e55ee9ead..539183affda 100644 --- a/src/main/java/com/stripe/param/SetupIntentConfirmParams.java +++ b/src/main/java/com/stripe/param/SetupIntentConfirmParams.java @@ -48,7 +48,7 @@ public class SetupIntentConfirmParams extends ApiRequestParams { /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ @SerializedName("payment_method_data") @@ -226,7 +226,7 @@ public Builder setPaymentMethod(String paymentMethod) { /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ public Builder setPaymentMethodData( @@ -870,7 +870,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -984,7 +984,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -1893,7 +1893,7 @@ public Builder setQris(SetupIntentConfirmParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -2905,7 +2905,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3020,7 +3023,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4051,6 +4057,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -5764,7 +5773,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -5820,7 +5829,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -8085,11 +8094,11 @@ public static class Card { /** * 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. */ @@ -8204,11 +8213,11 @@ public Builder setNetwork( /** * 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. */ @@ -10282,7 +10291,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -10290,14 +10299,14 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. */ @SerializedName("end_date") - String endDate; + Object endDate; /** * Map of extra parameters for custom features not available in this client library. The @@ -10311,7 +10320,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -10319,31 +10328,31 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. */ @SerializedName("start_date") - String startDate; + Object startDate; private MandateOptions( - Long amount, - AmountType amountType, - String endDate, + Object amount, + ApiRequestParams.EnumParam amountType, + Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose, - String startDate) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose, + Object startDate) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -10359,21 +10368,21 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; - private String endDate; + private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; - private String startDate; + private Object startDate; /** Finalize and obtain parameter instance from this builder. */ public SetupIntentConfirmParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -10397,6 +10406,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -10409,6 +10427,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -10418,6 +10446,15 @@ public Builder setEndDate(String endDate) { return this; } + /** + * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no + * end date. + */ + public Builder setEndDate(EmptyParam endDate) { + this.endDate = endDate; + return this; + } + /** * Add a key/value pair to `extraParams` map. A map is initialized for the first * `put/putAll` call, and subsequent calls add additional key/value pairs to the original @@ -10456,6 +10493,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -10466,6 +10509,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -10476,6 +10529,15 @@ public Builder setPurpose( return this; } + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } + /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. @@ -10484,6 +10546,15 @@ public Builder setStartDate(String startDate) { this.startDate = startDate; return this; } + + /** + * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to + * confirmation time. + */ + public Builder setStartDate(EmptyParam startDate) { + this.startDate = startDate; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { diff --git a/src/main/java/com/stripe/param/SetupIntentCreateParams.java b/src/main/java/com/stripe/param/SetupIntentCreateParams.java index 2451ce9e9d6..08d924d8a34 100644 --- a/src/main/java/com/stripe/param/SetupIntentCreateParams.java +++ b/src/main/java/com/stripe/param/SetupIntentCreateParams.java @@ -100,14 +100,14 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * This hash contains details about the mandate to create. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm">{@code * confirm=true}. */ @SerializedName("mandate_data") Object mandateData; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -127,7 +127,7 @@ public class SetupIntentCreateParams extends ApiRequestParams { String paymentMethod; /** - * The ID of the payment + * The ID of the payment * method configuration to use with this SetupIntent. */ @SerializedName("payment_method_configuration") @@ -135,7 +135,7 @@ public class SetupIntentCreateParams extends ApiRequestParams { /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ @SerializedName("payment_method_data") @@ -159,7 +159,7 @@ public class SetupIntentCreateParams extends ApiRequestParams { * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. To redirect to a mobile application, you can alternatively * supply an application URI scheme. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm">{@code * confirm=true}. */ @SerializedName("return_url") @@ -510,7 +510,7 @@ public Builder addAllFlowDirection(List e /** * This hash contains details about the mandate to create. This parameter can only be used with - * {@code + * {@code * confirm=true}. */ public Builder setMandateData(SetupIntentCreateParams.MandateData mandateData) { @@ -520,7 +520,7 @@ public Builder setMandateData(SetupIntentCreateParams.MandateData mandateData) { /** * This hash contains details about the mandate to create. This parameter can only be used with - * {@code + * {@code * confirm=true}. */ public Builder setMandateData(EmptyParam mandateData) { @@ -570,7 +570,7 @@ public Builder setPaymentMethod(String paymentMethod) { } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this SetupIntent. */ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) { @@ -580,7 +580,7 @@ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ public Builder setPaymentMethodData( @@ -626,7 +626,7 @@ public Builder addAllPaymentMethodType(List elements) { * The URL to redirect your customer back to after they authenticate or cancel their payment on * the payment method's app or site. To redirect to a mobile application, you can alternatively * supply an application URI scheme. This parameter can only be used with {@code + * href="https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm">{@code * confirm=true}. */ public Builder setReturnUrl(String returnUrl) { @@ -680,7 +680,7 @@ public static class AutomaticPaymentMethods { * *

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. */ @@ -729,7 +729,7 @@ public SetupIntentCreateParams.AutomaticPaymentMethods build() { * *

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. */ @@ -1408,7 +1408,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1522,7 +1522,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -2430,7 +2430,7 @@ public Builder setQris(SetupIntentCreateParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -3442,7 +3442,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3557,7 +3560,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -4586,6 +4592,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -6299,7 +6308,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -6355,7 +6364,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -8617,11 +8626,11 @@ public static class Card { /** * 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. */ @@ -8736,11 +8745,11 @@ public Builder setNetwork( /** * 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. */ @@ -10814,7 +10823,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -10822,14 +10831,14 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. */ @SerializedName("end_date") - String endDate; + Object endDate; /** * Map of extra parameters for custom features not available in this client library. The @@ -10843,7 +10852,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -10851,31 +10860,31 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. */ @SerializedName("start_date") - String startDate; + Object startDate; private MandateOptions( - Long amount, - AmountType amountType, - String endDate, + Object amount, + ApiRequestParams.EnumParam amountType, + Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose, - String startDate) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose, + Object startDate) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -10891,21 +10900,21 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; - private String endDate; + private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; - private String startDate; + private Object startDate; /** Finalize and obtain parameter instance from this builder. */ public SetupIntentCreateParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -10929,6 +10938,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -10941,6 +10959,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -10950,6 +10978,15 @@ public Builder setEndDate(String endDate) { return this; } + /** + * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no + * end date. + */ + public Builder setEndDate(EmptyParam endDate) { + this.endDate = endDate; + return this; + } + /** * Add a key/value pair to `extraParams` map. A map is initialized for the first * `put/putAll` call, and subsequent calls add additional key/value pairs to the original @@ -10988,6 +11025,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -10998,6 +11041,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -11008,6 +11061,15 @@ public Builder setPurpose( return this; } + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } + /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. @@ -11016,6 +11078,15 @@ public Builder setStartDate(String startDate) { this.startDate = startDate; return this; } + + /** + * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to + * confirmation time. + */ + public Builder setStartDate(EmptyParam startDate) { + this.startDate = startDate; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { @@ -12742,10 +12813,10 @@ public static class SingleUse { /** * Required. Amount the customer is granting permission to collect later. A * positive integer representing how much to charge in the smallest currency unit (e.g., 100 + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., 100 * cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is * $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 * for a USD charge of $999,999.99). */ @@ -12794,10 +12865,10 @@ public SetupIntentCreateParams.SingleUse build() { /** * Required. Amount the customer is granting permission to collect later. A * positive integer representing how much to charge in the smallest currency unit (e.g., + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit (e.g., * 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum * amount is $0.50 US or equivalent in + * href="https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts">equivalent in * charge currency. The amount value supports up to eight digits (e.g., a value of * 99999999 for a USD charge of $999,999.99). */ diff --git a/src/main/java/com/stripe/param/SetupIntentUpdateParams.java b/src/main/java/com/stripe/param/SetupIntentUpdateParams.java index 4593ed0a3d5..7414e7feb05 100644 --- a/src/main/java/com/stripe/param/SetupIntentUpdateParams.java +++ b/src/main/java/com/stripe/param/SetupIntentUpdateParams.java @@ -75,7 +75,7 @@ public class SetupIntentUpdateParams extends ApiRequestParams { List flowDirections; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -91,7 +91,7 @@ public class SetupIntentUpdateParams extends ApiRequestParams { Object paymentMethod; /** - * The ID of the payment + * The ID of the payment * method configuration to use with this SetupIntent. */ @SerializedName("payment_method_configuration") @@ -99,7 +99,7 @@ public class SetupIntentUpdateParams extends ApiRequestParams { /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ @SerializedName("payment_method_data") @@ -439,7 +439,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -450,7 +450,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -479,7 +479,7 @@ public Builder setPaymentMethod(EmptyParam paymentMethod) { } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this SetupIntent. */ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) { @@ -488,7 +488,7 @@ public Builder setPaymentMethodConfiguration(String paymentMethodConfiguration) } /** - * The ID of the payment + * The ID of the payment * method configuration to use with this SetupIntent. */ public Builder setPaymentMethodConfiguration(EmptyParam paymentMethodConfiguration) { @@ -498,7 +498,7 @@ public Builder setPaymentMethodConfiguration(EmptyParam paymentMethodConfigurati /** * When included, this hash creates a PaymentMethod that is set as the {@code + * href="https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method">{@code * payment_method} value in the SetupIntent. */ public Builder setPaymentMethodData( @@ -777,7 +777,7 @@ public static class PaymentMethodData { MbWay mbWay; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -891,7 +891,7 @@ public static class PaymentMethodData { Qris qris; /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ @SerializedName("radar_options") @@ -1799,7 +1799,7 @@ public Builder setQris(SetupIntentUpdateParams.PaymentMethodData.Qris qris) { } /** - * Options to configure Radar. See Radar + * Options to configure Radar. See Radar * Session for more information. */ public Builder setRadarOptions( @@ -2862,7 +2862,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -3010,13 +3013,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -4054,6 +4063,9 @@ public enum Bank implements ApiRequestParams.EnumParam { @SerializedName("knab") KNAB("knab"), + @SerializedName("mollie") + MOLLIE("mollie"), + @SerializedName("moneyou") MONEYOU("moneyou"), @@ -5823,7 +5835,7 @@ public static class RadarOptions { Map extraParams; /** - * 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. */ @@ -5879,7 +5891,7 @@ public Builder putAllExtraParam(Map map) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -5889,7 +5901,7 @@ public Builder setSession(String session) { } /** - * A Radar Session is a snapshot + * A Radar Session is a snapshot * of the browser metadata and device details that help Radar make more accurate predictions * on your payments. */ @@ -8190,11 +8202,11 @@ public static class Card { /** * 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. */ @@ -8309,11 +8321,11 @@ public Builder setNetwork( /** * 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. */ @@ -10503,7 +10515,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -10511,7 +10523,7 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no @@ -10532,7 +10544,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -10540,14 +10552,14 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to @@ -10557,13 +10569,13 @@ public static class MandateOptions { Object startDate; private MandateOptions( - Long amount, - AmountType amountType, + Object amount, + ApiRequestParams.EnumParam amountType, Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose, + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose, Object startDate) { this.amount = amount; this.amountType = amountType; @@ -10580,19 +10592,19 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; private Object startDate; @@ -10618,6 +10630,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -10630,6 +10651,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -10686,6 +10717,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -10696,6 +10733,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -10706,6 +10753,15 @@ public Builder setPurpose( return this; } + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } + /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. diff --git a/src/main/java/com/stripe/param/ShippingRateCreateParams.java b/src/main/java/com/stripe/param/ShippingRateCreateParams.java index 14cd0691bc3..6921468a83f 100644 --- a/src/main/java/com/stripe/param/ShippingRateCreateParams.java +++ b/src/main/java/com/stripe/param/ShippingRateCreateParams.java @@ -48,7 +48,7 @@ public class ShippingRateCreateParams extends ApiRequestParams { FixedAmount fixedAmount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -64,7 +64,7 @@ public class ShippingRateCreateParams extends ApiRequestParams { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax code + * A tax code ID. The Shipping tax code * is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -247,7 +247,7 @@ public Builder setTaxBehavior(ShippingRateCreateParams.TaxBehavior taxBehavior) } /** - * A tax code ID. The Shipping tax code + * A tax code ID. The Shipping tax code * is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { diff --git a/src/main/java/com/stripe/param/ShippingRateUpdateParams.java b/src/main/java/com/stripe/param/ShippingRateUpdateParams.java index 09a40c7f4d1..9b92be2c973 100644 --- a/src/main/java/com/stripe/param/ShippingRateUpdateParams.java +++ b/src/main/java/com/stripe/param/ShippingRateUpdateParams.java @@ -39,7 +39,7 @@ public class ShippingRateUpdateParams extends ApiRequestParams { FixedAmount fixedAmount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -193,7 +193,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -204,7 +204,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/SourceCreateParams.java b/src/main/java/com/stripe/param/SourceCreateParams.java index 6e8f469e17e..8dacedef0be 100644 --- a/src/main/java/com/stripe/param/SourceCreateParams.java +++ b/src/main/java/com/stripe/param/SourceCreateParams.java @@ -119,7 +119,7 @@ public class SourceCreateParams extends ApiRequestParams { /** * The {@code type} of the source to create. Required unless {@code customer} and {@code * original_source} are specified (see the Cloning card Sources + * href="https://docs.stripe.com/sources/connect#cloning-card-sources">Cloning card Sources * guide) */ @SerializedName("type") @@ -417,7 +417,7 @@ public Builder setToken(String token) { /** * The {@code type} of the source to create. Required unless {@code customer} and {@code * original_source} are specified (see the Cloning card Sources + * href="https://docs.stripe.com/sources/connect#cloning-card-sources">Cloning card Sources * guide) */ public Builder setType(String type) { @@ -1208,7 +1208,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -1321,7 +1324,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1965,7 +1971,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -2080,7 +2089,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/SourceUpdateParams.java b/src/main/java/com/stripe/param/SourceUpdateParams.java index f8544e86199..94ea5ab5f57 100644 --- a/src/main/java/com/stripe/param/SourceUpdateParams.java +++ b/src/main/java/com/stripe/param/SourceUpdateParams.java @@ -39,7 +39,7 @@ public class SourceUpdateParams extends ApiRequestParams { Mandate mandate; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -205,7 +205,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -216,7 +216,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1085,7 +1085,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -1231,13 +1234,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -1748,7 +1757,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -1898,13 +1910,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/SubscriptionCreateParams.java b/src/main/java/com/stripe/param/SubscriptionCreateParams.java index c420a8e4650..f16792a604f 100644 --- a/src/main/java/com/stripe/param/SubscriptionCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionCreateParams.java @@ -56,7 +56,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * A future timestamp in UTC format to anchor the subscription's billing cycle. The anchor is the + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle. The anchor is the * reference point that aligns future billing cycle dates. It sets the day of week for {@code * week} intervals, the day of month for {@code month} and {@code year} intervals, and the month * of year for {@code year} intervals. @@ -124,7 +124,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** The identifier of the account to subscribe. */ + /** The identifier of the account representing the customer to subscribe. */ @SerializedName("customer_account") String customerAccount; @@ -139,9 +139,9 @@ public class SubscriptionCreateParams extends ApiRequestParams { * ID of the default payment method for the subscription. It must belong to the customer * associated with the subscription. This takes precedence over {@code default_source}. If neither * are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_payment_method") String defaultPaymentMethod; @@ -151,9 +151,9 @@ public class SubscriptionCreateParams extends ApiRequestParams { * associated with the subscription and be in a chargeable state. If {@code * default_payment_method} is also set, {@code default_payment_method} will take precedence. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_source") String defaultSource; @@ -203,7 +203,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { List items; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -229,7 +229,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { * first invoice can't be paid. Creating Subscriptions with this status allows you to manage * scenarios where additional customer actions are needed to pay a subscription's invoice. For * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to create Subscriptions with {@code status=incomplete} when @@ -237,7 +237,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { * {@code status=active} when successfully confirming the PaymentIntent on the first invoice. This * allows simpler management of scenarios where additional customer actions are needed to pay a * subscription’s invoice, such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. If the PaymentIntent * is not confirmed within 23 hours Subscriptions transition to {@code status=incomplete_expired}, * which is a terminal state. @@ -247,7 +247,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { * authentication due to SCA regulation and further customer action is needed, this parameter * doesn't create a Subscription and returns an error instead. This was the default behavior for * API versions prior to 2019-03-14. See the changelog to learn more. + * href="https://docs.stripe.com/upgrades#2019-03-14">changelog to learn more. * *

{@code pending_if_incomplete} is only used with updates and cannot be passed when creating a * Subscription. @@ -264,7 +264,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") @@ -276,7 +276,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * Determines how to handle prorations resulting from + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations resulting from * the {@code billing_cycle_anchor}. If no value is passed, the default is {@code * create_prorations}. */ @@ -295,7 +295,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { * charged for the first time. If set, trial_end will override the default trial period of the * plan the customer is being subscribed to. The special value {@code now} can be provided to end * the customer's trial immediately. Can be at most two years from {@code billing_cycle_anchor}. - * See Using trial periods on + * See Using trial periods on * subscriptions to learn more. */ @SerializedName("trial_end") @@ -305,7 +305,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { * 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") @@ -314,7 +314,7 @@ public class SubscriptionCreateParams extends ApiRequestParams { /** * Integer representing the number of trial period days before the customer is charged for the * first time. This will always overwrite any trials that might apply via a subscribed plan. See - * Using trial periods on + * Using trial periods on * subscriptions to learn more. */ @SerializedName("trial_period_days") @@ -613,7 +613,7 @@ public Builder setBillingCadence(String billingCadence) { /** * A future timestamp in UTC format to anchor the subscription's billing cycle. The anchor is + * href="https://docs.stripe.com/subscriptions/billing-cycle">billing cycle. The anchor is * the reference point that aligns future billing cycle dates. It sets the day of week for * {@code week} intervals, the day of month for {@code month} and {@code year} intervals, and * the month of year for {@code year} intervals. @@ -744,7 +744,7 @@ public Builder setCustomer(String customer) { return this; } - /** The identifier of the account to subscribe. */ + /** The identifier of the account representing the customer to subscribe. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; @@ -763,9 +763,9 @@ public Builder setDaysUntilDue(Long daysUntilDue) { * ID of the default payment method for the subscription. It must belong to the customer * associated with the subscription. This takes precedence over {@code default_source}. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { this.defaultPaymentMethod = defaultPaymentMethod; @@ -777,9 +777,9 @@ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { * associated with the subscription and be in a chargeable state. If {@code * default_payment_method} is also set, {@code default_payment_method} will take precedence. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultSource(String defaultSource) { this.defaultSource = defaultSource; @@ -1003,7 +1003,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1014,7 +1014,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1052,7 +1052,7 @@ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { * first invoice can't be paid. Creating Subscriptions with this status allows you to manage * scenarios where additional customer actions are needed to pay a subscription's invoice. For * example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to create Subscriptions with {@code status=incomplete} when @@ -1060,7 +1060,7 @@ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { * {@code status=active} when successfully confirming the PaymentIntent on the first invoice. * This allows simpler management of scenarios where additional customer actions are needed to * pay a subscription’s invoice, such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. If the PaymentIntent * is not confirmed within 23 hours Subscriptions transition to {@code * status=incomplete_expired}, which is a terminal state. @@ -1070,7 +1070,7 @@ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { * authentication due to SCA regulation and further customer action is needed, this parameter * doesn't create a Subscription and returns an error instead. This was the default behavior for * API versions prior to 2019-03-14. See the changelog to learn more. + * href="https://docs.stripe.com/upgrades#2019-03-14">changelog to learn more. * *

{@code pending_if_incomplete} is only used with updates and cannot be passed when creating * a Subscription. @@ -1091,7 +1091,7 @@ public Builder setPaymentSettings(SubscriptionCreateParams.PaymentSettings payme /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval( @@ -1102,7 +1102,7 @@ public Builder setPendingInvoiceItemInterval( /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval) { @@ -1118,7 +1118,7 @@ public Builder setPrebilling(SubscriptionCreateParams.Prebilling prebilling) { /** * Determines how to handle prorations resulting from + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations resulting from * the {@code billing_cycle_anchor}. If no value is passed, the default is {@code * create_prorations}. */ @@ -1143,7 +1143,7 @@ public Builder setTransferData(SubscriptionCreateParams.TransferData transferDat * plan the customer is being subscribed to. The special value {@code now} can be provided to * end the customer's trial immediately. Can be at most two years from {@code * billing_cycle_anchor}. See Using trial periods on + * href="https://docs.stripe.com/billing/subscriptions/trials">Using trial periods on * subscriptions to learn more. */ public Builder setTrialEnd(SubscriptionCreateParams.TrialEnd trialEnd) { @@ -1157,7 +1157,7 @@ public Builder setTrialEnd(SubscriptionCreateParams.TrialEnd trialEnd) { * plan the customer is being subscribed to. The special value {@code now} can be provided to * end the customer's trial immediately. Can be at most two years from {@code * billing_cycle_anchor}. See Using trial periods on + * href="https://docs.stripe.com/billing/subscriptions/trials">Using trial periods on * subscriptions to learn more. */ public Builder setTrialEnd(Long trialEnd) { @@ -1169,7 +1169,7 @@ public Builder setTrialEnd(Long trialEnd) { * 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. */ public Builder setTrialFromPlan(Boolean trialFromPlan) { @@ -1180,7 +1180,7 @@ public Builder setTrialFromPlan(Boolean trialFromPlan) { /** * Integer representing the number of trial period days before the customer is charged for the * first time. This will always overwrite any trials that might apply via a subscribed plan. See - * Using trial periods on + * Using trial periods on * subscriptions to learn more. */ public Builder setTrialPeriodDays(Long trialPeriodDays) { @@ -1212,7 +1212,7 @@ public static class AddInvoiceItem { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1233,7 +1233,7 @@ public static class AddInvoiceItem { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -1400,7 +1400,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(SubscriptionCreateParams.AddInvoiceItem.PriceData priceData) { @@ -2167,7 +2167,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2284,7 +2284,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -4037,7 +4037,7 @@ public static class Item { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -4054,7 +4054,7 @@ public static class Item { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -4065,9 +4065,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4276,7 +4276,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(SubscriptionCreateParams.Item.PriceData priceData) { @@ -4319,9 +4319,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4331,9 +4331,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4364,7 +4364,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -4421,7 +4421,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -4924,7 +4924,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -5055,7 +5055,7 @@ public Builder setRecurring(SubscriptionCreateParams.Item.PriceData.Recurring re /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -5584,6 +5584,13 @@ public static class PaymentMethodOptions { @SerializedName("konbini") Object konbini; + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + @SerializedName("payto") + Object payto; + /** * This sub-hash contains details about the Pix payment method options to pass to the * invoice’s PaymentIntent. @@ -5620,6 +5627,7 @@ private PaymentMethodOptions( Map extraParams, Object idBankTransfer, Object konbini, + Object payto, Object pix, Object sepaDebit, Object upi, @@ -5631,6 +5639,7 @@ private PaymentMethodOptions( this.extraParams = extraParams; this.idBankTransfer = idBankTransfer; this.konbini = konbini; + this.payto = payto; this.pix = pix; this.sepaDebit = sepaDebit; this.upi = upi; @@ -5656,6 +5665,8 @@ public static class Builder { private Object konbini; + private Object payto; + private Object pix; private Object sepaDebit; @@ -5674,6 +5685,7 @@ public SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions build() { this.extraParams, this.idBankTransfer, this.konbini, + this.payto, this.pix, this.sepaDebit, this.upi, @@ -5826,6 +5838,25 @@ public Builder setKonbini(EmptyParam konbini) { return this; } + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + public Builder setPayto( + SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto payto) { + this.payto = payto; + return this; + } + + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + public Builder setPayto(EmptyParam payto) { + this.payto = payto; + return this; + } + /** * This sub-hash contains details about the Pix payment method options to pass to the * invoice’s PaymentIntent. @@ -6245,10 +6276,10 @@ public static class Card { /** * 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. */ @@ -6336,10 +6367,10 @@ public Builder setNetwork( /** * 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. */ @@ -6973,6 +7004,230 @@ public Builder putAllExtraParam(Map map) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Payto { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Additional fields for Mandate creation. */ + @SerializedName("mandate_options") + MandateOptions mandateOptions; + + private Payto(Map extraParams, MandateOptions mandateOptions) { + this.extraParams = extraParams; + this.mandateOptions = mandateOptions; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private MandateOptions mandateOptions; + + /** Finalize and obtain parameter instance from this builder. */ + public SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto build() { + return new SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto( + this.extraParams, this.mandateOptions); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for + * the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for + * the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Additional fields for Mandate creation. */ + public Builder setMandateOptions( + SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + mandateOptions) { + this.mandateOptions = mandateOptions; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class MandateOptions { + /** + * 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; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + @SerializedName("purpose") + Purpose purpose; + + private MandateOptions(Long amount, Map extraParams, Purpose purpose) { + this.amount = amount; + this.extraParams = extraParams; + this.purpose = purpose; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Long amount; + + private Map extraParams; + + private Purpose purpose; + + /** Finalize and obtain parameter instance from this builder. */ + public SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions + build() { + return new SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions(this.amount, this.extraParams, this.purpose); + } + + /** + * The maximum amount that can be collected in a single invoice. If you don't specify a + * maximum, then there is no limit. + */ + public Builder setAmount(Long amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose( + SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + .Purpose + purpose) { + this.purpose = purpose; + return this; + } + } + + public enum Purpose implements ApiRequestParams.EnumParam { + @SerializedName("dependant_support") + DEPENDANT_SUPPORT("dependant_support"), + + @SerializedName("government") + GOVERNMENT("government"), + + @SerializedName("loan") + LOAN("loan"), + + @SerializedName("mortgage") + MORTGAGE("mortgage"), + + @SerializedName("other") + OTHER("other"), + + @SerializedName("pension") + PENSION("pension"), + + @SerializedName("personal") + PERSONAL("personal"), + + @SerializedName("retail") + RETAIL("retail"), + + @SerializedName("salary") + SALARY("salary"), + + @SerializedName("tax") + TAX("tax"), + + @SerializedName("utility") + UTILITY("utility"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Purpose(String value) { + this.value = value; + } + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Pix { @@ -8136,6 +8391,9 @@ public enum PaymentMethodType implements ApiRequestParams.EnumParam { @SerializedName("paypal") PAYPAL("paypal"), + @SerializedName("payto") + PAYTO("payto"), + @SerializedName("pix") PIX("pix"), diff --git a/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java b/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java index c2b05f8ebf7..a697b844bee 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemCreateParams.java @@ -44,7 +44,7 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -57,20 +57,20 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. This * allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. When + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. When * you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -92,7 +92,7 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -100,7 +100,7 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { /** * Determines how to handle prorations when the billing + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the billing * cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, or * starting a trial), or if an item's {@code quantity} changes. The default value is {@code * create_prorations}. @@ -111,7 +111,7 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -125,9 +125,9 @@ public class SubscriptionItemCreateParams extends ApiRequestParams { String subscription; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -379,20 +379,20 @@ public Builder putAllMetadata(Map map) { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. * This allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. * When you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -421,7 +421,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData(SubscriptionItemCreateParams.PriceData priceData) { @@ -431,7 +431,7 @@ public Builder setPriceData(SubscriptionItemCreateParams.PriceData priceData) { /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -445,7 +445,7 @@ public Builder setProrationBehavior( /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; @@ -493,9 +493,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -505,9 +505,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -538,7 +538,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -593,7 +593,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -1086,7 +1086,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1215,7 +1215,7 @@ public Builder setRecurring(SubscriptionItemCreateParams.PriceData.Recurring rec /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code diff --git a/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java b/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java index b1d825acf94..5b3eed7d402 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemDeleteParams.java @@ -29,7 +29,7 @@ public class SubscriptionItemDeleteParams extends ApiRequestParams { /** * Determines how to handle prorations when the billing + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the billing * cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, or * starting a trial), or if an item's {@code quantity} changes. The default value is {@code * create_prorations}. @@ -40,7 +40,7 @@ public class SubscriptionItemDeleteParams extends ApiRequestParams { /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -112,7 +112,7 @@ public Builder putAllExtraParam(Map map) { /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -126,7 +126,7 @@ public Builder setProrationBehavior( /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; diff --git a/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java index 1afc5786a47..a97da85a5e3 100644 --- a/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionItemUpdateParams.java @@ -44,7 +44,7 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -64,20 +64,20 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. This * allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. When + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. When * you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -103,7 +103,7 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -111,7 +111,7 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { /** * Determines how to handle prorations when the billing + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the billing * cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, or * starting a trial), or if an item's {@code quantity} changes. The default value is {@code * create_prorations}. @@ -122,7 +122,7 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ @SerializedName("proration_date") Long prorationDate; @@ -132,9 +132,9 @@ public class SubscriptionItemUpdateParams extends ApiRequestParams { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -375,7 +375,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -386,7 +386,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -410,20 +410,20 @@ public Builder setOffSession(Boolean offSession) { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. * This allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. * When you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -472,7 +472,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(SubscriptionItemUpdateParams.PriceData priceData) { @@ -482,7 +482,7 @@ public Builder setPriceData(SubscriptionItemUpdateParams.PriceData priceData) { /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -496,7 +496,7 @@ public Builder setProrationBehavior( /** * If set, the proration will be calculated as though the subscription was updated at the given * time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. + * href="https://api.stripe.com#retrieve_customer_invoice">upcoming invoice endpoint. */ public Builder setProrationDate(Long prorationDate) { this.prorationDate = prorationDate; @@ -538,9 +538,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -550,9 +550,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -577,7 +577,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -632,7 +632,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -1149,7 +1149,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is * considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -1298,7 +1298,7 @@ public Builder setRecurring(SubscriptionItemUpdateParams.PriceData.Recurring rec /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code diff --git a/src/main/java/com/stripe/param/SubscriptionListParams.java b/src/main/java/com/stripe/param/SubscriptionListParams.java index 1c864620fbc..20fd3bbde7a 100644 --- a/src/main/java/com/stripe/param/SubscriptionListParams.java +++ b/src/main/java/com/stripe/param/SubscriptionListParams.java @@ -42,11 +42,11 @@ public class SubscriptionListParams extends ApiRequestParams { @SerializedName("current_period_start") Object currentPeriodStart; - /** The ID of the customer whose subscriptions will be retrieved. */ + /** The ID of the customer whose subscriptions you're retrieving. */ @SerializedName("customer") String customer; - /** The ID of the account whose subscriptions will be retrieved. */ + /** The ID of the account representing the customer whose subscriptions you're retrieving. */ @SerializedName("customer_account") String customerAccount; @@ -100,7 +100,7 @@ public class SubscriptionListParams extends ApiRequestParams { * The status of the subscriptions to retrieve. Passing in a value of {@code canceled} will return * all canceled subscriptions, including those belonging to deleted customers. Pass {@code ended} * to find subscriptions that are canceled and subscriptions that are expired due to incomplete + * href="https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses">incomplete * payment. Passing in a value of {@code all} will return subscriptions of all statuses. If no * value is supplied, all subscriptions that have not been canceled are returned. */ @@ -271,13 +271,13 @@ public Builder setCurrentPeriodStart(Long currentPeriodStart) { return this; } - /** The ID of the customer whose subscriptions will be retrieved. */ + /** The ID of the customer whose subscriptions you're retrieving. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The ID of the account whose subscriptions will be retrieved. */ + /** The ID of the account representing the customer whose subscriptions you're retrieving. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; @@ -383,7 +383,7 @@ public Builder setStartingAfter(String startingAfter) { * return all canceled subscriptions, including those belonging to deleted customers. Pass * {@code ended} to find subscriptions that are canceled and subscriptions that are expired due * to incomplete + * href="https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses">incomplete * payment. Passing in a value of {@code all} will return subscriptions of all statuses. If * no value is supplied, all subscriptions that have not been canceled are returned. */ diff --git a/src/main/java/com/stripe/param/SubscriptionResumeParams.java b/src/main/java/com/stripe/param/SubscriptionResumeParams.java index 0630cf0e49a..67738afcad4 100644 --- a/src/main/java/com/stripe/param/SubscriptionResumeParams.java +++ b/src/main/java/com/stripe/param/SubscriptionResumeParams.java @@ -16,7 +16,7 @@ public class SubscriptionResumeParams extends ApiRequestParams { /** * The billing cycle anchor that applies when the subscription is resumed. Either {@code now} or * {@code unchanged}. The default is {@code now}. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -36,7 +36,7 @@ public class SubscriptionResumeParams extends ApiRequestParams { /** * Determines how to handle prorations resulting from + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations resulting from * the {@code billing_cycle_anchor} being {@code unchanged}. When the {@code billing_cycle_anchor} * is set to {@code now} (default value), no prorations are generated. If no value is passed, the * default is {@code create_prorations}. @@ -93,7 +93,7 @@ public SubscriptionResumeParams build() { /** * The billing cycle anchor that applies when the subscription is resumed. Either {@code now} or * {@code unchanged}. The default is {@code now}. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionResumeParams.BillingCycleAnchor billingCycleAnchor) { @@ -155,7 +155,7 @@ public Builder putAllExtraParam(Map map) { /** * Determines how to handle prorations resulting from + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations resulting from * the {@code billing_cycle_anchor} being {@code unchanged}. When the {@code * billing_cycle_anchor} is set to {@code now} (default value), no prorations are generated. If * no value is passed, the default is {@code create_prorations}. diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleAmendParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleAmendParams.java index f502c39f367..515ab43f6c9 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleAmendParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleAmendParams.java @@ -2275,7 +2275,7 @@ public static class Add { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java index 808a3506295..f884f21f747 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleCreateParams.java @@ -78,7 +78,7 @@ public class SubscriptionScheduleCreateParams extends ApiRequestParams { String fromSubscription; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -358,7 +358,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -369,7 +369,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1123,7 +1123,7 @@ public static class DefaultSettings { * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this * phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -1295,7 +1295,7 @@ public Builder setAutomaticTax( * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionScheduleCreateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor) { @@ -2190,7 +2190,7 @@ public static class Phase { * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this * phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -2229,11 +2229,11 @@ public static class Phase { String defaultPaymentMethod; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ @SerializedName("default_tax_rates") @@ -2271,8 +2271,8 @@ public static class Phase { EffectiveAt effectiveAt; /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} - * must not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code duration} must + * not be set. */ @SerializedName("end_date") Long endDate; @@ -2298,7 +2298,7 @@ public static class Phase { List items; /** - * Set of key-value pairs that you can attach + * Set of key-value pairs that you can attach * to a phase. Metadata on a schedule's phase will update the underlying subscription's {@code * metadata} when the phase is entered, adding new keys and replacing existing keys in the * subscription's {@code metadata}. Individual keys in the subscription's {@code metadata} can @@ -2318,7 +2318,7 @@ public static class Phase { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -2326,10 +2326,10 @@ public static class Phase { /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's different * from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing configuration * (item price, quantity, etc.) of the current phase. */ @@ -2560,7 +2560,7 @@ public Builder setAutomaticTax( * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor billingCycleAnchor) { @@ -2649,11 +2649,11 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { @@ -2662,11 +2662,11 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(List defaultTaxRates) { @@ -2766,7 +2766,7 @@ public Builder setEffectiveAt( } /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * The date at which this phase of the subscription schedule ends. If set, {@code duration} * must not be set. */ public Builder setEndDate(Long endDate) { @@ -2871,7 +2871,7 @@ public Builder setOnBehalfOf(String onBehalfOf) { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ public Builder setPauseCollection( @@ -2882,10 +2882,10 @@ public Builder setPauseCollection( /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's * different from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing * configuration (item price, quantity, etc.) of the current phase. */ @@ -2955,7 +2955,7 @@ public static class AddInvoiceItem { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2976,7 +2976,7 @@ public static class AddInvoiceItem { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -3150,7 +3150,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData( @@ -3948,7 +3948,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -4069,7 +4069,7 @@ public Builder setProduct(String product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} @@ -5186,7 +5186,7 @@ public static class Item { Map extraParams; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to a configuration item. Metadata on a configuration item will update the underlying * subscription item's {@code metadata} when the phase is entered, adding new keys and * replacing existing keys. Individual keys in the subscription item's {@code metadata} can be @@ -5208,7 +5208,7 @@ public static class Item { String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -5222,9 +5222,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5441,7 +5441,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData( @@ -5488,9 +5488,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5500,9 +5500,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5540,7 +5540,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -5599,7 +5599,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -6016,7 +6016,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6149,7 +6149,7 @@ public Builder setRecurring( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} diff --git a/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java index 9f611e25194..0db13468498 100644 --- a/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionScheduleUpdateParams.java @@ -56,7 +56,7 @@ public class SubscriptionScheduleUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -303,7 +303,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -314,7 +314,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -878,7 +878,7 @@ public static class DefaultSettings { * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this * phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -1050,7 +1050,7 @@ public Builder setAutomaticTax( * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor) { @@ -1973,7 +1973,7 @@ public static class Phase { * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this * phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -2012,11 +2012,11 @@ public static class Phase { Object defaultPaymentMethod; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ @SerializedName("default_tax_rates") @@ -2054,8 +2054,8 @@ public static class Phase { EffectiveAt effectiveAt; /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} - * must not be set. + * The date at which this phase of the subscription schedule ends. If set, {@code duration} must + * not be set. */ @SerializedName("end_date") Object endDate; @@ -2081,7 +2081,7 @@ public static class Phase { List items; /** - * Set of key-value pairs that you can attach + * Set of key-value pairs that you can attach * to a phase. Metadata on a schedule's phase will update the underlying subscription's {@code * metadata} when the phase is entered, adding new keys and replacing existing keys in the * subscription's {@code metadata}. Individual keys in the subscription's {@code metadata} can @@ -2101,7 +2101,7 @@ public static class Phase { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -2109,10 +2109,10 @@ public static class Phase { /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's different * from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing configuration * (item price, quantity, etc.) of the current phase. */ @@ -2355,7 +2355,7 @@ public Builder setAutomaticTax( * Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code * automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if * this phase specifies a trial. For more information, see the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionScheduleUpdateParams.Phase.BillingCycleAnchor billingCycleAnchor) { @@ -2464,11 +2464,11 @@ public Builder addAllDefaultTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { @@ -2477,11 +2477,11 @@ public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will set the Subscription's {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates}, which means they will be the Invoice's {@code + * href="https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates">{@code * default_tax_rates} for any Invoices issued by the Subscription during this Phase. */ public Builder setDefaultTaxRates(List defaultTaxRates) { @@ -2581,7 +2581,7 @@ public Builder setEffectiveAt( } /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * The date at which this phase of the subscription schedule ends. If set, {@code duration} * must not be set. */ public Builder setEndDate(Long endDate) { @@ -2590,7 +2590,7 @@ public Builder setEndDate(Long endDate) { } /** - * The date at which this phase of the subscription schedule ends. If set, {@code iterations} + * The date at which this phase of the subscription schedule ends. If set, {@code duration} * must not be set. */ public Builder setEndDate(SubscriptionScheduleUpdateParams.Phase.EndDate endDate) { @@ -2704,7 +2704,7 @@ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ public Builder setPauseCollection( @@ -2715,10 +2715,10 @@ public Builder setPauseCollection( /** * Controls whether the subscription schedule should create prorations when + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when * transitioning to this phase if there is a difference in billing configuration. It's * different from the request-level proration_behavior + * href="https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior">proration_behavior * parameter which controls what happens if the update request affects the billing * configuration (item price, quantity, etc.) of the current phase. */ @@ -2815,7 +2815,7 @@ public static class AddInvoiceItem { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2836,7 +2836,7 @@ public static class AddInvoiceItem { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -3016,7 +3016,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData( @@ -3832,7 +3832,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -3974,7 +3974,7 @@ public Builder setProduct(EmptyParam product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} @@ -5131,7 +5131,7 @@ public static class Item { Map extraParams; /** - * Set of key-value pairs that you can + * Set of key-value pairs that you can * attach to a configuration item. Metadata on a configuration item will update the underlying * subscription item's {@code metadata} when the phase is entered, adding new keys and * replacing existing keys. Individual keys in the subscription item's {@code metadata} can be @@ -5153,7 +5153,7 @@ public static class Item { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ @SerializedName("price_data") @@ -5167,9 +5167,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5401,7 +5401,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. */ public Builder setPriceData( @@ -5448,9 +5448,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5460,9 +5460,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax + * A list of Tax Rate ids. These Tax * Rates will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -5506,7 +5506,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -5565,7 +5565,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -6000,7 +6000,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6154,7 +6154,7 @@ public Builder setRecurring( /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the * price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, * {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} diff --git a/src/main/java/com/stripe/param/SubscriptionSearchParams.java b/src/main/java/com/stripe/param/SubscriptionSearchParams.java index e3258640a08..27c01b19ac1 100644 --- a/src/main/java/com/stripe/param/SubscriptionSearchParams.java +++ b/src/main/java/com/stripe/param/SubscriptionSearchParams.java @@ -43,8 +43,8 @@ public class SubscriptionSearchParams extends ApiRequestParams { /** * Required. The search query string. See search query language and the - * list of supported query + * href="https://docs.stripe.com/search#search-query-language">search query language and the + * list of supported query * fields for subscriptions. */ @SerializedName("query") @@ -153,9 +153,9 @@ public Builder setPage(String page) { /** * Required. The search query string. See search query language and the + * href="https://docs.stripe.com/search#search-query-language">search query language and the * list of supported query fields for + * href="https://docs.stripe.com/search#query-fields-for-subscriptions">query fields for * subscriptions. */ public Builder setQuery(String query) { diff --git a/src/main/java/com/stripe/param/SubscriptionUpdateParams.java b/src/main/java/com/stripe/param/SubscriptionUpdateParams.java index 747315bdaa1..6a7d6ce9e85 100644 --- a/src/main/java/com/stripe/param/SubscriptionUpdateParams.java +++ b/src/main/java/com/stripe/param/SubscriptionUpdateParams.java @@ -53,7 +53,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * Either {@code now} or {@code unchanged}. Setting the value to {@code now} resets the * subscription's billing cycle anchor to the current time (in UTC). For more information, see the * billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ @SerializedName("billing_cycle_anchor") BillingCycleAnchor billingCycleAnchor; @@ -110,9 +110,9 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * ID of the default payment method for the subscription. It must belong to the customer * associated with the subscription. This takes precedence over {@code default_source}. If neither * are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_payment_method") Object defaultPaymentMethod; @@ -122,9 +122,9 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * associated with the subscription and be in a chargeable state. If {@code * default_payment_method} is also set, {@code default_payment_method} will take precedence. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ @SerializedName("default_source") Object defaultSource; @@ -174,7 +174,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { List items; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -196,7 +196,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ @SerializedName("pause_collection") @@ -207,20 +207,20 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. This * allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. When + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. When * you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -239,7 +239,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ @SerializedName("pending_invoice_item_interval") @@ -251,7 +251,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { /** * Determines how to handle prorations when the billing + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the billing * cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, or * starting a trial), or if an item's {@code quantity} changes. The default value is {@code * create_prorations}. @@ -292,7 +292,7 @@ public class SubscriptionUpdateParams extends ApiRequestParams { * 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") @@ -577,7 +577,7 @@ public Builder setBillingCadence(EmptyParam billingCadence) { * Either {@code now} or {@code unchanged}. Setting the value to {@code now} resets the * subscription's billing cycle anchor to the current time (in UTC). For more information, see * the billing cycle documentation. + * href="https://docs.stripe.com/billing/subscriptions/billing-cycle">documentation. */ public Builder setBillingCycleAnchor( SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor) { @@ -719,9 +719,9 @@ public Builder setDaysUntilDue(Long daysUntilDue) { * ID of the default payment method for the subscription. It must belong to the customer * associated with the subscription. This takes precedence over {@code default_source}. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { this.defaultPaymentMethod = defaultPaymentMethod; @@ -732,9 +732,9 @@ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { * ID of the default payment method for the subscription. It must belong to the customer * associated with the subscription. This takes precedence over {@code default_source}. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod) { this.defaultPaymentMethod = defaultPaymentMethod; @@ -746,9 +746,9 @@ public Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod) { * associated with the subscription and be in a chargeable state. If {@code * default_payment_method} is also set, {@code default_payment_method} will take precedence. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultSource(String defaultSource) { this.defaultSource = defaultSource; @@ -760,9 +760,9 @@ public Builder setDefaultSource(String defaultSource) { * associated with the subscription and be in a chargeable state. If {@code * default_payment_method} is also set, {@code default_payment_method} will take precedence. If * neither are set, invoices will use the customer's invoice_settings.default_payment_method + * href="https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method">invoice_settings.default_payment_method * or default_source. + * href="https://docs.stripe.com/api/customers/object#customer_object-default_source">default_source. */ public Builder setDefaultSource(EmptyParam defaultSource) { this.defaultSource = defaultSource; @@ -996,7 +996,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1007,7 +1007,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1041,7 +1041,7 @@ public Builder setOnBehalfOf(EmptyParam onBehalfOf) { /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ public Builder setPauseCollection(SubscriptionUpdateParams.PauseCollection pauseCollection) { @@ -1052,7 +1052,7 @@ public Builder setPauseCollection(SubscriptionUpdateParams.PauseCollection pause /** * If specified, payment collection for this subscription will be paused. Note that the * subscription status will be unchanged and will not be updated to {@code paused}. Learn more - * about pausing + * about pausing * collection. */ public Builder setPauseCollection(EmptyParam pauseCollection) { @@ -1065,20 +1065,20 @@ public Builder setPauseCollection(EmptyParam pauseCollection) { * payment is required but cannot be paid. This allows you to manage scenarios where additional * user actions are needed to pay a subscription's invoice. For example, SCA regulation may * require 3DS authentication to complete payment. See the SCA Migration + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA Migration * Guide for Billing to learn more. This is the default behavior. * *

Use {@code default_incomplete} to transition the subscription to {@code status=past_due} * when payment is required and await explicit confirmation of the invoice's payment intent. * This allows simpler management of scenarios where additional user actions are needed to pay a * subscription’s invoice. Such as failed payments, SCA + * href="https://docs.stripe.com/billing/migration/strong-customer-authentication">SCA * regulation, or collecting a mandate for a bank debit payment method. * *

Use {@code pending_if_incomplete} to update the subscription using pending updates. + * href="https://docs.stripe.com/billing/subscriptions/pending-updates">pending updates. * When you use {@code pending_if_incomplete} you can only pass the parameters supported + * href="https://docs.stripe.com/billing/pending-updates-reference#supported-attributes">supported * by pending updates. * *

Use {@code error_if_incomplete} if you want Stripe to return an HTTP 402 status code if a @@ -1101,7 +1101,7 @@ public Builder setPaymentSettings(SubscriptionUpdateParams.PaymentSettings payme /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval( @@ -1112,7 +1112,7 @@ public Builder setPendingInvoiceItemInterval( /** * Specifies an interval for how often to bill for any pending invoice items. It is analogous to - * calling Create an invoice for the + * calling Create an invoice for the * given subscription at the specified interval. */ public Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval) { @@ -1128,7 +1128,7 @@ public Builder setPrebilling(SubscriptionUpdateParams.Prebilling prebilling) { /** * Determines how to handle prorations when the + * href="https://docs.stripe.com/billing/subscriptions/prorations">prorations when the * billing cycle changes (e.g., when switching plans, resetting {@code * billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes. * The default value is {@code create_prorations}. @@ -1202,7 +1202,7 @@ public Builder setTrialEnd(Long trialEnd) { * 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. */ public Builder setTrialFromPlan(Boolean trialFromPlan) { @@ -1234,7 +1234,7 @@ public static class AddInvoiceItem { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1255,7 +1255,7 @@ public static class AddInvoiceItem { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -1428,7 +1428,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(SubscriptionUpdateParams.AddInvoiceItem.PriceData priceData) { @@ -2213,7 +2213,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2350,7 +2350,7 @@ public Builder setProduct(EmptyParam product) { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -3996,7 +3996,7 @@ public static class Item { Object 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -4017,7 +4017,7 @@ public static class Item { Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -4028,9 +4028,9 @@ public static class Item { Long quantity; /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4263,7 +4263,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -4274,7 +4274,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -4317,7 +4317,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(SubscriptionUpdateParams.Item.PriceData priceData) { @@ -4360,9 +4360,9 @@ public Builder addAllTaxRate(List elements) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4372,9 +4372,9 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * A list of Tax Rate ids. These Tax Rates + * A list of Tax Rate ids. These Tax Rates * will override the {@code + * href="https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates">{@code * default_tax_rates} on the Subscription. When updating, pass an empty string to remove * previously-defined tax rates. */ @@ -4399,7 +4399,7 @@ public static class BillingThresholds { /** * Required. Number of units that meets the billing threshold to advance the * subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ @SerializedName("usage_gte") @@ -4456,7 +4456,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Number of units that meets the billing threshold to advance * the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary + * href="https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte">monetary * threshold) */ public Builder setUsageGte(Long usageGte) { @@ -4985,7 +4985,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -5136,7 +5136,7 @@ public Builder setRecurring(SubscriptionUpdateParams.Item.PriceData.Recurring re /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -5660,6 +5660,13 @@ public static class PaymentMethodOptions { @SerializedName("konbini") Object konbini; + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + @SerializedName("payto") + Object payto; + /** * This sub-hash contains details about the Pix payment method options to pass to the * invoice’s PaymentIntent. @@ -5696,6 +5703,7 @@ private PaymentMethodOptions( Map extraParams, Object idBankTransfer, Object konbini, + Object payto, Object pix, Object sepaDebit, Object upi, @@ -5707,6 +5715,7 @@ private PaymentMethodOptions( this.extraParams = extraParams; this.idBankTransfer = idBankTransfer; this.konbini = konbini; + this.payto = payto; this.pix = pix; this.sepaDebit = sepaDebit; this.upi = upi; @@ -5732,6 +5741,8 @@ public static class Builder { private Object konbini; + private Object payto; + private Object pix; private Object sepaDebit; @@ -5750,6 +5761,7 @@ public SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions build() { this.extraParams, this.idBankTransfer, this.konbini, + this.payto, this.pix, this.sepaDebit, this.upi, @@ -5902,6 +5914,25 @@ public Builder setKonbini(EmptyParam konbini) { return this; } + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + public Builder setPayto( + SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto payto) { + this.payto = payto; + return this; + } + + /** + * This sub-hash contains details about the PayTo payment method options to pass to the + * invoice’s PaymentIntent. + */ + public Builder setPayto(EmptyParam payto) { + this.payto = payto; + return this; + } + /** * This sub-hash contains details about the Pix payment method options to pass to the * invoice’s PaymentIntent. @@ -6321,10 +6352,10 @@ public static class Card { /** * 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. */ @@ -6412,10 +6443,10 @@ public Builder setNetwork( /** * 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. */ @@ -7087,6 +7118,230 @@ public Builder putAllExtraParam(Map map) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Payto { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Additional fields for Mandate creation. */ + @SerializedName("mandate_options") + MandateOptions mandateOptions; + + private Payto(Map extraParams, MandateOptions mandateOptions) { + this.extraParams = extraParams; + this.mandateOptions = mandateOptions; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private MandateOptions mandateOptions; + + /** Finalize and obtain parameter instance from this builder. */ + public SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto build() { + return new SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto( + this.extraParams, this.mandateOptions); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for + * the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto#extraParams} for + * the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Additional fields for Mandate creation. */ + public Builder setMandateOptions( + SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + mandateOptions) { + this.mandateOptions = mandateOptions; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class MandateOptions { + /** + * 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; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + @SerializedName("purpose") + Purpose purpose; + + private MandateOptions(Long amount, Map extraParams, Purpose purpose) { + this.amount = amount; + this.extraParams = extraParams; + this.purpose = purpose; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Long amount; + + private Map extraParams; + + private Purpose purpose; + + /** Finalize and obtain parameter instance from this builder. */ + public SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions + build() { + return new SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto + .MandateOptions(this.amount, this.extraParams, this.purpose); + } + + /** + * The maximum amount that can be collected in a single invoice. If you don't specify a + * maximum, then there is no limit. + */ + public Builder setAmount(Long amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose( + SubscriptionUpdateParams.PaymentSettings.PaymentMethodOptions.Payto.MandateOptions + .Purpose + purpose) { + this.purpose = purpose; + return this; + } + } + + public enum Purpose implements ApiRequestParams.EnumParam { + @SerializedName("dependant_support") + DEPENDANT_SUPPORT("dependant_support"), + + @SerializedName("government") + GOVERNMENT("government"), + + @SerializedName("loan") + LOAN("loan"), + + @SerializedName("mortgage") + MORTGAGE("mortgage"), + + @SerializedName("other") + OTHER("other"), + + @SerializedName("pension") + PENSION("pension"), + + @SerializedName("personal") + PERSONAL("personal"), + + @SerializedName("retail") + RETAIL("retail"), + + @SerializedName("salary") + SALARY("salary"), + + @SerializedName("tax") + TAX("tax"), + + @SerializedName("utility") + UTILITY("utility"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Purpose(String value) { + this.value = value; + } + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Pix { @@ -8274,6 +8529,9 @@ public enum PaymentMethodType implements ApiRequestParams.EnumParam { @SerializedName("paypal") PAYPAL("paypal"), + @SerializedName("payto") + PAYTO("payto"), + @SerializedName("pix") PIX("pix"), diff --git a/src/main/java/com/stripe/param/TaxIdCreateParams.java b/src/main/java/com/stripe/param/TaxIdCreateParams.java index d1114c2b782..f0e76ac3d39 100644 --- a/src/main/java/com/stripe/param/TaxIdCreateParams.java +++ b/src/main/java/com/stripe/param/TaxIdCreateParams.java @@ -185,7 +185,7 @@ public Builder setValue(String value) { @Getter @EqualsAndHashCode(callSuper = false) public static class Owner { - /** Account the tax ID belongs to. Required when {@code type=account} */ + /** Connected Account the tax ID belongs to. Required when {@code type=account} */ @SerializedName("account") String account; @@ -194,8 +194,8 @@ public static class Owner { String customer; /** - * v2 Account the tax ID belongs to. Can be used in place of {@code customer} when {@code - * type=customer} + * ID of the Account representing the customer that the tax ID belongs to. Can be used in place + * of {@code customer} when {@code type=customer} */ @SerializedName("customer_account") String customerAccount; @@ -247,7 +247,7 @@ public TaxIdCreateParams.Owner build() { this.account, this.customer, this.customerAccount, this.extraParams, this.type); } - /** Account the tax ID belongs to. Required when {@code type=account} */ + /** Connected Account the tax ID belongs to. Required when {@code type=account} */ public Builder setAccount(String account) { this.account = account; return this; @@ -260,8 +260,8 @@ public Builder setCustomer(String customer) { } /** - * v2 Account the tax ID belongs to. Can be used in place of {@code customer} when {@code - * type=customer} + * ID of the Account representing the customer that the tax ID belongs to. Can be used in + * place of {@code customer} when {@code type=customer} */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; diff --git a/src/main/java/com/stripe/param/TaxIdListParams.java b/src/main/java/com/stripe/param/TaxIdListParams.java index 332b060cbda..464d1aa6dac 100644 --- a/src/main/java/com/stripe/param/TaxIdListParams.java +++ b/src/main/java/com/stripe/param/TaxIdListParams.java @@ -191,7 +191,7 @@ public Builder setStartingAfter(String startingAfter) { @Getter @EqualsAndHashCode(callSuper = false) public static class Owner { - /** Account the tax ID belongs to. Required when {@code type=account} */ + /** Connected Account the tax ID belongs to. Required when {@code type=account} */ @SerializedName("account") String account; @@ -200,8 +200,8 @@ public static class Owner { String customer; /** - * v2 Account the tax ID belongs to. Can be used in place of {@code customer} when {@code - * type=customer} + * ID of the Account representing the customer that the tax ID belongs to. Can be used in place + * of {@code customer} when {@code type=customer} */ @SerializedName("customer_account") String customerAccount; @@ -253,7 +253,7 @@ public TaxIdListParams.Owner build() { this.account, this.customer, this.customerAccount, this.extraParams, this.type); } - /** Account the tax ID belongs to. Required when {@code type=account} */ + /** Connected Account the tax ID belongs to. Required when {@code type=account} */ public Builder setAccount(String account) { this.account = account; return this; @@ -266,8 +266,8 @@ public Builder setCustomer(String customer) { } /** - * v2 Account the tax ID belongs to. Can be used in place of {@code customer} when {@code - * type=customer} + * ID of the Account representing the customer that the tax ID belongs to. Can be used in + * place of {@code customer} when {@code type=customer} */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; diff --git a/src/main/java/com/stripe/param/TaxRateCreateParams.java b/src/main/java/com/stripe/param/TaxRateCreateParams.java index bdff4e936dc..ab45cf45776 100644 --- a/src/main/java/com/stripe/param/TaxRateCreateParams.java +++ b/src/main/java/com/stripe/param/TaxRateCreateParams.java @@ -65,7 +65,7 @@ public class TaxRateCreateParams extends ApiRequestParams { String jurisdiction; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TaxRateUpdateParams.java b/src/main/java/com/stripe/param/TaxRateUpdateParams.java index a2146a8c87d..af68f049e23 100644 --- a/src/main/java/com/stripe/param/TaxRateUpdateParams.java +++ b/src/main/java/com/stripe/param/TaxRateUpdateParams.java @@ -61,7 +61,7 @@ public class TaxRateUpdateParams extends ApiRequestParams { Object jurisdiction; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -300,7 +300,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -311,7 +311,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TokenCreateParams.java b/src/main/java/com/stripe/param/TokenCreateParams.java index 2ce8bb322b9..4a79881c8ce 100644 --- a/src/main/java/com/stripe/param/TokenCreateParams.java +++ b/src/main/java/com/stripe/param/TokenCreateParams.java @@ -33,9 +33,9 @@ public class TokenCreateParams extends ApiRequestParams { /** * Create a token for the customer, which is owned by the application's account. You can only use - * this with an OAuth access token - * or Stripe-Account header. Learn - * more about cloning + * this with an OAuth access token + * or Stripe-Account header. Learn + * more about cloning * saved payment methods. */ @SerializedName("customer") @@ -158,10 +158,10 @@ public Builder setCard(String card) { /** * Create a token for the customer, which is owned by the application's account. You can only - * use this with an OAuth access - * token or Stripe-Account + * use this with an OAuth access + * token or Stripe-Account * header. Learn more about cloning saved payment + * href="https://docs.stripe.com/connect/cloning-saved-payment-methods">cloning saved payment * methods. */ public Builder setCustomer(String customer) { @@ -964,7 +964,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -1077,7 +1080,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1921,11 +1927,10 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ @SerializedName("back") String back; @@ -1941,11 +1946,10 @@ public static class Document { Map extraParams; /** - * The front of a document returned by a file upload with a {@code purpose} - * value of {@code additional_verification}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of a document returned by a file + * upload with a {@code purpose} value of {@code additional_verification}. The + * uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, + * or PDF format, and less than 10 MB in size. */ @SerializedName("front") String front; @@ -1975,7 +1979,7 @@ public TokenCreateParams.Account.Company.Verification.Document build() { /** * The back of a document returned by a file upload with a {@code purpose} + * href="https://api.stripe.com#create_file">file upload with a {@code purpose} * value of {@code additional_verification}. The uploaded file needs to be a color image * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in * size. @@ -2017,7 +2021,7 @@ public Builder putAllExtraParam(Map map) { /** * The front of a document returned by a file upload with a {@code purpose} + * href="https://api.stripe.com#create_file">file upload with a {@code purpose} * value of {@code additional_verification}. The uploaded file needs to be a color image * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in * size. @@ -2214,7 +2218,7 @@ public static class Individual { String maidenName; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2612,7 +2616,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -2623,7 +2627,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -2729,7 +2733,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -2842,7 +2849,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3329,7 +3339,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -3442,7 +3455,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -3912,7 +3928,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -3931,7 +3947,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -3963,11 +3979,10 @@ public TokenCreateParams.Account.Individual.Verification.AdditionalDocument buil } /** - * The back of an ID returned by a file upload with a {@code purpose} - * value of {@code identity_document}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -4005,11 +4020,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file upload with a {@code purpose} - * value of {@code identity_document}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -4022,7 +4036,7 @@ public Builder setFront(String front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -4041,7 +4055,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -4073,11 +4087,10 @@ public TokenCreateParams.Account.Individual.Verification.Document build() { } /** - * The back of an ID returned by a file upload with a {@code purpose} - * value of {@code identity_document}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The back of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ public Builder setBack(String back) { this.back = back; @@ -4115,11 +4128,10 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file upload with a {@code purpose} - * value of {@code identity_document}. The uploaded file needs to be a color image - * (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in - * size. + * The front of an ID returned by a file + * upload with a {@code purpose} value of {@code identity_document}. The uploaded + * file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF + * format, and less than 10 MB in size. */ public Builder setFront(String front) { this.front = front; @@ -4204,7 +4216,7 @@ public static class BankAccount { /** * The currency the bank account is in. This must be a country/currency pairing that Stripe supports. + * href="https://docs.stripe.com/payouts">Stripe supports. */ @SerializedName("currency") String currency; @@ -4342,7 +4354,7 @@ public Builder setCountry(String country) { /** * The currency the bank account is in. This must be a country/currency pairing that Stripe supports. + * href="https://docs.stripe.com/payouts">Stripe supports. */ public Builder setCurrency(String currency) { this.currency = currency; @@ -4969,7 +4981,7 @@ public static class Person { String maidenName; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -5410,7 +5422,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -5421,7 +5433,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -5735,7 +5747,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -5848,7 +5863,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -6424,9 +6442,8 @@ public static class CompanyAuthorization { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} - * value of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -6523,9 +6540,8 @@ public static class Passport { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} - * value of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -6619,9 +6635,8 @@ public static class Visa { Map extraParams; /** - * One or more document ids returned by a file upload with a {@code purpose} - * value of {@code account_requirement}. + * One or more document ids returned by a file + * upload with a {@code purpose} value of {@code account_requirement}. */ @SerializedName("files") List files; @@ -6737,7 +6752,10 @@ public static class RegisteredAddress { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -6850,7 +6868,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -7804,7 +7825,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class AdditionalDocument { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -7823,7 +7844,7 @@ public static class AdditionalDocument { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -7855,7 +7876,7 @@ public TokenCreateParams.Person.Verification.AdditionalDocument build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -7894,7 +7915,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -7910,7 +7931,7 @@ public Builder setFront(String front) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -7929,7 +7950,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, * and less than 10 MB in size. @@ -7961,7 +7982,7 @@ public TokenCreateParams.Person.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. @@ -8000,7 +8021,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. The uploaded file * needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF * format, and less than 10 MB in size. diff --git a/src/main/java/com/stripe/param/TopupCreateParams.java b/src/main/java/com/stripe/param/TopupCreateParams.java index 4c0ea457597..2cfecf1c0a4 100644 --- a/src/main/java/com/stripe/param/TopupCreateParams.java +++ b/src/main/java/com/stripe/param/TopupCreateParams.java @@ -44,7 +44,7 @@ public class TopupCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -56,7 +56,7 @@ public class TopupCreateParams extends ApiRequestParams { * The ID of a source to transfer funds from. For most users, this should be left unspecified * which will use the bank account that was set up in the dashboard for the specified currency. In * test mode, this can be a test bank token (see Testing Top-ups). + * href="https://docs.stripe.com/connect/testing#testing-top-ups">Testing Top-ups). */ @SerializedName("source") String source; @@ -233,7 +233,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -244,7 +244,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -258,7 +258,7 @@ public Builder setMetadata(Map metadata) { * The ID of a source to transfer funds from. For most users, this should be left unspecified * which will use the bank account that was set up in the dashboard for the specified currency. * In test mode, this can be a test bank token (see Testing Top-ups). + * href="https://docs.stripe.com/connect/testing#testing-top-ups">Testing Top-ups). */ public Builder setSource(String source) { this.source = source; diff --git a/src/main/java/com/stripe/param/TopupUpdateParams.java b/src/main/java/com/stripe/param/TopupUpdateParams.java index 0692ceef223..54e8fb511b7 100644 --- a/src/main/java/com/stripe/param/TopupUpdateParams.java +++ b/src/main/java/com/stripe/param/TopupUpdateParams.java @@ -32,7 +32,7 @@ public class TopupUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -159,7 +159,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -170,7 +170,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TransferCreateParams.java b/src/main/java/com/stripe/param/TransferCreateParams.java index 3379e80cc42..48623c8c385 100644 --- a/src/main/java/com/stripe/param/TransferCreateParams.java +++ b/src/main/java/com/stripe/param/TransferCreateParams.java @@ -61,7 +61,7 @@ public class TransferCreateParams extends ApiRequestParams { String fxQuote; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -73,7 +73,7 @@ public class TransferCreateParams extends ApiRequestParams { * You can use this parameter to transfer funds from a charge before they are added to your * available balance. A pending balance will transfer immediately but the funds will not become * available until the original charge becomes available. See + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability">See * the Connect documentation for details. */ @SerializedName("source_transaction") @@ -88,7 +88,7 @@ public class TransferCreateParams extends ApiRequestParams { /** * 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") @@ -295,7 +295,7 @@ public Builder putAllMetadata(Map map) { * You can use this parameter to transfer funds from a charge before they are added to your * available balance. A pending balance will transfer immediately but the funds will not become * available until the original charge becomes available. See + * href="https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability">See * the Connect documentation for details. */ public Builder setSourceTransaction(String sourceTransaction) { @@ -314,7 +314,7 @@ public Builder setSourceType(TransferCreateParams.SourceType sourceType) { /** * 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. */ public Builder setTransferGroup(String transferGroup) { diff --git a/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java b/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java index dae32f3cc10..d39d1d3b03a 100644 --- a/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java +++ b/src/main/java/com/stripe/param/TransferReversalCollectionCreateParams.java @@ -44,7 +44,7 @@ public class TransferReversalCollectionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -205,7 +205,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -216,7 +216,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TransferReversalCreateParams.java b/src/main/java/com/stripe/param/TransferReversalCreateParams.java index 6fe0aff4aff..bd83415cbac 100644 --- a/src/main/java/com/stripe/param/TransferReversalCreateParams.java +++ b/src/main/java/com/stripe/param/TransferReversalCreateParams.java @@ -44,7 +44,7 @@ public class TransferReversalCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -205,7 +205,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -216,7 +216,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TransferReversalUpdateParams.java b/src/main/java/com/stripe/param/TransferReversalUpdateParams.java index 6d2d06ff154..05f8200e6c9 100644 --- a/src/main/java/com/stripe/param/TransferReversalUpdateParams.java +++ b/src/main/java/com/stripe/param/TransferReversalUpdateParams.java @@ -28,7 +28,7 @@ public class TransferReversalUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/TransferUpdateParams.java b/src/main/java/com/stripe/param/TransferUpdateParams.java index f845d8e5b0a..8ee8386f521 100644 --- a/src/main/java/com/stripe/param/TransferUpdateParams.java +++ b/src/main/java/com/stripe/param/TransferUpdateParams.java @@ -32,7 +32,7 @@ public class TransferUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -160,7 +160,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -171,7 +171,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java b/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java index 7fa9aa99962..38cabad42b5 100644 --- a/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java +++ b/src/main/java/com/stripe/param/WebhookEndpointCreateParams.java @@ -53,7 +53,7 @@ public class WebhookEndpointCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -255,7 +255,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -266,7 +266,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -636,7 +636,10 @@ public enum ApiVersion implements ApiRequestParams.EnumParam { VERSION_2025_10_29_CLOVER("2025-10-29.clover"), @SerializedName("2025-11-17.clover") - VERSION_2025_11_17_CLOVER("2025-11-17.clover"); + VERSION_2025_11_17_CLOVER("2025-11-17.clover"), + + @SerializedName("2025-12-15.clover") + VERSION_2025_12_15_CLOVER("2025-12-15.clover"); @Getter(onMethod_ = {@Override}) private final String value; diff --git a/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java b/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java index 1d27cf566ad..db69d1967f6 100644 --- a/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java +++ b/src/main/java/com/stripe/param/WebhookEndpointUpdateParams.java @@ -43,7 +43,7 @@ public class WebhookEndpointUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -228,7 +228,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -239,7 +239,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/billing/CreditBalanceSummaryRetrieveParams.java b/src/main/java/com/stripe/param/billing/CreditBalanceSummaryRetrieveParams.java index 7c8dc7df7f0..441fbbbd828 100644 --- a/src/main/java/com/stripe/param/billing/CreditBalanceSummaryRetrieveParams.java +++ b/src/main/java/com/stripe/param/billing/CreditBalanceSummaryRetrieveParams.java @@ -13,11 +13,11 @@ @Getter @EqualsAndHashCode(callSuper = false) public class CreditBalanceSummaryRetrieveParams extends ApiRequestParams { - /** The customer for which to fetch credit balance summary. */ + /** The customer whose credit balance summary you're retrieving. */ @SerializedName("customer") String customer; - /** The account for which to fetch credit balance summary. */ + /** The account representing the customer whose credit balance summary you're retrieving. */ @SerializedName("customer_account") String customerAccount; @@ -72,13 +72,13 @@ public CreditBalanceSummaryRetrieveParams build() { this.customer, this.customerAccount, this.expand, this.extraParams, this.filter); } - /** The customer for which to fetch credit balance summary. */ + /** The customer whose credit balance summary you're retrieving. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The account for which to fetch credit balance summary. */ + /** The account representing the customer whose credit balance summary you're retrieving. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/billing/CreditBalanceTransactionListParams.java b/src/main/java/com/stripe/param/billing/CreditBalanceTransactionListParams.java index ed6f0d804c1..b223162d26a 100644 --- a/src/main/java/com/stripe/param/billing/CreditBalanceTransactionListParams.java +++ b/src/main/java/com/stripe/param/billing/CreditBalanceTransactionListParams.java @@ -17,11 +17,11 @@ public class CreditBalanceTransactionListParams extends ApiRequestParams { @SerializedName("credit_grant") String creditGrant; - /** The customer for which to fetch credit balance transactions. */ + /** The customer whose credit balance transactions you're retrieving. */ @SerializedName("customer") String customer; - /** The account for which to fetch credit balance transactions. */ + /** The account representing the customer whose credit balance transactions you're retrieving. */ @SerializedName("customer_account") String customerAccount; @@ -122,13 +122,15 @@ public Builder setCreditGrant(String creditGrant) { return this; } - /** The customer for which to fetch credit balance transactions. */ + /** The customer whose credit balance transactions you're retrieving. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The account for which to fetch credit balance transactions. */ + /** + * The account representing the customer whose credit balance transactions you're retrieving. + */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/billing/CreditGrantCreateParams.java b/src/main/java/com/stripe/param/billing/CreditGrantCreateParams.java index fe05add3b62..f6e7da7e4cc 100644 --- a/src/main/java/com/stripe/param/billing/CreditGrantCreateParams.java +++ b/src/main/java/com/stripe/param/billing/CreditGrantCreateParams.java @@ -30,11 +30,11 @@ public class CreditGrantCreateParams extends ApiRequestParams { @SerializedName("category") Category category; - /** ID of the customer to receive the billing credits. */ + /** ID of the customer receiving the billing credits. */ @SerializedName("customer") String customer; - /** ID of the account to receive the billing credits. */ + /** ID of the account representing the customer receiving the billing credits. */ @SerializedName("customer_account") String customerAccount; @@ -178,13 +178,13 @@ public Builder setCategory(CreditGrantCreateParams.Category category) { return this; } - /** ID of the customer to receive the billing credits. */ + /** ID of the customer receiving the billing credits. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** ID of the account to receive the billing credits. */ + /** ID of the account representing the customer receiving the billing credits. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/billing/CreditGrantListParams.java b/src/main/java/com/stripe/param/billing/CreditGrantListParams.java index f7af7bea382..59c467094b0 100644 --- a/src/main/java/com/stripe/param/billing/CreditGrantListParams.java +++ b/src/main/java/com/stripe/param/billing/CreditGrantListParams.java @@ -17,7 +17,7 @@ public class CreditGrantListParams extends ApiRequestParams { @SerializedName("customer") String customer; - /** Only return credit grants for this account. */ + /** Only return credit grants for this account representing the customer. */ @SerializedName("customer_account") String customerAccount; @@ -113,7 +113,7 @@ public Builder setCustomer(String customer) { return this; } - /** Only return credit grants for this account. */ + /** Only return credit grants for this account representing the customer. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/billing/MeterEventCreateParams.java b/src/main/java/com/stripe/param/billing/MeterEventCreateParams.java index 837fda2b22a..85b5afa8cd0 100644 --- a/src/main/java/com/stripe/param/billing/MeterEventCreateParams.java +++ b/src/main/java/com/stripe/param/billing/MeterEventCreateParams.java @@ -47,7 +47,7 @@ public class MeterEventCreateParams extends ApiRequestParams { * Required. The payload of the event. This must contain the fields corresponding * to a meter's {@code customer_mapping.event_payload_key} (default is {@code stripe_customer_id}) * and {@code value_settings.event_payload_key} (default is {@code value}). Read more about the payload. + * href="https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes">payload. */ @SerializedName("payload") Map payload; diff --git a/src/main/java/com/stripe/param/billingportal/ConfigurationCreateParams.java b/src/main/java/com/stripe/param/billingportal/ConfigurationCreateParams.java index 2b6d5ac1d0f..84478490051 100644 --- a/src/main/java/com/stripe/param/billingportal/ConfigurationCreateParams.java +++ b/src/main/java/com/stripe/param/billingportal/ConfigurationCreateParams.java @@ -21,7 +21,7 @@ public class ConfigurationCreateParams extends ApiRequestParams { /** * The default URL to redirect customers to when they click on the portal's link to return to your * website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ @SerializedName("default_return_url") @@ -53,7 +53,7 @@ public class ConfigurationCreateParams extends ApiRequestParams { LoginPage loginPage; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -127,7 +127,7 @@ public Builder setBusinessProfile(ConfigurationCreateParams.BusinessProfile busi /** * The default URL to redirect customers to when they click on the portal's link to return to * your website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ public Builder setDefaultReturnUrl(String defaultReturnUrl) { @@ -138,7 +138,7 @@ public Builder setDefaultReturnUrl(String defaultReturnUrl) { /** * The default URL to redirect customers to when they click on the portal's link to return to * your website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ public Builder setDefaultReturnUrl(EmptyParam defaultReturnUrl) { @@ -1205,6 +1205,16 @@ public enum ProrationBehavior implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class SubscriptionUpdate { + /** + * Determines the value to use for the billing cycle anchor on subscription updates. Valid + * values are {@code now} or {@code unchanged}, and the default value is {@code unchanged}. + * Setting the value to {@code now} resets the subscription's billing cycle anchor to the + * current time (in UTC). For more information, see the billing cycle documentation. + */ + @SerializedName("billing_cycle_anchor") + BillingCycleAnchor billingCycleAnchor; + /** * The types of subscription updates that are supported. When empty, subscriptions are not * updateable. @@ -1248,6 +1258,7 @@ public static class SubscriptionUpdate { TrialUpdateBehavior trialUpdateBehavior; private SubscriptionUpdate( + BillingCycleAnchor billingCycleAnchor, Object defaultAllowedUpdates, Boolean enabled, Map extraParams, @@ -1255,6 +1266,7 @@ private SubscriptionUpdate( ProrationBehavior prorationBehavior, ScheduleAtPeriodEnd scheduleAtPeriodEnd, TrialUpdateBehavior trialUpdateBehavior) { + this.billingCycleAnchor = billingCycleAnchor; this.defaultAllowedUpdates = defaultAllowedUpdates; this.enabled = enabled; this.extraParams = extraParams; @@ -1269,6 +1281,8 @@ public static Builder builder() { } public static class Builder { + private BillingCycleAnchor billingCycleAnchor; + private Object defaultAllowedUpdates; private Boolean enabled; @@ -1286,6 +1300,7 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public ConfigurationCreateParams.Features.SubscriptionUpdate build() { return new ConfigurationCreateParams.Features.SubscriptionUpdate( + this.billingCycleAnchor, this.defaultAllowedUpdates, this.enabled, this.extraParams, @@ -1295,6 +1310,20 @@ public ConfigurationCreateParams.Features.SubscriptionUpdate build() { this.trialUpdateBehavior); } + /** + * Determines the value to use for the billing cycle anchor on subscription updates. Valid + * values are {@code now} or {@code unchanged}, and the default value is {@code unchanged}. + * Setting the value to {@code now} resets the subscription's billing cycle anchor to the + * current time (in UTC). For more information, see the billing cycle documentation. + */ + public Builder setBillingCycleAnchor( + ConfigurationCreateParams.Features.SubscriptionUpdate.BillingCycleAnchor + billingCycleAnchor) { + this.billingCycleAnchor = billingCycleAnchor; + return this; + } + /** * Add an element to `defaultAllowedUpdates` list. A list is initialized for the first * `add/addAll` call, and subsequent calls adds additional elements to the original list. @@ -1923,6 +1952,21 @@ public enum Type implements ApiRequestParams.EnumParam { } } + public enum BillingCycleAnchor implements ApiRequestParams.EnumParam { + @SerializedName("now") + NOW("now"), + + @SerializedName("unchanged") + UNCHANGED("unchanged"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + BillingCycleAnchor(String value) { + this.value = value; + } + } + public enum DefaultAllowedUpdate implements ApiRequestParams.EnumParam { @SerializedName("price") PRICE("price"), @@ -1981,7 +2025,7 @@ public enum TrialUpdateBehavior implements ApiRequestParams.EnumParam { public static class LoginPage { /** * Required. Set to {@code true} to generate a shareable URL {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url">{@code * login_page.url} that will take your customers to a hosted login page for the customer * portal. */ @@ -2018,7 +2062,7 @@ public ConfigurationCreateParams.LoginPage build() { /** * Required. Set to {@code true} to generate a shareable URL {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url">{@code * login_page.url} that will take your customers to a hosted login page for the customer * portal. */ diff --git a/src/main/java/com/stripe/param/billingportal/ConfigurationUpdateParams.java b/src/main/java/com/stripe/param/billingportal/ConfigurationUpdateParams.java index cc2c2da7c24..ace7cc763f7 100644 --- a/src/main/java/com/stripe/param/billingportal/ConfigurationUpdateParams.java +++ b/src/main/java/com/stripe/param/billingportal/ConfigurationUpdateParams.java @@ -25,7 +25,7 @@ public class ConfigurationUpdateParams extends ApiRequestParams { /** * The default URL to redirect customers to when they click on the portal's link to return to your * website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ @SerializedName("default_return_url") @@ -57,7 +57,7 @@ public class ConfigurationUpdateParams extends ApiRequestParams { LoginPage loginPage; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -142,7 +142,7 @@ public Builder setBusinessProfile(ConfigurationUpdateParams.BusinessProfile busi /** * The default URL to redirect customers to when they click on the portal's link to return to * your website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ public Builder setDefaultReturnUrl(String defaultReturnUrl) { @@ -153,7 +153,7 @@ public Builder setDefaultReturnUrl(String defaultReturnUrl) { /** * The default URL to redirect customers to when they click on the portal's link to return to * your website. This can be overriden + * href="https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url">overriden * when creating the session. */ public Builder setDefaultReturnUrl(EmptyParam defaultReturnUrl) { @@ -259,7 +259,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -270,7 +270,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1247,6 +1247,16 @@ public enum ProrationBehavior implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class SubscriptionUpdate { + /** + * Determines the value to use for the billing cycle anchor on subscription updates. Valid + * values are {@code now} or {@code unchanged}, and the default value is {@code unchanged}. + * Setting the value to {@code now} resets the subscription's billing cycle anchor to the + * current time (in UTC). For more information, see the billing cycle documentation. + */ + @SerializedName("billing_cycle_anchor") + BillingCycleAnchor billingCycleAnchor; + /** * The types of subscription updates that are supported. When empty, subscriptions are not * updateable. @@ -1290,6 +1300,7 @@ public static class SubscriptionUpdate { TrialUpdateBehavior trialUpdateBehavior; private SubscriptionUpdate( + BillingCycleAnchor billingCycleAnchor, Object defaultAllowedUpdates, Boolean enabled, Map extraParams, @@ -1297,6 +1308,7 @@ private SubscriptionUpdate( ProrationBehavior prorationBehavior, ScheduleAtPeriodEnd scheduleAtPeriodEnd, TrialUpdateBehavior trialUpdateBehavior) { + this.billingCycleAnchor = billingCycleAnchor; this.defaultAllowedUpdates = defaultAllowedUpdates; this.enabled = enabled; this.extraParams = extraParams; @@ -1311,6 +1323,8 @@ public static Builder builder() { } public static class Builder { + private BillingCycleAnchor billingCycleAnchor; + private Object defaultAllowedUpdates; private Boolean enabled; @@ -1328,6 +1342,7 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public ConfigurationUpdateParams.Features.SubscriptionUpdate build() { return new ConfigurationUpdateParams.Features.SubscriptionUpdate( + this.billingCycleAnchor, this.defaultAllowedUpdates, this.enabled, this.extraParams, @@ -1337,6 +1352,20 @@ public ConfigurationUpdateParams.Features.SubscriptionUpdate build() { this.trialUpdateBehavior); } + /** + * Determines the value to use for the billing cycle anchor on subscription updates. Valid + * values are {@code now} or {@code unchanged}, and the default value is {@code unchanged}. + * Setting the value to {@code now} resets the subscription's billing cycle anchor to the + * current time (in UTC). For more information, see the billing cycle documentation. + */ + public Builder setBillingCycleAnchor( + ConfigurationUpdateParams.Features.SubscriptionUpdate.BillingCycleAnchor + billingCycleAnchor) { + this.billingCycleAnchor = billingCycleAnchor; + return this; + } + /** * Add an element to `defaultAllowedUpdates` list. A list is initialized for the first * `add/addAll` call, and subsequent calls adds additional elements to the original list. @@ -2000,6 +2029,21 @@ public enum Type implements ApiRequestParams.EnumParam { } } + public enum BillingCycleAnchor implements ApiRequestParams.EnumParam { + @SerializedName("now") + NOW("now"), + + @SerializedName("unchanged") + UNCHANGED("unchanged"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + BillingCycleAnchor(String value) { + this.value = value; + } + } + public enum DefaultAllowedUpdate implements ApiRequestParams.EnumParam { @SerializedName("price") PRICE("price"), @@ -2058,7 +2102,7 @@ public enum TrialUpdateBehavior implements ApiRequestParams.EnumParam { public static class LoginPage { /** * Required. Set to {@code true} to generate a shareable URL {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url">{@code * login_page.url} that will take your customers to a hosted login page for the customer * portal. * @@ -2097,7 +2141,7 @@ public ConfigurationUpdateParams.LoginPage build() { /** * Required. Set to {@code true} to generate a shareable URL {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url">{@code * login_page.url} that will take your customers to a hosted login page for the customer * portal. * diff --git a/src/main/java/com/stripe/param/billingportal/SessionCreateParams.java b/src/main/java/com/stripe/param/billingportal/SessionCreateParams.java index 0004e0e7545..180dbeb0364 100644 --- a/src/main/java/com/stripe/param/billingportal/SessionCreateParams.java +++ b/src/main/java/com/stripe/param/billingportal/SessionCreateParams.java @@ -15,7 +15,7 @@ public class SessionCreateParams extends ApiRequestParams { /** * The ID of an existing configuration to use for + * href="https://docs.stripe.com/api/customer_portal/configuration">configuration to use for * this session, describing its functionality and features. If not specified, the session uses the * default configuration. */ @@ -45,7 +45,7 @@ public class SessionCreateParams extends ApiRequestParams { /** * 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_data") @@ -62,9 +62,9 @@ public class SessionCreateParams extends ApiRequestParams { * The {@code on_behalf_of} account to use for this session. 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. */ @@ -138,7 +138,7 @@ public SessionCreateParams build() { /** * The ID of an existing configuration to use for + * href="https://docs.stripe.com/api/customer_portal/configuration">configuration to use for * this session, describing its functionality and features. If not specified, the session uses * the default configuration. */ @@ -213,7 +213,7 @@ public Builder putAllExtraParam(Map map) { /** * 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. */ public Builder setFlowData(SessionCreateParams.FlowData flowData) { @@ -234,9 +234,9 @@ public Builder setLocale(SessionCreateParams.Locale locale) { * The {@code on_behalf_of} account to use for this session. 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. */ @@ -1018,7 +1018,7 @@ public static class SubscriptionUpdateConfirm { /** * Required. The subscription item to be updated + * href="https://docs.stripe.com/api/subscription_items">subscription item to be updated * through this flow. Currently, only up to one may be specified and subscriptions with * multiple items are not updatable. */ @@ -1257,7 +1257,7 @@ public static class Item { /** * Required. The ID of the subscription + * href="https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id">subscription * item to be updated. */ @SerializedName("id") @@ -1266,14 +1266,14 @@ public static class Item { /** * The price the customer should subscribe to through this flow. The price must also be * included in the configuration's {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products">{@code * features.subscription_update.products}. */ @SerializedName("price") String price; /** - * Quantity for this item + * Quantity for this item * that the customer should subscribe to through this flow. */ @SerializedName("quantity") @@ -1337,7 +1337,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The ID of the subscription + * href="https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id">subscription * item to be updated. */ public Builder setId(String id) { @@ -1348,7 +1348,7 @@ public Builder setId(String id) { /** * The price the customer should subscribe to through this flow. The price must also be * included in the configuration's {@code + * href="https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products">{@code * features.subscription_update.products}. */ public Builder setPrice(String price) { @@ -1357,7 +1357,7 @@ public Builder setPrice(String price) { } /** - * Quantity for this item + * Quantity for this item * that the customer should subscribe to through this flow. */ public Builder setQuantity(Long quantity) { diff --git a/src/main/java/com/stripe/param/checkout/SessionCreateParams.java b/src/main/java/com/stripe/param/checkout/SessionCreateParams.java index d17d2dbd7f6..1e9ddd8ec8b 100644 --- a/src/main/java/com/stripe/param/checkout/SessionCreateParams.java +++ b/src/main/java/com/stripe/param/checkout/SessionCreateParams.java @@ -96,13 +96,13 @@ public class SessionCreateParams extends ApiRequestParams { * ID of an existing Customer, if one exists. In {@code payment} mode, the customer’s most * recently saved card payment method will be used to prefill the email, name, card details, and * billing address on the Checkout page. In {@code subscription} mode, the customer’s default + * href="https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method">default * payment method will be used if it’s a card, otherwise the most recently saved card will be * used. A valid billing address, billing name and billing email are required on the payment * method for Checkout to prefill the customer's card details. * *

If the Customer already has a valid email set, the + * href="https://docs.stripe.com/api/customers/object#customer_object-email">email set, the * email will be prefilled and not editable in Checkout. If the Customer does not have a valid * {@code email}, Checkout will set the email entered during the session on the Customer. * @@ -111,7 +111,7 @@ public class SessionCreateParams extends ApiRequestParams { * Customer object based on information provided during the payment flow. * *

You can set {@code + * href="https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage">{@code * payment_intent_data.setup_future_usage} to have Checkout automatically attach the payment * method to the Customer you pass in for future reuse. */ @@ -124,14 +124,14 @@ public class SessionCreateParams extends ApiRequestParams { /** * Configure whether a Checkout Session creates a Customer during Session confirmation. + * href="https://docs.stripe.com/api/customers">Customer during Session confirmation. * *

When a Customer is not created, you can still retrieve email, address, and other customer * data entered in Checkout with customer_details. + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details">customer_details. * *

Sessions that don't create Customers instead are grouped by guest customers in the + * href="https://docs.stripe.com/payments/checkout/guest-customers">guest customers in the * Dashboard. Promotion codes limited to first time customers will return invalid for these * Sessions. * @@ -199,7 +199,7 @@ public class SessionCreateParams extends ApiRequestParams { /** * A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices. The parameter is required for {@code + * href="https://docs.stripe.com/api/prices">Prices. The parameter is required for {@code * payment} and {@code subscription} mode. * *

For {@code payment} mode, there is a maximum of 100 line items, however it is recommended to @@ -220,7 +220,7 @@ public class SessionCreateParams extends ApiRequestParams { Locale locale; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -241,7 +241,7 @@ public class SessionCreateParams extends ApiRequestParams { *

You can configure Checkout to collect your customers' business names, individual names, or * both. Each name field can be either required or optional. * - *

If a Customer is created or provided, + *

If a Customer is created or provided, * the names can be saved to the Customer object as well. */ @SerializedName("name_collection") @@ -249,7 +249,7 @@ public class SessionCreateParams extends ApiRequestParams { /** * A list of optional items the customer can add to their order at checkout. Use this parameter to - * pass one-time or recurring Prices. + * pass one-time or recurring Prices. * *

There is a maximum of 10 optional items allowed on a Checkout Session, and the existing * limits on the number of line items allowed on a Checkout Session apply to the combined number @@ -286,7 +286,7 @@ public class SessionCreateParams extends ApiRequestParams { * *

If you'd like information on how to collect a payment method outside of Checkout, read the * guide on configuring subscriptions with a free + * href="https://docs.stripe.com/payments/checkout/free-trials">subscriptions with a free * trial. */ @SerializedName("payment_method_collection") @@ -312,7 +312,7 @@ public class SessionCreateParams extends ApiRequestParams { * *

You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic + * href="https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods">Dynamic * Payment Methods for more details. * *

Read more about the supported payment methods and their requirements in our We recommend that you review your privacy policy and check with your legal contacts before * using this feature. Learn more about collecting phone numbers with + * href="https://docs.stripe.com/payments/checkout/phone-numbers">collecting phone numbers with * Checkout. */ @SerializedName("phone_number_collection") @@ -349,7 +349,7 @@ public class SessionCreateParams extends ApiRequestParams { /** * This parameter applies to {@code ui_mode: embedded}. Learn more about the redirect + * href="https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form">redirect * behavior of embedded sessions. Defaults to {@code always}. */ @SerializedName("redirect_on_completion") @@ -407,7 +407,7 @@ public class SessionCreateParams extends ApiRequestParams { * The URL to which Stripe should send customers when payment or setup is complete. This parameter * is not allowed if ui_mode is {@code embedded} or {@code custom}. If you'd like to use * information from the successful Checkout Session on your page, read the guide on customizing your success + * href="https://docs.stripe.com/payments/checkout/custom-success-page">customizing your success * page. */ @SerializedName("success_url") @@ -839,13 +839,13 @@ public Builder setCustomText(SessionCreateParams.CustomText customText) { * ID of an existing Customer, if one exists. In {@code payment} mode, the customer’s most * recently saved card payment method will be used to prefill the email, name, card details, and * billing address on the Checkout page. In {@code subscription} mode, the customer’s default + * href="https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method">default * payment method will be used if it’s a card, otherwise the most recently saved card will * be used. A valid billing address, billing name and billing email are required on the payment * method for Checkout to prefill the customer's card details. * *

If the Customer already has a valid email set, the + * href="https://docs.stripe.com/api/customers/object#customer_object-email">email set, the * email will be prefilled and not editable in Checkout. If the Customer does not have a valid * {@code email}, Checkout will set the email entered during the session on the Customer. * @@ -854,7 +854,7 @@ public Builder setCustomText(SessionCreateParams.CustomText customText) { * Customer object based on information provided during the payment flow. * *

You can set {@code + * href="https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage">{@code * payment_intent_data.setup_future_usage} to have Checkout automatically attach the payment * method to the Customer you pass in for future reuse. */ @@ -871,14 +871,14 @@ public Builder setCustomerAccount(String customerAccount) { /** * Configure whether a Checkout Session creates a Customer during Session confirmation. + * href="https://docs.stripe.com/api/customers">Customer during Session confirmation. * *

When a Customer is not created, you can still retrieve email, address, and other customer * data entered in Checkout with customer_details. + * href="https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details">customer_details. * *

Sessions that don't create Customers instead are grouped by guest customers in the + * href="https://docs.stripe.com/payments/checkout/guest-customers">guest customers in the * Dashboard. Promotion codes limited to first time customers will return invalid for these * Sessions. * @@ -1107,7 +1107,7 @@ public Builder setMode(SessionCreateParams.Mode mode) { *

You can configure Checkout to collect your customers' business names, individual names, or * both. Each name field can be either required or optional. * - *

If a Customer is created or provided, + *

If a Customer is created or provided, * the names can be saved to the Customer object as well. */ public Builder setNameCollection(SessionCreateParams.NameCollection nameCollection) { @@ -1168,7 +1168,7 @@ public Builder setPaymentIntentData(SessionCreateParams.PaymentIntentData paymen * *

If you'd like information on how to collect a payment method outside of Checkout, read the * guide on configuring subscriptions with a free + * href="https://docs.stripe.com/payments/checkout/free-trials">subscriptions with a free * trial. */ public Builder setPaymentMethodCollection( @@ -1243,7 +1243,7 @@ public Builder setPermissions(SessionCreateParams.Permissions permissions) { * *

We recommend that you review your privacy policy and check with your legal contacts before * using this feature. Learn more about collecting phone numbers with + * href="https://docs.stripe.com/payments/checkout/phone-numbers">collecting phone numbers with * Checkout. */ public Builder setPhoneNumberCollection( @@ -1254,7 +1254,7 @@ public Builder setPhoneNumberCollection( /** * This parameter applies to {@code ui_mode: embedded}. Learn more about the redirect + * href="https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form">redirect * behavior of embedded sessions. Defaults to {@code always}. */ public Builder setRedirectOnCompletion( @@ -1351,7 +1351,7 @@ public Builder setSubscriptionData(SessionCreateParams.SubscriptionData subscrip * The URL to which Stripe should send customers when payment or setup is complete. This * parameter is not allowed if ui_mode is {@code embedded} or {@code custom}. If you'd like to * use information from the successful Checkout Session on your page, read the guide on customizing your success + * href="https://docs.stripe.com/payments/checkout/custom-success-page">customizing your success * page. */ public Builder setSuccessUrl(String successUrl) { @@ -4606,7 +4606,7 @@ public static class Discount { String coupon; /** - * Data used to generate a new Coupon object + * Data used to generate a new Coupon object * inline. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ @SerializedName("coupon_data") @@ -4662,7 +4662,7 @@ public Builder setCoupon(String coupon) { } /** - * Data used to generate a new Coupon object + * Data used to generate a new Coupon object * inline. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ public Builder setCouponData(SessionCreateParams.Discount.CouponData couponData) { @@ -4737,7 +4737,7 @@ public static class CouponData { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -4892,7 +4892,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -4903,7 +4903,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -5071,7 +5071,7 @@ public static class InvoiceData { Issuer issuer; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -5662,7 +5662,7 @@ public static class LineItem { AdjustableQuantity adjustableQuantity; /** - * The tax rates that will be applied to + * The tax rates that will be applied to * this line item depending on the customer's billing/shipping address. We currently support the * following countries: US, GB, AU, and all countries in the EU. */ @@ -5679,7 +5679,7 @@ public static class LineItem { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -5688,15 +5688,15 @@ public static class LineItem { Map metadata; /** - * The ID of the Price or Plan object. One of {@code price} or {@code + * The ID of the Price or Plan object. One of {@code price} or {@code * price_data} is required. */ @SerializedName("price") String price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ @SerializedName("price_data") @@ -5710,7 +5710,7 @@ public static class LineItem { Long quantity; /** - * The tax rates which apply to this line + * The tax rates which apply to this line * item. */ @SerializedName("tax_rates") @@ -5858,8 +5858,8 @@ public Builder putAllMetadata(Map map) { } /** - * The ID of the Price or Plan object. One of {@code price} or {@code + * The ID of the Price or Plan object. One of {@code price} or {@code * price_data} is required. */ public Builder setPrice(String price) { @@ -5868,7 +5868,7 @@ public Builder setPrice(String price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required. */ public Builder setPriceData(SessionCreateParams.LineItem.PriceData priceData) { @@ -6072,7 +6072,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6217,7 +6217,7 @@ public Builder setRecurring(SessionCreateParams.LineItem.PriceData.Recurring rec /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -6278,7 +6278,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -6292,10 +6292,18 @@ public static class ProductData { @SerializedName("name") String name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") String taxCode; + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -6310,6 +6318,7 @@ private ProductData( Map metadata, String name, String taxCode, + TaxDetails taxDetails, String unitLabel) { this.description = description; this.extraParams = extraParams; @@ -6317,6 +6326,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -6337,6 +6347,8 @@ public static class Builder { private String taxCode; + private TaxDetails taxDetails; + private String unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -6348,6 +6360,7 @@ public SessionCreateParams.LineItem.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -6451,12 +6464,23 @@ public Builder setName(String name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + SessionCreateParams.LineItem.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -6466,6 +6490,87 @@ public Builder setUnitLabel(String unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + String taxCode; + + private TaxDetails(Map extraParams, String taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public SessionCreateParams.LineItem.PriceData.ProductData.TaxDetails build() { + return new SessionCreateParams.LineItem.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SessionCreateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SessionCreateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } @Getter @@ -6909,8 +7014,8 @@ public static class OptionalItem { /** * Required. The ID of the Price or Plan object. + * href="https://docs.stripe.com/api/prices">Price or Plan object. */ @SerializedName("price") String price; @@ -6990,8 +7095,8 @@ public Builder putAllExtraParam(Map map) { /** * Required. The ID of the Price or Plan object. + * href="https://docs.stripe.com/api/prices">Price or Plan object. */ public Builder setPrice(String price) { this.price = price; @@ -7137,7 +7242,7 @@ public static class PaymentIntentData { * The amount of the application fee (if any) that will be requested to be applied to the * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more information, - * see the PaymentIntents use case + * see the PaymentIntents use case * for connected accounts. */ @SerializedName("application_fee_amount") @@ -7161,7 +7266,7 @@ public static class PaymentIntentData { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -7187,7 +7292,7 @@ public static class PaymentIntentData { /** * Indicates that you intend to make future payments + * href="https://docs.stripe.com/payments/payment-intents#future-usage">make future payments * with the payment method collected by this Checkout Session. * *

When setting this to {@code on_session}, Checkout will show a notice to the customer that @@ -7239,7 +7344,7 @@ public static class PaymentIntentData { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more * information, see the PaymentIntents use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ @SerializedName("transfer_data") @@ -7247,7 +7352,7 @@ public static class PaymentIntentData { /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected + * href="https://docs.stripe.com/connect/separate-charges-and-transfers">use case for connected * accounts for details. */ @SerializedName("transfer_group") @@ -7336,7 +7441,7 @@ public SessionCreateParams.PaymentIntentData build() { * payment and transferred to the application owner's Stripe account. The amount of the * application fee collected will be capped at the total amount captured. For more * information, see the PaymentIntents use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setApplicationFeeAmount(Long applicationFeeAmount) { @@ -7431,7 +7536,7 @@ public Builder setReceiptEmail(String receiptEmail) { /** * Indicates that you intend to make future + * href="https://docs.stripe.com/payments/payment-intents#future-usage">make future * payments with the payment method collected by this Checkout Session. * *

When setting this to {@code on_session}, Checkout will show a notice to the customer @@ -7493,7 +7598,7 @@ public Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) { /** * The parameters used to automatically create a Transfer when the payment succeeds. For more * information, see the PaymentIntents use case for connected + * href="https://docs.stripe.com/payments/connected-accounts">use case for connected * accounts. */ public Builder setTransferData( @@ -7504,7 +7609,7 @@ public Builder setTransferData( /** * A string that identifies the resulting payment as part of a group. See the PaymentIntents - * use case for + * use case for * connected accounts for details. */ public Builder setTransferGroup(String transferGroup) { @@ -7692,7 +7797,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -7807,7 +7915,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -10758,11 +10869,11 @@ public static class Card { /** * 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. */ @@ -10995,11 +11106,11 @@ public Builder setRequestOvercapture( /** * 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. */ @@ -14849,7 +14960,7 @@ public static class Paypal { Map extraParams; /** - * Preferred locale of + * Preferred locale of * the PayPal checkout page that the customer is redirected to. */ @SerializedName("preferred_locale") @@ -15005,7 +15116,7 @@ public Builder putAllExtraParam(Map map) { } /** - * Preferred locale + * Preferred locale * of the PayPal checkout page that the customer is redirected to. */ public Builder setPreferredLocale( @@ -15361,7 +15472,7 @@ public static class MandateOptions { * Amount that will be collected. It is required when {@code amount_type} is {@code fixed}. */ @SerializedName("amount") - Long amount; + Object amount; /** * The type of amount that will be collected. The amount charged must be exact or up to the @@ -15369,14 +15480,14 @@ public static class MandateOptions { * Defaults to {@code maximum}. */ @SerializedName("amount_type") - AmountType amountType; + ApiRequestParams.EnumParam amountType; /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. */ @SerializedName("end_date") - String endDate; + Object endDate; /** * Map of extra parameters for custom features not available in this client library. The @@ -15390,7 +15501,7 @@ public static class MandateOptions { /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ @SerializedName("payment_schedule") - PaymentSchedule paymentSchedule; + ApiRequestParams.EnumParam paymentSchedule; /** * The number of payments that will be made during a payment period. Defaults to 1 except @@ -15398,31 +15509,31 @@ public static class MandateOptions { * limit. */ @SerializedName("payments_per_period") - Long paymentsPerPeriod; + Object paymentsPerPeriod; /** * The purpose for which payments are made. Has a default value based on your merchant * category code. */ @SerializedName("purpose") - Purpose purpose; + ApiRequestParams.EnumParam purpose; /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. */ @SerializedName("start_date") - String startDate; + Object startDate; private MandateOptions( - Long amount, - AmountType amountType, - String endDate, + Object amount, + ApiRequestParams.EnumParam amountType, + Object endDate, Map extraParams, - PaymentSchedule paymentSchedule, - Long paymentsPerPeriod, - Purpose purpose, - String startDate) { + ApiRequestParams.EnumParam paymentSchedule, + Object paymentsPerPeriod, + ApiRequestParams.EnumParam purpose, + Object startDate) { this.amount = amount; this.amountType = amountType; this.endDate = endDate; @@ -15438,21 +15549,21 @@ public static Builder builder() { } public static class Builder { - private Long amount; + private Object amount; - private AmountType amountType; + private ApiRequestParams.EnumParam amountType; - private String endDate; + private Object endDate; private Map extraParams; - private PaymentSchedule paymentSchedule; + private ApiRequestParams.EnumParam paymentSchedule; - private Long paymentsPerPeriod; + private Object paymentsPerPeriod; - private Purpose purpose; + private ApiRequestParams.EnumParam purpose; - private String startDate; + private Object startDate; /** Finalize and obtain parameter instance from this builder. */ public SessionCreateParams.PaymentMethodOptions.Payto.MandateOptions build() { @@ -15476,6 +15587,15 @@ public Builder setAmount(Long amount) { return this; } + /** + * Amount that will be collected. It is required when {@code amount_type} is {@code + * fixed}. + */ + public Builder setAmount(EmptyParam amount) { + this.amount = amount; + return this; + } + /** * The type of amount that will be collected. The amount charged must be exact or up to * the value of {@code amount} param for {@code fixed} or {@code maximum} type @@ -15487,6 +15607,16 @@ public Builder setAmountType( return this; } + /** + * The type of amount that will be collected. The amount charged must be exact or up to + * the value of {@code amount} param for {@code fixed} or {@code maximum} type + * respectively. Defaults to {@code maximum}. + */ + public Builder setAmountType(EmptyParam amountType) { + this.amountType = amountType; + return this; + } + /** * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no * end date. @@ -15496,6 +15626,15 @@ public Builder setEndDate(String endDate) { return this; } + /** + * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no + * end date. + */ + public Builder setEndDate(EmptyParam endDate) { + this.endDate = endDate; + return this; + } + /** * Add a key/value pair to `extraParams` map. A map is initialized for the first * `put/putAll` call, and subsequent calls add additional key/value pairs to the original @@ -15534,6 +15673,12 @@ public Builder setPaymentSchedule( return this; } + /** The periodicity at which payments will be collected. Defaults to {@code adhoc}. */ + public Builder setPaymentSchedule(EmptyParam paymentSchedule) { + this.paymentSchedule = paymentSchedule; + return this; + } + /** * The number of payments that will be made during a payment period. Defaults to 1 except * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no @@ -15544,6 +15689,16 @@ public Builder setPaymentsPerPeriod(Long paymentsPerPeriod) { return this; } + /** + * The number of payments that will be made during a payment period. Defaults to 1 except + * for when {@code payment_schedule} is {@code adhoc}. In that case, it defaults to no + * limit. + */ + public Builder setPaymentsPerPeriod(EmptyParam paymentsPerPeriod) { + this.paymentsPerPeriod = paymentsPerPeriod; + return this; + } + /** * The purpose for which payments are made. Has a default value based on your merchant * category code. @@ -15554,6 +15709,15 @@ public Builder setPurpose( return this; } + /** + * The purpose for which payments are made. Has a default value based on your merchant + * category code. + */ + public Builder setPurpose(EmptyParam purpose) { + this.purpose = purpose; + return this; + } + /** * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to * confirmation time. @@ -15562,6 +15726,15 @@ public Builder setStartDate(String startDate) { this.startDate = startDate; return this; } + + /** + * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to + * confirmation time. + */ + public Builder setStartDate(EmptyParam startDate) { + this.startDate = startDate; + return this; + } } public enum AmountType implements ApiRequestParams.EnumParam { @@ -18297,7 +18470,7 @@ public static class SetupIntentData { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -19346,7 +19519,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -19362,7 +19535,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -19521,7 +19694,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { @@ -20216,7 +20389,7 @@ public static class SubscriptionData { /** * The subscription's description, meant to be displayable to the customer. Use this field to * optionally store an explanation of the subscription for rendering in the customer portal. + * href="https://docs.stripe.com/customer-management">customer portal. */ @SerializedName("description") String description; @@ -20235,7 +20408,7 @@ public static class SubscriptionData { InvoiceSettings invoiceSettings; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -20416,7 +20589,7 @@ public Builder addAllDefaultTaxRate(List elements) { /** * The subscription's description, meant to be displayable to the customer. Use this field to * optionally store an explanation of the subscription for rendering in the customer portal. + * href="https://docs.stripe.com/customer-management">customer portal. */ public Builder setDescription(String description) { this.description = description; diff --git a/src/main/java/com/stripe/param/checkout/SessionUpdateParams.java b/src/main/java/com/stripe/param/checkout/SessionUpdateParams.java index 69152334ed3..3dd1911ec49 100644 --- a/src/main/java/com/stripe/param/checkout/SessionUpdateParams.java +++ b/src/main/java/com/stripe/param/checkout/SessionUpdateParams.java @@ -71,7 +71,7 @@ public class SessionUpdateParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -325,7 +325,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -336,7 +336,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -778,7 +778,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") Object state; @@ -930,13 +933,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -950,14 +959,14 @@ public Builder setState(EmptyParam state) { @EqualsAndHashCode(callSuper = false) public static class Discount { /** - * The ID of the Coupon to apply to this + * The ID of the Coupon to apply to this * Session. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ @SerializedName("coupon") Object coupon; /** - * Data used to generate a new Coupon object + * Data used to generate a new Coupon object * inline. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ @SerializedName("coupon_data") @@ -995,7 +1004,7 @@ public SessionUpdateParams.Discount build() { } /** - * The ID of the Coupon to apply to this + * The ID of the Coupon to apply to this * Session. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ public Builder setCoupon(String coupon) { @@ -1004,7 +1013,7 @@ public Builder setCoupon(String coupon) { } /** - * The ID of the Coupon to apply to this + * The ID of the Coupon to apply to this * Session. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ public Builder setCoupon(EmptyParam coupon) { @@ -1013,7 +1022,7 @@ public Builder setCoupon(EmptyParam coupon) { } /** - * Data used to generate a new Coupon object + * Data used to generate a new Coupon object * inline. One of {@code coupon} or {@code coupon_data} is required when updating discounts. */ public Builder setCouponData(SessionUpdateParams.Discount.CouponData couponData) { @@ -1082,7 +1091,7 @@ public static class CouponData { Map extraParams; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1246,7 +1255,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1257,7 +1266,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -1592,7 +1601,7 @@ public static class LineItem { Object 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -1601,14 +1610,14 @@ public static class LineItem { Object metadata; /** - * The ID of the Price. One of {@code price} or + * The ID of the Price. One of {@code price} or * {@code price_data} is required when creating a new line item. */ @SerializedName("price") Object price; /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required when creating a new line item. */ @SerializedName("price_data") @@ -1622,7 +1631,7 @@ public static class LineItem { Long quantity; /** - * The tax rates which apply to this line + * The tax rates which apply to this line * item. */ @SerializedName("tax_rates") @@ -1758,7 +1767,7 @@ public Builder putAllMetadata(Map map) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1769,7 +1778,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -1780,7 +1789,7 @@ public Builder setMetadata(Map metadata) { } /** - * The ID of the Price. One of {@code price} + * The ID of the Price. One of {@code price} * or {@code price_data} is required when creating a new line item. */ public Builder setPrice(String price) { @@ -1789,7 +1798,7 @@ public Builder setPrice(String price) { } /** - * The ID of the Price. One of {@code price} + * The ID of the Price. One of {@code price} * or {@code price_data} is required when creating a new line item. */ public Builder setPrice(EmptyParam price) { @@ -1798,7 +1807,7 @@ public Builder setPrice(EmptyParam price) { } /** - * Data used to generate a new Price object + * Data used to generate a new Price object * inline. One of {@code price} or {@code price_data} is required when creating a new line * item. */ @@ -1845,7 +1854,7 @@ public Builder addAllTaxRate(List elements) { } /** - * The tax rates which apply to this line + * The tax rates which apply to this line * item. */ public Builder setTaxRates(EmptyParam taxRates) { @@ -1854,7 +1863,7 @@ public Builder setTaxRates(EmptyParam taxRates) { } /** - * The tax rates which apply to this line + * The tax rates which apply to this line * item. */ public Builder setTaxRates(List taxRates) { @@ -2023,7 +2032,7 @@ public static class PriceData { /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2188,7 +2197,7 @@ public Builder setRecurring(SessionUpdateParams.LineItem.PriceData.Recurring rec /** * Only required if a default + * href="https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default * tax behavior was not provided in the Stripe Tax settings. Specifies whether the price * is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code * exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code @@ -2259,7 +2268,7 @@ public static class ProductData { List images; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to * them. All keys can be unset by posting an empty value to {@code metadata}. @@ -2273,10 +2282,18 @@ public static class ProductData { @SerializedName("name") Object name; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + @SerializedName("tax_details") + TaxDetails taxDetails; + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -2291,6 +2308,7 @@ private ProductData( Map metadata, Object name, Object taxCode, + TaxDetails taxDetails, Object unitLabel) { this.description = description; this.extraParams = extraParams; @@ -2298,6 +2316,7 @@ private ProductData( this.metadata = metadata; this.name = name; this.taxCode = taxCode; + this.taxDetails = taxDetails; this.unitLabel = unitLabel; } @@ -2318,6 +2337,8 @@ public static class Builder { private Object taxCode; + private TaxDetails taxDetails; + private Object unitLabel; /** Finalize and obtain parameter instance from this builder. */ @@ -2329,6 +2350,7 @@ public SessionUpdateParams.LineItem.PriceData.ProductData build() { this.metadata, this.name, this.taxCode, + this.taxDetails, this.unitLabel); } @@ -2450,18 +2472,29 @@ public Builder setName(EmptyParam name) { return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; } + /** + * Tax details for this product, including the tax code and an optional performance + * location. + */ + public Builder setTaxDetails( + SessionUpdateParams.LineItem.PriceData.ProductData.TaxDetails taxDetails) { + this.taxDetails = taxDetails; + return this; + } + /** * A label that represents units of this product. When set, this will be included in * customers' receipts, invoices, Checkout, and the customer portal. @@ -2480,6 +2513,96 @@ public Builder setUnitLabel(EmptyParam unitLabel) { return this; } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class TaxDetails { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. A tax + * code ID. + */ + @SerializedName("tax_code") + Object taxCode; + + private TaxDetails(Map extraParams, Object taxCode) { + this.extraParams = extraParams; + this.taxCode = taxCode; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object taxCode; + + /** Finalize and obtain parameter instance from this builder. */ + public SessionUpdateParams.LineItem.PriceData.ProductData.TaxDetails build() { + return new SessionUpdateParams.LineItem.PriceData.ProductData.TaxDetails( + this.extraParams, this.taxCode); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SessionUpdateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * SessionUpdateParams.LineItem.PriceData.ProductData.TaxDetails#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + + /** + * Required. A tax + * code ID. + */ + public Builder setTaxCode(EmptyParam taxCode) { + this.taxCode = taxCode; + return this; + } + } + } } @Getter @@ -2748,7 +2871,7 @@ public static class ShippingRateData { FixedAmount fixedAmount; /** - * Set of key-value pairs that you can + * 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. Individual keys can be unset by posting an empty value to them. All * keys can be unset by posting an empty value to {@code metadata}. @@ -2764,7 +2887,7 @@ public static class ShippingRateData { TaxBehavior taxBehavior; /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ @SerializedName("tax_code") @@ -2932,7 +3055,7 @@ public Builder setTaxBehavior( } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(String taxCode) { @@ -2941,7 +3064,7 @@ public Builder setTaxCode(String taxCode) { } /** - * A tax code ID. The Shipping tax + * A tax code ID. The Shipping tax * code is {@code txcd_92010001}. */ public Builder setTaxCode(EmptyParam taxCode) { diff --git a/src/main/java/com/stripe/param/climate/OrderCreateParams.java b/src/main/java/com/stripe/param/climate/OrderCreateParams.java index 77e203eff6a..ba7b162a77f 100644 --- a/src/main/java/com/stripe/param/climate/OrderCreateParams.java +++ b/src/main/java/com/stripe/param/climate/OrderCreateParams.java @@ -50,7 +50,7 @@ public class OrderCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/climate/OrderUpdateParams.java b/src/main/java/com/stripe/param/climate/OrderUpdateParams.java index 47ffe619a24..47e010125db 100644 --- a/src/main/java/com/stripe/param/climate/OrderUpdateParams.java +++ b/src/main/java/com/stripe/param/climate/OrderUpdateParams.java @@ -35,7 +35,7 @@ public class OrderUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/delegatedcheckout/RequestedSessionConfirmParams.java b/src/main/java/com/stripe/param/delegatedcheckout/RequestedSessionConfirmParams.java index e6a1cd107a8..0cfeb1fc7aa 100644 --- a/src/main/java/com/stripe/param/delegatedcheckout/RequestedSessionConfirmParams.java +++ b/src/main/java/com/stripe/param/delegatedcheckout/RequestedSessionConfirmParams.java @@ -30,6 +30,10 @@ public class RequestedSessionConfirmParams extends ApiRequestParams { @SerializedName("payment_method") String paymentMethod; + /** The payment method data for this requested session. */ + @SerializedName("payment_method_data") + PaymentMethodData paymentMethodData; + /** Risk details/signals associated with the requested session. */ @SerializedName("risk_details") RiskDetails riskDetails; @@ -38,10 +42,12 @@ private RequestedSessionConfirmParams( List expand, Map extraParams, String paymentMethod, + PaymentMethodData paymentMethodData, RiskDetails riskDetails) { this.expand = expand; this.extraParams = extraParams; this.paymentMethod = paymentMethod; + this.paymentMethodData = paymentMethodData; this.riskDetails = riskDetails; } @@ -56,12 +62,18 @@ public static class Builder { private String paymentMethod; + private PaymentMethodData paymentMethodData; + private RiskDetails riskDetails; /** Finalize and obtain parameter instance from this builder. */ public RequestedSessionConfirmParams build() { return new RequestedSessionConfirmParams( - this.expand, this.extraParams, this.paymentMethod, this.riskDetails); + this.expand, + this.extraParams, + this.paymentMethod, + this.paymentMethodData, + this.riskDetails); } /** @@ -122,6 +134,13 @@ public Builder setPaymentMethod(String paymentMethod) { return this; } + /** The payment method data for this requested session. */ + public Builder setPaymentMethodData( + RequestedSessionConfirmParams.PaymentMethodData paymentMethodData) { + this.paymentMethodData = paymentMethodData; + return this; + } + /** Risk details/signals associated with the requested session. */ public Builder setRiskDetails(RequestedSessionConfirmParams.RiskDetails riskDetails) { this.riskDetails = riskDetails; @@ -129,6 +148,517 @@ public Builder setRiskDetails(RequestedSessionConfirmParams.RiskDetails riskDeta } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PaymentMethodData { + /** The billing details for the payment method data. */ + @SerializedName("billing_details") + BillingDetails billingDetails; + + /** The card for the payment method data. */ + @SerializedName("card") + Card card; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The type of the payment method data. */ + @SerializedName("type") + Type type; + + private PaymentMethodData( + BillingDetails billingDetails, Card card, Map extraParams, Type type) { + this.billingDetails = billingDetails; + this.card = card; + this.extraParams = extraParams; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private BillingDetails billingDetails; + + private Card card; + + private Map extraParams; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public RequestedSessionConfirmParams.PaymentMethodData build() { + return new RequestedSessionConfirmParams.PaymentMethodData( + this.billingDetails, this.card, this.extraParams, this.type); + } + + /** The billing details for the payment method data. */ + public Builder setBillingDetails( + RequestedSessionConfirmParams.PaymentMethodData.BillingDetails billingDetails) { + this.billingDetails = billingDetails; + return this; + } + + /** The card for the payment method data. */ + public Builder setCard(RequestedSessionConfirmParams.PaymentMethodData.Card card) { + this.card = card; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * RequestedSessionConfirmParams.PaymentMethodData#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link RequestedSessionConfirmParams.PaymentMethodData#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The type of the payment method data. */ + public Builder setType(RequestedSessionConfirmParams.PaymentMethodData.Type type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class BillingDetails { + /** The address for the billing details. */ + @SerializedName("address") + Address address; + + /** The email for the billing details. */ + @SerializedName("email") + String email; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The name for the billing details. */ + @SerializedName("name") + String name; + + /** The phone for the billing details. */ + @SerializedName("phone") + String phone; + + private BillingDetails( + Address address, + String email, + Map extraParams, + String name, + String phone) { + this.address = address; + this.email = email; + this.extraParams = extraParams; + this.name = name; + this.phone = phone; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Address address; + + private String email; + + private Map extraParams; + + private String name; + + private String phone; + + /** Finalize and obtain parameter instance from this builder. */ + public RequestedSessionConfirmParams.PaymentMethodData.BillingDetails build() { + return new RequestedSessionConfirmParams.PaymentMethodData.BillingDetails( + this.address, this.email, this.extraParams, this.name, this.phone); + } + + /** The address for the billing details. */ + public Builder setAddress( + RequestedSessionConfirmParams.PaymentMethodData.BillingDetails.Address address) { + this.address = address; + return this; + } + + /** The email for the billing details. */ + public Builder setEmail(String email) { + this.email = email; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * RequestedSessionConfirmParams.PaymentMethodData.BillingDetails#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * RequestedSessionConfirmParams.PaymentMethodData.BillingDetails#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The name for the billing details. */ + public Builder setName(String name) { + this.name = name; + return this; + } + + /** The phone for the billing details. */ + public Builder setPhone(String phone) { + this.phone = phone; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Address { + /** Required. City, district, suburb, town, or village. */ + @SerializedName("city") + String city; + + /** + * Required. Two-letter country code (ISO 3166-1 alpha-2). + */ + @SerializedName("country") + String country; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its parent + * instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. Address line 1, such as the street, PO Box, or company name. + */ + @SerializedName("line1") + String line1; + + /** Address line 2, such as the apartment, suite, unit, or building. */ + @SerializedName("line2") + String line2; + + /** Required. ZIP or postal code. */ + @SerializedName("postal_code") + String postalCode; + + /** + * Required. State, county, province, or region (ISO 3166-2). + */ + @SerializedName("state") + String state; + + private Address( + String city, + String country, + Map extraParams, + String line1, + String line2, + String postalCode, + String state) { + this.city = city; + this.country = country; + this.extraParams = extraParams; + this.line1 = line1; + this.line2 = line2; + this.postalCode = postalCode; + this.state = state; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String city; + + private String country; + + private Map extraParams; + + private String line1; + + private String line2; + + private String postalCode; + + private String state; + + /** Finalize and obtain parameter instance from this builder. */ + public RequestedSessionConfirmParams.PaymentMethodData.BillingDetails.Address build() { + return new RequestedSessionConfirmParams.PaymentMethodData.BillingDetails.Address( + this.city, + this.country, + this.extraParams, + this.line1, + this.line2, + this.postalCode, + this.state); + } + + /** Required. City, district, suburb, town, or village. */ + public Builder setCity(String city) { + this.city = city; + return this; + } + + /** + * Required. Two-letter country code (ISO 3166-1 alpha-2). + */ + public Builder setCountry(String country) { + this.country = country; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * RequestedSessionConfirmParams.PaymentMethodData.BillingDetails.Address#extraParams} for + * the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link + * RequestedSessionConfirmParams.PaymentMethodData.BillingDetails.Address#extraParams} for + * the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. Address line 1, such as the street, PO Box, or company name. + */ + public Builder setLine1(String line1) { + this.line1 = line1; + return this; + } + + /** Address line 2, such as the apartment, suite, unit, or building. */ + public Builder setLine2(String line2) { + this.line2 = line2; + return this; + } + + /** Required. ZIP or postal code. */ + public Builder setPostalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Required. State, county, province, or region (ISO 3166-2). + */ + public Builder setState(String state) { + this.state = state; + return this; + } + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Card { + /** The CVC of the card. */ + @SerializedName("cvc") + String cvc; + + /** Required. The expiration month of the card. */ + @SerializedName("exp_month") + Long expMonth; + + /** Required. The expiration year of the card. */ + @SerializedName("exp_year") + Long expYear; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. The number of the card. */ + @SerializedName("number") + String number; + + private Card( + String cvc, Long expMonth, Long expYear, Map extraParams, String number) { + this.cvc = cvc; + this.expMonth = expMonth; + this.expYear = expYear; + this.extraParams = extraParams; + this.number = number; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String cvc; + + private Long expMonth; + + private Long expYear; + + private Map extraParams; + + private String number; + + /** Finalize and obtain parameter instance from this builder. */ + public RequestedSessionConfirmParams.PaymentMethodData.Card build() { + return new RequestedSessionConfirmParams.PaymentMethodData.Card( + this.cvc, this.expMonth, this.expYear, this.extraParams, this.number); + } + + /** The CVC of the card. */ + public Builder setCvc(String cvc) { + this.cvc = cvc; + return this; + } + + /** Required. The expiration month of the card. */ + public Builder setExpMonth(Long expMonth) { + this.expMonth = expMonth; + return this; + } + + /** Required. The expiration year of the card. */ + public Builder setExpYear(Long expYear) { + this.expYear = expYear; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link RequestedSessionConfirmParams.PaymentMethodData.Card#extraParams} for the + * field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link RequestedSessionConfirmParams.PaymentMethodData.Card#extraParams} for the + * field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Required. The number of the card. */ + public Builder setNumber(String number) { + this.number = number; + return this; + } + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("card") + CARD("card"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class RiskDetails { diff --git a/src/main/java/com/stripe/param/financialconnections/AccountListParams.java b/src/main/java/com/stripe/param/financialconnections/AccountListParams.java index a623be116a1..a4c9f4a9a3c 100644 --- a/src/main/java/com/stripe/param/financialconnections/AccountListParams.java +++ b/src/main/java/com/stripe/param/financialconnections/AccountListParams.java @@ -212,15 +212,15 @@ public Builder setStartingAfter(String startingAfter) { @Getter @EqualsAndHashCode(callSuper = false) public static class AccountHolder { - /** The ID of the Stripe account whose accounts will be retrieved. */ + /** The ID of the Stripe account whose accounts you will retrieve. */ @SerializedName("account") String account; - /** The ID of the Stripe customer whose accounts will be retrieved. */ + /** The ID of the Stripe customer whose accounts you will retrieve. */ @SerializedName("customer") String customer; - /** The Account ID of the Stripe customer whose accounts will be retrieved. */ + /** The ID of the Account representing a customer whose accounts you will retrieve. */ @SerializedName("customer_account") String customerAccount; @@ -260,19 +260,19 @@ public AccountListParams.AccountHolder build() { this.account, this.customer, this.customerAccount, this.extraParams); } - /** The ID of the Stripe account whose accounts will be retrieved. */ + /** The ID of the Stripe account whose accounts you will retrieve. */ public Builder setAccount(String account) { this.account = account; return this; } - /** The ID of the Stripe customer whose accounts will be retrieved. */ + /** The ID of the Stripe customer whose accounts you will retrieve. */ public Builder setCustomer(String customer) { this.customer = customer; return this; } - /** The Account ID of the Stripe customer whose accounts will be retrieved. */ + /** The ID of the Account representing a customer whose accounts you will retrieve. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; return this; diff --git a/src/main/java/com/stripe/param/financialconnections/SessionCreateParams.java b/src/main/java/com/stripe/param/financialconnections/SessionCreateParams.java index 443b9a85720..2f18d1888af 100644 --- a/src/main/java/com/stripe/param/financialconnections/SessionCreateParams.java +++ b/src/main/java/com/stripe/param/financialconnections/SessionCreateParams.java @@ -262,22 +262,22 @@ public Builder setReturnUrl(String returnUrl) { @EqualsAndHashCode(callSuper = false) public static class AccountHolder { /** - * The ID of the Stripe account whose accounts will be retrieved. Should only be present if - * {@code type} is {@code account}. + * The ID of the Stripe account whose accounts you will retrieve. Only available when {@code + * type} is {@code account}. */ @SerializedName("account") String account; /** - * The ID of the Stripe customer whose accounts will be retrieved. Should only be present if - * {@code type} is {@code customer}. + * The ID of the Stripe customer whose accounts you will retrieve. Only available when {@code + * type} is {@code customer}. */ @SerializedName("customer") String customer; /** - * The ID of the Stripe customer Account whose accounts will be retrieved. Should only be - * present if {@code type} is {@code customer}. + * The ID of Account representing a customer whose accounts you will retrieve. Only available + * when {@code type} is {@code customer}. */ @SerializedName("customer_account") String customerAccount; @@ -330,8 +330,8 @@ public SessionCreateParams.AccountHolder build() { } /** - * The ID of the Stripe account whose accounts will be retrieved. Should only be present if - * {@code type} is {@code account}. + * The ID of the Stripe account whose accounts you will retrieve. Only available when {@code + * type} is {@code account}. */ public Builder setAccount(String account) { this.account = account; @@ -339,8 +339,8 @@ public Builder setAccount(String account) { } /** - * The ID of the Stripe customer whose accounts will be retrieved. Should only be present if - * {@code type} is {@code customer}. + * The ID of the Stripe customer whose accounts you will retrieve. Only available when {@code + * type} is {@code customer}. */ public Builder setCustomer(String customer) { this.customer = customer; @@ -348,8 +348,8 @@ public Builder setCustomer(String customer) { } /** - * The ID of the Stripe customer Account whose accounts will be retrieved. Should only be - * present if {@code type} is {@code customer}. + * The ID of Account representing a customer whose accounts you will retrieve. Only available + * when {@code type} is {@code customer}. */ public Builder setCustomerAccount(String customerAccount) { this.customerAccount = customerAccount; diff --git a/src/main/java/com/stripe/param/forwarding/RequestCreateParams.java b/src/main/java/com/stripe/param/forwarding/RequestCreateParams.java index 141d46193af..3690946956a 100644 --- a/src/main/java/com/stripe/param/forwarding/RequestCreateParams.java +++ b/src/main/java/com/stripe/param/forwarding/RequestCreateParams.java @@ -27,7 +27,7 @@ public class RequestCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/identity/VerificationSessionCreateParams.java b/src/main/java/com/stripe/param/identity/VerificationSessionCreateParams.java index ac81935a686..8840bb767d9 100644 --- a/src/main/java/com/stripe/param/identity/VerificationSessionCreateParams.java +++ b/src/main/java/com/stripe/param/identity/VerificationSessionCreateParams.java @@ -35,7 +35,7 @@ public class VerificationSessionCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -55,7 +55,7 @@ public class VerificationSessionCreateParams extends ApiRequestParams { @SerializedName("related_customer") String relatedCustomer; - /** Token referencing a Customer Account resource. */ + /** The ID of the Account representing a customer. */ @SerializedName("related_customer_account") String relatedCustomerAccount; @@ -68,7 +68,7 @@ public class VerificationSessionCreateParams extends ApiRequestParams { String returnUrl; /** - * The type of verification + * The type of verification * check to be performed. You must provide a {@code type} if not passing {@code * verification_flow}. */ @@ -261,7 +261,7 @@ public Builder setRelatedCustomer(String relatedCustomer) { return this; } - /** Token referencing a Customer Account resource. */ + /** The ID of the Account representing a customer. */ public Builder setRelatedCustomerAccount(String relatedCustomerAccount) { this.relatedCustomerAccount = relatedCustomerAccount; return this; @@ -280,7 +280,7 @@ public Builder setReturnUrl(String returnUrl) { } /** - * The type of verification + * The type of verification * check to be performed. You must provide a {@code type} if not passing {@code * verification_flow}. */ @@ -304,7 +304,7 @@ public Builder setVerificationFlow(String verificationFlow) { public static class Options { /** * Options that apply to the document check. + * href="https://docs.stripe.com/identity/verification-checks?type=document">document check. */ @SerializedName("document") Object document; @@ -339,7 +339,7 @@ public VerificationSessionCreateParams.Options build() { /** * Options that apply to the document + * href="https://docs.stripe.com/identity/verification-checks?type=document">document * check. */ public Builder setDocument(VerificationSessionCreateParams.Options.Document document) { @@ -349,7 +349,7 @@ public Builder setDocument(VerificationSessionCreateParams.Options.Document docu /** * Options that apply to the document + * href="https://docs.stripe.com/identity/verification-checks?type=document">document * check. */ public Builder setDocument(EmptyParam document) { @@ -407,7 +407,7 @@ public static class Document { /** * 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") @@ -422,9 +422,9 @@ public static class Document { /** * 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; @@ -527,7 +527,7 @@ public Builder putAllExtraParam(Map map) { /** * 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. */ public Builder setRequireIdNumber(Boolean requireIdNumber) { @@ -546,9 +546,9 @@ public Builder setRequireLiveCapture(Boolean requireLiveCapture) { /** * 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. */ public Builder setRequireMatchingSelfie(Boolean requireMatchingSelfie) { this.requireMatchingSelfie = requireMatchingSelfie; diff --git a/src/main/java/com/stripe/param/identity/VerificationSessionListParams.java b/src/main/java/com/stripe/param/identity/VerificationSessionListParams.java index f0334bdcb56..a7c17008fa8 100644 --- a/src/main/java/com/stripe/param/identity/VerificationSessionListParams.java +++ b/src/main/java/com/stripe/param/identity/VerificationSessionListParams.java @@ -53,9 +53,11 @@ public class VerificationSessionListParams extends ApiRequestParams { @SerializedName("limit") Long limit; + /** Customer ID. */ @SerializedName("related_customer") String relatedCustomer; + /** The ID of the Account representing a customer. */ @SerializedName("related_customer_account") String relatedCustomerAccount; @@ -70,7 +72,7 @@ public class VerificationSessionListParams extends ApiRequestParams { /** * Only return VerificationSessions with this status. Learn more about the lifecycle of + * href="https://docs.stripe.com/identity/how-sessions-work">Learn more about the lifecycle of * sessions. */ @SerializedName("status") @@ -232,11 +234,13 @@ public Builder setLimit(Long limit) { return this; } + /** Customer ID. */ public Builder setRelatedCustomer(String relatedCustomer) { this.relatedCustomer = relatedCustomer; return this; } + /** The ID of the Account representing a customer. */ public Builder setRelatedCustomerAccount(String relatedCustomerAccount) { this.relatedCustomerAccount = relatedCustomerAccount; return this; @@ -255,7 +259,7 @@ public Builder setStartingAfter(String startingAfter) { /** * Only return VerificationSessions with this status. Learn more about the lifecycle of + * href="https://docs.stripe.com/identity/how-sessions-work">Learn more about the lifecycle of * sessions. */ public Builder setStatus(VerificationSessionListParams.Status status) { diff --git a/src/main/java/com/stripe/param/identity/VerificationSessionUpdateParams.java b/src/main/java/com/stripe/param/identity/VerificationSessionUpdateParams.java index bf07c171f90..7566d74d641 100644 --- a/src/main/java/com/stripe/param/identity/VerificationSessionUpdateParams.java +++ b/src/main/java/com/stripe/param/identity/VerificationSessionUpdateParams.java @@ -28,7 +28,7 @@ public class VerificationSessionUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -45,7 +45,7 @@ public class VerificationSessionUpdateParams extends ApiRequestParams { ProvidedDetails providedDetails; /** - * The type of verification + * The type of verification * check to be performed. */ @SerializedName("type") @@ -186,7 +186,7 @@ public Builder setProvidedDetails( } /** - * The type of verification + * The type of verification * check to be performed. */ public Builder setType(VerificationSessionUpdateParams.Type type) { @@ -200,7 +200,7 @@ public Builder setType(VerificationSessionUpdateParams.Type type) { public static class Options { /** * Options that apply to the document check. + * href="https://docs.stripe.com/identity/verification-checks?type=document">document check. */ @SerializedName("document") Object document; @@ -235,7 +235,7 @@ public VerificationSessionUpdateParams.Options build() { /** * Options that apply to the document + * href="https://docs.stripe.com/identity/verification-checks?type=document">document * check. */ public Builder setDocument(VerificationSessionUpdateParams.Options.Document document) { @@ -245,7 +245,7 @@ public Builder setDocument(VerificationSessionUpdateParams.Options.Document docu /** * Options that apply to the document + * href="https://docs.stripe.com/identity/verification-checks?type=document">document * check. */ public Builder setDocument(EmptyParam document) { @@ -303,7 +303,7 @@ public static class Document { /** * 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") @@ -318,9 +318,9 @@ public static class Document { /** * 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; @@ -423,7 +423,7 @@ public Builder putAllExtraParam(Map map) { /** * 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. */ public Builder setRequireIdNumber(Boolean requireIdNumber) { @@ -442,9 +442,9 @@ public Builder setRequireLiveCapture(Boolean requireLiveCapture) { /** * 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. */ public Builder setRequireMatchingSelfie(Boolean requireMatchingSelfie) { this.requireMatchingSelfie = requireMatchingSelfie; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java index aad1ac8a431..95f801d7fc7 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationApproveParams.java @@ -17,7 +17,7 @@ public class AuthorizationApproveParams extends ApiRequestParams { /** * If the authorization's {@code pending_request.is_amount_controllable} property is {@code true}, * you may provide this value to control how much to hold for the authorization. Must be positive - * (use {@code decline} + * (use {@code decline} * to decline an authorization request). */ @SerializedName("amount") @@ -37,7 +37,7 @@ public class AuthorizationApproveParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -75,7 +75,7 @@ public AuthorizationApproveParams build() { /** * If the authorization's {@code pending_request.is_amount_controllable} property is {@code * true}, you may provide this value to control how much to hold for the authorization. Must be - * positive (use {@code + * positive (use {@code * decline} to decline an authorization request). */ public Builder setAmount(Long amount) { @@ -164,7 +164,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -175,7 +175,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationCaptureParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationCaptureParams.java index b214a479047..1d32b5e97d3 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationCaptureParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationCaptureParams.java @@ -17,7 +17,7 @@ public class AuthorizationCaptureParams extends ApiRequestParams { /** * The amount to capture from the authorization. If not provided, the full amount of the * authorization will be captured. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("capture_amount") Long captureAmount; @@ -87,7 +87,7 @@ public AuthorizationCaptureParams build() { /** * The amount to capture from the authorization. If not provided, the full amount of the * authorization will be captured. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setCaptureAmount(Long captureAmount) { this.captureAmount = captureAmount; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationCreateParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationCreateParams.java index 38a837693dc..79c47fc21cd 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationCreateParams.java @@ -17,14 +17,14 @@ public class AuthorizationCreateParams extends ApiRequestParams { /** * The total amount to attempt to authorize. This amount is in the provided currency, or defaults * to the card's currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; /** * 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; @@ -75,7 +75,7 @@ public class AuthorizationCreateParams extends ApiRequestParams { /** * If set {@code true}, you may provide amount + * href="https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount">amount * to control how much to hold for the authorization. */ @SerializedName("is_amount_controllable") @@ -83,7 +83,7 @@ public class AuthorizationCreateParams extends ApiRequestParams { /** * The total amount to attempt to authorize. This amount is in the provided merchant currency, and - * in the smallest currency unit. + * in the smallest currency unit. */ @SerializedName("merchant_amount") Long merchantAmount; @@ -231,7 +231,7 @@ public AuthorizationCreateParams build() { /** * The total amount to attempt to authorize. This amount is in the provided currency, or * defaults to the card's currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -240,7 +240,7 @@ public Builder setAmount(Long amount) { /** * Detailed breakdown of amount components. These amounts are denominated in {@code currency} - * and in the smallest currency + * and in the smallest currency * unit. */ public Builder setAmountDetails(AuthorizationCreateParams.AmountDetails amountDetails) { @@ -348,7 +348,7 @@ public Builder setFuel(AuthorizationCreateParams.Fuel fuel) { /** * If set {@code true}, you may provide amount + * href="https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount">amount * to control how much to hold for the authorization. */ public Builder setIsAmountControllable(Boolean isAmountControllable) { @@ -358,7 +358,7 @@ public Builder setIsAmountControllable(Boolean isAmountControllable) { /** * The total amount to attempt to authorize. This amount is in the provided merchant currency, - * and in the smallest currency + * and in the smallest currency * unit. */ public Builder setMerchantAmount(Long merchantAmount) { @@ -1411,7 +1411,7 @@ public enum Unit implements ApiRequestParams.EnumParam { public static class MerchantData { /** * A categorization of the seller's type of business. See our merchant categories guide for + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide for * a list of possible values. */ @SerializedName("category") @@ -1526,7 +1526,7 @@ public AuthorizationCreateParams.MerchantData build() { /** * A categorization of the seller's type of business. See our merchant categories guide + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide * for a list of possible values. */ public Builder setCategory(AuthorizationCreateParams.MerchantData.Category category) { diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java index 1be5284e117..c08f085ebe5 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationDeclineParams.java @@ -28,7 +28,7 @@ public class AuthorizationDeclineParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationFinalizeAmountParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationFinalizeAmountParams.java index 5dc5ce45511..6d95c153c42 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationFinalizeAmountParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationFinalizeAmountParams.java @@ -30,7 +30,7 @@ public class AuthorizationFinalizeAmountParams extends ApiRequestParams { /** * Required. The final authorization amount that will be captured by the * merchant. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("final_amount") Long finalAmount; @@ -132,7 +132,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The final authorization amount that will be captured by the * merchant. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setFinalAmount(Long finalAmount) { this.finalAmount = finalAmount; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationIncrementParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationIncrementParams.java index a5f080905e5..b3d21e29cd6 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationIncrementParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationIncrementParams.java @@ -29,14 +29,14 @@ public class AuthorizationIncrementParams extends ApiRequestParams { /** * Required. The amount to increment the authorization by. This amount is in the * authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("increment_amount") Long incrementAmount; /** * If set {@code true}, you may provide amount + * href="https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount">amount * to control how much to hold for the authorization. */ @SerializedName("is_amount_controllable") @@ -127,7 +127,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. The amount to increment the authorization by. This amount is in * the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setIncrementAmount(Long incrementAmount) { this.incrementAmount = incrementAmount; @@ -136,7 +136,7 @@ public Builder setIncrementAmount(Long incrementAmount) { /** * If set {@code true}, you may provide amount + * href="https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount">amount * to control how much to hold for the authorization. */ public Builder setIsAmountControllable(Boolean isAmountControllable) { diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationReverseParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationReverseParams.java index a06f0ac03ed..61eb702baf1 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationReverseParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationReverseParams.java @@ -29,7 +29,7 @@ public class AuthorizationReverseParams extends ApiRequestParams { /** * The amount to reverse from the authorization. If not provided, the full amount of the * authorization will be reversed. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("reverse_amount") Long reverseAmount; @@ -112,7 +112,7 @@ public Builder putAllExtraParam(Map map) { /** * The amount to reverse from the authorization. If not provided, the full amount of the * authorization will be reversed. This amount is in the authorization currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setReverseAmount(Long reverseAmount) { this.reverseAmount = reverseAmount; diff --git a/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java b/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java index affaee8bc1b..453a80b5d50 100644 --- a/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/AuthorizationUpdateParams.java @@ -28,7 +28,7 @@ public class AuthorizationUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/CardCreateParams.java b/src/main/java/com/stripe/param/issuing/CardCreateParams.java index f78c4070975..d7679ef3dd1 100644 --- a/src/main/java/com/stripe/param/issuing/CardCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardCreateParams.java @@ -15,7 +15,7 @@ @EqualsAndHashCode(callSuper = false) public class CardCreateParams extends ApiRequestParams { /** - * The Cardholder object with + * The Cardholder object with * which the card will be associated. */ @SerializedName("cardholder") @@ -62,7 +62,7 @@ public class CardCreateParams extends ApiRequestParams { String financialAccount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -98,7 +98,7 @@ public class CardCreateParams extends ApiRequestParams { /** * Rules that control spending for this card. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ @SerializedName("spending_controls") @@ -217,7 +217,7 @@ public CardCreateParams build() { } /** - * The Cardholder object + * The Cardholder object * with which the card will be associated. */ public Builder setCardholder(String cardholder) { @@ -385,7 +385,7 @@ public Builder setShipping(CardCreateParams.Shipping shipping) { /** * Rules that control spending for this card. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ public Builder setSpendingControls(CardCreateParams.SpendingControls spendingControls) { @@ -696,7 +696,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -811,7 +814,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1024,7 +1030,7 @@ public enum Type implements ApiRequestParams.EnumParam { public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -1042,7 +1048,7 @@ public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -1290,7 +1296,7 @@ public static class SpendingLimit { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/param/issuing/CardListParams.java b/src/main/java/com/stripe/param/issuing/CardListParams.java index 09ddf76da72..55cf866b356 100644 --- a/src/main/java/com/stripe/param/issuing/CardListParams.java +++ b/src/main/java/com/stripe/param/issuing/CardListParams.java @@ -85,6 +85,10 @@ public class CardListParams extends ApiRequestParams { @SerializedName("type") Type type; + /** Filter cards by wallet settings. */ + @SerializedName("wallets") + Wallets wallets; + private CardListParams( String cardholder, Object created, @@ -98,7 +102,8 @@ private CardListParams( String personalizationDesign, String startingAfter, Status status, - Type type) { + Type type, + Wallets wallets) { this.cardholder = cardholder; this.created = created; this.endingBefore = endingBefore; @@ -112,6 +117,7 @@ private CardListParams( this.startingAfter = startingAfter; this.status = status; this.type = type; + this.wallets = wallets; } public static Builder builder() { @@ -145,6 +151,8 @@ public static class Builder { private Type type; + private Wallets wallets; + /** Finalize and obtain parameter instance from this builder. */ public CardListParams build() { return new CardListParams( @@ -160,7 +168,8 @@ public CardListParams build() { this.personalizationDesign, this.startingAfter, this.status, - this.type); + this.type, + this.wallets); } /** Only return cards belonging to the Cardholder with the provided ID. */ @@ -301,6 +310,12 @@ public Builder setType(CardListParams.Type type) { this.type = type; return this; } + + /** Filter cards by wallet settings. */ + public Builder setWallets(CardListParams.Wallets wallets) { + this.wallets = wallets; + return this; + } } @Getter @@ -411,6 +426,230 @@ public Builder setLte(Long lte) { } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Wallets { + /** Filter cards by Apple Pay wallet details. */ + @SerializedName("apple_pay") + ApplePay applePay; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Filter cards by Google Pay wallet details. */ + @SerializedName("google_pay") + GooglePay googlePay; + + private Wallets(ApplePay applePay, Map extraParams, GooglePay googlePay) { + this.applePay = applePay; + this.extraParams = extraParams; + this.googlePay = googlePay; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private ApplePay applePay; + + private Map extraParams; + + private GooglePay googlePay; + + /** Finalize and obtain parameter instance from this builder. */ + public CardListParams.Wallets build() { + return new CardListParams.Wallets(this.applePay, this.extraParams, this.googlePay); + } + + /** Filter cards by Apple Pay wallet details. */ + public Builder setApplePay(CardListParams.Wallets.ApplePay applePay) { + this.applePay = applePay; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * CardListParams.Wallets#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link CardListParams.Wallets#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Filter cards by Google Pay wallet details. */ + public Builder setGooglePay(CardListParams.Wallets.GooglePay googlePay) { + this.googlePay = googlePay; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class ApplePay { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Query by Apple Pay primary account identifier. */ + @SerializedName("primary_account_identifier") + String primaryAccountIdentifier; + + private ApplePay(Map extraParams, String primaryAccountIdentifier) { + this.extraParams = extraParams; + this.primaryAccountIdentifier = primaryAccountIdentifier; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String primaryAccountIdentifier; + + /** Finalize and obtain parameter instance from this builder. */ + public CardListParams.Wallets.ApplePay build() { + return new CardListParams.Wallets.ApplePay( + this.extraParams, this.primaryAccountIdentifier); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link CardListParams.Wallets.ApplePay#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link CardListParams.Wallets.ApplePay#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Query by Apple Pay primary account identifier. */ + public Builder setPrimaryAccountIdentifier(String primaryAccountIdentifier) { + this.primaryAccountIdentifier = primaryAccountIdentifier; + return this; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class GooglePay { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Query by Google Pay primary account identifier. */ + @SerializedName("primary_account_identifier") + String primaryAccountIdentifier; + + private GooglePay(Map extraParams, String primaryAccountIdentifier) { + this.extraParams = extraParams; + this.primaryAccountIdentifier = primaryAccountIdentifier; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String primaryAccountIdentifier; + + /** Finalize and obtain parameter instance from this builder. */ + public CardListParams.Wallets.GooglePay build() { + return new CardListParams.Wallets.GooglePay( + this.extraParams, this.primaryAccountIdentifier); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link CardListParams.Wallets.GooglePay#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link CardListParams.Wallets.GooglePay#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Query by Google Pay primary account identifier. */ + public Builder setPrimaryAccountIdentifier(String primaryAccountIdentifier) { + this.primaryAccountIdentifier = primaryAccountIdentifier; + return this; + } + } + } + } + public enum Status implements ApiRequestParams.EnumParam { @SerializedName("active") ACTIVE("active"), diff --git a/src/main/java/com/stripe/param/issuing/CardUpdateParams.java b/src/main/java/com/stripe/param/issuing/CardUpdateParams.java index 93be37b2f14..6c584cec1bf 100644 --- a/src/main/java/com/stripe/param/issuing/CardUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardUpdateParams.java @@ -32,7 +32,7 @@ public class CardUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -53,7 +53,7 @@ public class CardUpdateParams extends ApiRequestParams { /** * Rules that control spending for this card. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ @SerializedName("spending_controls") @@ -213,7 +213,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -224,7 +224,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -258,7 +258,7 @@ public Builder setShipping(CardUpdateParams.Shipping shipping) { /** * Rules that control spending for this card. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ public Builder setSpendingControls(CardUpdateParams.SpendingControls spendingControls) { @@ -582,7 +582,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -732,13 +735,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -960,7 +969,7 @@ public enum Type implements ApiRequestParams.EnumParam { public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -978,7 +987,7 @@ public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -1226,7 +1235,7 @@ public static class SpendingLimit { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java b/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java index 2203bd6c985..9cd961d5464 100644 --- a/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardholderCreateParams.java @@ -44,7 +44,7 @@ public class CardholderCreateParams extends ApiRequestParams { Individual individual; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -66,7 +66,7 @@ public class CardholderCreateParams extends ApiRequestParams { * already. This is required for all cardholders who will be creating EU cards. While phone number * is optional if the cardholder will not be creating EU cards, note that this cardholder will not * be eligible for 3DS without a phone number. See the 3D Secure + * href="https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied">3D Secure * documentation for more details. */ @SerializedName("phone_number") @@ -75,7 +75,7 @@ public class CardholderCreateParams extends ApiRequestParams { /** * The cardholder’s preferred locales (languages), ordered by preference. Locales can be {@code * de}, {@code en}, {@code es}, {@code fr}, or {@code it}. This changes the language of the 3D Secure flow and one-time password + * href="https://docs.stripe.com/issuing/3d-secure">3D Secure flow and one-time password * messages sent to the cardholder. */ @SerializedName("preferred_locales") @@ -83,7 +83,7 @@ public class CardholderCreateParams extends ApiRequestParams { /** * Rules that control spending across this cardholder's cards. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ @SerializedName("spending_controls") @@ -98,7 +98,7 @@ public class CardholderCreateParams extends ApiRequestParams { /** * One of {@code individual} or {@code company}. See Choose a cardholder type for + * href="https://docs.stripe.com/issuing/other/choose-cardholder">Choose a cardholder type for * more details. */ @SerializedName("type") @@ -300,7 +300,7 @@ public Builder setName(String name) { * already. This is required for all cardholders who will be creating EU cards. While phone * number is optional if the cardholder will not be creating EU cards, note that this cardholder * will not be eligible for 3DS without a phone number. See the 3D Secure + * href="https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied">3D Secure * documentation for more details. */ public Builder setPhoneNumber(String phoneNumber) { @@ -336,7 +336,7 @@ public Builder addAllPreferredLocale(Listdocumentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ public Builder setSpendingControls(CardholderCreateParams.SpendingControls spendingControls) { @@ -355,7 +355,7 @@ public Builder setStatus(CardholderCreateParams.Status status) { /** * One of {@code individual} or {@code company}. See Choose a cardholder type + * href="https://docs.stripe.com/issuing/other/choose-cardholder">Choose a cardholder type * for more details. */ public Builder setType(CardholderCreateParams.Type type) { @@ -467,7 +467,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -582,7 +585,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1193,7 +1199,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @@ -1210,7 +1216,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") @@ -1240,7 +1246,7 @@ public CardholderCreateParams.Individual.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(String back) { @@ -1277,7 +1283,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(String front) { @@ -1294,7 +1300,7 @@ public Builder setFront(String front) { public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -1312,7 +1318,7 @@ public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -1585,7 +1591,7 @@ public static class SpendingLimit { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java b/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java index a4717d2427f..ce9031c30c7 100644 --- a/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/CardholderUpdateParams.java @@ -44,7 +44,7 @@ public class CardholderUpdateParams extends ApiRequestParams { Individual individual; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -54,7 +54,7 @@ public class CardholderUpdateParams extends ApiRequestParams { /** * The cardholder's phone number. This is required for all cardholders who will be creating EU - * cards. See the 3D Secure documentation + * cards. See the 3D Secure documentation * for more details. */ @SerializedName("phone_number") @@ -63,7 +63,7 @@ public class CardholderUpdateParams extends ApiRequestParams { /** * The cardholder’s preferred locales (languages), ordered by preference. Locales can be {@code * de}, {@code en}, {@code es}, {@code fr}, or {@code it}. This changes the language of the 3D Secure flow and one-time password + * href="https://docs.stripe.com/issuing/3d-secure">3D Secure flow and one-time password * messages sent to the cardholder. */ @SerializedName("preferred_locales") @@ -71,7 +71,7 @@ public class CardholderUpdateParams extends ApiRequestParams { /** * Rules that control spending across this cardholder's cards. Refer to our documentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ @SerializedName("spending_controls") @@ -259,7 +259,7 @@ public Builder putAllMetadata(Map map) { /** * The cardholder's phone number. This is required for all cardholders who will be creating EU - * cards. See the 3D Secure + * cards. See the 3D Secure * documentation for more details. */ public Builder setPhoneNumber(String phoneNumber) { @@ -269,7 +269,7 @@ public Builder setPhoneNumber(String phoneNumber) { /** * The cardholder's phone number. This is required for all cardholders who will be creating EU - * cards. See the 3D Secure + * cards. See the 3D Secure * documentation for more details. */ public Builder setPhoneNumber(EmptyParam phoneNumber) { @@ -305,7 +305,7 @@ public Builder addAllPreferredLocale(Listdocumentation for more + * href="https://docs.stripe.com/issuing/controls/spending-controls">documentation for more * details. */ public Builder setSpendingControls(CardholderUpdateParams.SpendingControls spendingControls) { @@ -423,7 +423,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -573,13 +576,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; @@ -1225,7 +1234,7 @@ public Builder putAllExtraParam(Map map) { @EqualsAndHashCode(callSuper = false) public static class Document { /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("back") @@ -1242,7 +1251,7 @@ public static class Document { Map extraParams; /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ @SerializedName("front") @@ -1272,7 +1281,7 @@ public CardholderUpdateParams.Individual.Verification.Document build() { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(String back) { @@ -1281,7 +1290,7 @@ public Builder setBack(String back) { } /** - * The back of an ID returned by a file + * The back of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setBack(EmptyParam back) { @@ -1318,7 +1327,7 @@ public Builder putAllExtraParam(Map map) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(String front) { @@ -1327,7 +1336,7 @@ public Builder setFront(String front) { } /** - * The front of an ID returned by a file + * The front of an ID returned by a file * upload with a {@code purpose} value of {@code identity_document}. */ public Builder setFront(EmptyParam front) { @@ -1344,7 +1353,7 @@ public Builder setFront(EmptyParam front) { public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to allow. All other categories will be blocked. Cannot be set with {@code * blocked_categories}. */ @@ -1362,7 +1371,7 @@ public static class SpendingControls { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * of authorizations to decline. All other categories will be allowed. Cannot be set with {@code * allowed_categories}. */ @@ -1644,7 +1653,7 @@ public static class SpendingLimit { /** * Array of strings containing categories + * href="https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category">categories * this limit applies to. Omitting this field will apply the limit to all categories. */ @SerializedName("categories") diff --git a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCorrectParams.java b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCorrectParams.java index ac60f6f8b2d..2e72117e70d 100644 --- a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCorrectParams.java +++ b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCorrectParams.java @@ -43,7 +43,7 @@ public class CreditUnderwritingRecordCorrectParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -54,7 +54,7 @@ public class CreditUnderwritingRecordCorrectParams extends ApiRequestParams { /** * 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. Optional if previously provided and no changes are needed. */ @SerializedName("regulatory_reporting_file") @@ -231,7 +231,7 @@ public Builder putAllMetadata(Map map) { /** * 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. Optional if previously provided and no changes are needed. */ public Builder setRegulatoryReportingFile(String regulatoryReportingFile) { @@ -489,7 +489,7 @@ public static class Decision { /** * Details about the credit limit approved. An approved credit limit is required before you can * set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ @SerializedName("credit_limit_approved") CreditLimitApproved creditLimitApproved; @@ -568,7 +568,7 @@ public Builder setApplicationRejected( /** * Details about the credit limit approved. An approved credit limit is required before you * can set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ public Builder setCreditLimitApproved( CreditUnderwritingRecordCorrectParams.Decision.CreditLimitApproved creditLimitApproved) { @@ -947,7 +947,7 @@ public enum Reason implements ApiRequestParams.EnumParam { public static class CreditLimitApproved { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -990,7 +990,7 @@ public CreditUnderwritingRecordCorrectParams.Decision.CreditLimitApproved build( /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -1040,7 +1040,7 @@ public Builder putAllExtraParam(Map map) { public static class CreditLimitDecreased { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -1111,7 +1111,7 @@ public CreditUnderwritingRecordCorrectParams.Decision.CreditLimitDecreased build /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; diff --git a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromApplicationParams.java b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromApplicationParams.java index 0ed4baba11c..f1cd19c19f4 100644 --- a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromApplicationParams.java +++ b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromApplicationParams.java @@ -38,7 +38,7 @@ public class CreditUnderwritingRecordCreateFromApplicationParams extends ApiRequ Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromProactiveReviewParams.java b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromProactiveReviewParams.java index 9d1a924819c..24a394b035a 100644 --- a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromProactiveReviewParams.java +++ b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordCreateFromProactiveReviewParams.java @@ -42,7 +42,7 @@ public class CreditUnderwritingRecordCreateFromProactiveReviewParams extends Api Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -53,7 +53,7 @@ public class CreditUnderwritingRecordCreateFromProactiveReviewParams extends Api /** * 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") @@ -228,7 +228,7 @@ public Builder putAllMetadata(Map map) { /** * 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. */ public Builder setRegulatoryReportingFile(String regulatoryReportingFile) { @@ -340,7 +340,7 @@ public static class Decision { /** * Details about the credit limit approved. An approved credit limit is required before you can * set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ @SerializedName("credit_limit_approved") CreditLimitApproved creditLimitApproved; @@ -407,7 +407,7 @@ public CreditUnderwritingRecordCreateFromProactiveReviewParams.Decision build() /** * Details about the credit limit approved. An approved credit limit is required before you * can set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ public Builder setCreditLimitApproved( CreditUnderwritingRecordCreateFromProactiveReviewParams.Decision.CreditLimitApproved @@ -473,7 +473,7 @@ public Builder setType( public static class CreditLimitApproved { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -517,7 +517,7 @@ public static class Builder { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -567,7 +567,7 @@ public Builder putAllExtraParam(Map map) { public static class CreditLimitDecreased { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -647,7 +647,7 @@ public static class Builder { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; diff --git a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordReportDecisionParams.java b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordReportDecisionParams.java index 0062253f9aa..758c703f247 100644 --- a/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordReportDecisionParams.java +++ b/src/main/java/com/stripe/param/issuing/CreditUnderwritingRecordReportDecisionParams.java @@ -35,7 +35,7 @@ public class CreditUnderwritingRecordReportDecisionParams extends ApiRequestPara Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -46,7 +46,7 @@ public class CreditUnderwritingRecordReportDecisionParams extends ApiRequestPara /** * 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") @@ -203,7 +203,7 @@ public Builder putAllMetadata(Map map) { /** * 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. */ public Builder setRegulatoryReportingFile(String regulatoryReportingFile) { @@ -233,7 +233,7 @@ public static class Decision { /** * Details about the credit limit approved. An approved credit limit is required before you can * set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ @SerializedName("credit_limit_approved") CreditLimitApproved creditLimitApproved; @@ -292,7 +292,7 @@ public Builder setApplicationRejected( /** * Details about the credit limit approved. An approved credit limit is required before you * can set a {@code credit_limit_amount} in the CreditPolicy API + * href="https://docs.stripe.com/api/issuing/credit_policy/">CreditPolicy API */ public Builder setCreditLimitApproved( CreditUnderwritingRecordReportDecisionParams.Decision.CreditLimitApproved @@ -662,7 +662,7 @@ public enum Reason implements ApiRequestParams.EnumParam { public static class CreditLimitApproved { /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -705,7 +705,7 @@ public CreditUnderwritingRecordReportDecisionParams.Decision.CreditLimitApproved /** * Required. The credit approved, in the currency of the account and smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; diff --git a/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java b/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java index aeaf893610a..cb24788db75 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeCreateParams.java @@ -16,7 +16,7 @@ public class DisputeCreateParams extends ApiRequestParams { /** * The dispute amount in the card's currency and in the smallest currency unit. If not set, + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. If not set, * defaults to the full transaction amount. */ @SerializedName("amount") @@ -40,7 +40,7 @@ public class DisputeCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -109,7 +109,7 @@ public DisputeCreateParams build() { /** * The dispute amount in the card's currency and in the smallest currency unit. If not + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. If not * set, defaults to the full transaction amount. */ public Builder setAmount(Long amount) { diff --git a/src/main/java/com/stripe/param/issuing/DisputeSubmitParams.java b/src/main/java/com/stripe/param/issuing/DisputeSubmitParams.java index 5b8477283fb..43ff46854e7 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeSubmitParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeSubmitParams.java @@ -28,7 +28,7 @@ public class DisputeSubmitParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java b/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java index cf10bae0c5c..a4558e5088a 100644 --- a/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/DisputeUpdateParams.java @@ -16,7 +16,7 @@ public class DisputeUpdateParams extends ApiRequestParams { /** * The dispute amount in the card's currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -39,7 +39,7 @@ public class DisputeUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -83,7 +83,7 @@ public DisputeUpdateParams build() { /** * The dispute amount in the card's currency and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -177,7 +177,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -188,7 +188,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/PersonalizationDesignCreateParams.java b/src/main/java/com/stripe/param/issuing/PersonalizationDesignCreateParams.java index d22389bf3f4..b01b33da6ed 100644 --- a/src/main/java/com/stripe/param/issuing/PersonalizationDesignCreateParams.java +++ b/src/main/java/com/stripe/param/issuing/PersonalizationDesignCreateParams.java @@ -46,7 +46,7 @@ public class PersonalizationDesignCreateParams extends ApiRequestParams { String lookupKey; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/PersonalizationDesignUpdateParams.java b/src/main/java/com/stripe/param/issuing/PersonalizationDesignUpdateParams.java index 72bcf080269..f60f1743518 100644 --- a/src/main/java/com/stripe/param/issuing/PersonalizationDesignUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/PersonalizationDesignUpdateParams.java @@ -46,7 +46,7 @@ public class PersonalizationDesignUpdateParams extends ApiRequestParams { Object lookupKey; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/ProgramUpdateParams.java b/src/main/java/com/stripe/param/issuing/ProgramUpdateParams.java index 02fa170111e..f02138a6002 100644 --- a/src/main/java/com/stripe/param/issuing/ProgramUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/ProgramUpdateParams.java @@ -32,7 +32,7 @@ public class ProgramUpdateParams extends ApiRequestParams { Boolean isDefault; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -153,7 +153,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -164,7 +164,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/issuing/TransactionCreateForceCaptureParams.java b/src/main/java/com/stripe/param/issuing/TransactionCreateForceCaptureParams.java index 6cbe0105eec..89744cea041 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionCreateForceCaptureParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionCreateForceCaptureParams.java @@ -17,7 +17,7 @@ public class TransactionCreateForceCaptureParams extends ApiRequestParams { /** * Required. The total amount to attempt to capture. This amount is in the * provided currency, or defaults to the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -109,7 +109,7 @@ public TransactionCreateForceCaptureParams build() { /** * Required. The total amount to attempt to capture. This amount is in the * provided currency, or defaults to the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -207,7 +207,7 @@ public Builder setPurchaseDetails( public static class MerchantData { /** * A categorization of the seller's type of business. See our merchant categories guide for + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide for * a list of possible values. */ @SerializedName("category") @@ -322,7 +322,7 @@ public TransactionCreateForceCaptureParams.MerchantData build() { /** * A categorization of the seller's type of business. See our merchant categories guide + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide * for a list of possible values. */ public Builder setCategory( diff --git a/src/main/java/com/stripe/param/issuing/TransactionCreateUnlinkedRefundParams.java b/src/main/java/com/stripe/param/issuing/TransactionCreateUnlinkedRefundParams.java index 661623918f6..3927c4f1dfc 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionCreateUnlinkedRefundParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionCreateUnlinkedRefundParams.java @@ -17,7 +17,7 @@ public class TransactionCreateUnlinkedRefundParams extends ApiRequestParams { /** * Required. The total amount to attempt to refund. This amount is in the * provided currency, or defaults to the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -109,7 +109,7 @@ public TransactionCreateUnlinkedRefundParams build() { /** * Required. The total amount to attempt to refund. This amount is in the * provided currency, or defaults to the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; @@ -208,7 +208,7 @@ public Builder setPurchaseDetails( public static class MerchantData { /** * A categorization of the seller's type of business. See our merchant categories guide for + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide for * a list of possible values. */ @SerializedName("category") @@ -323,7 +323,7 @@ public TransactionCreateUnlinkedRefundParams.MerchantData build() { /** * A categorization of the seller's type of business. See our merchant categories guide + * href="https://docs.stripe.com/issuing/merchant-categories">merchant categories guide * for a list of possible values. */ public Builder setCategory( diff --git a/src/main/java/com/stripe/param/issuing/TransactionRefundParams.java b/src/main/java/com/stripe/param/issuing/TransactionRefundParams.java index 6b23d687ce1..496ca0ae69d 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionRefundParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionRefundParams.java @@ -29,7 +29,7 @@ public class TransactionRefundParams extends ApiRequestParams { /** * The total amount to attempt to refund. This amount is in the provided currency, or defaults to * the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("refund_amount") Long refundAmount; @@ -112,7 +112,7 @@ public Builder putAllExtraParam(Map map) { /** * The total amount to attempt to refund. This amount is in the provided currency, or defaults * to the cards currency, and in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setRefundAmount(Long refundAmount) { this.refundAmount = refundAmount; diff --git a/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java b/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java index 499daf657e7..dfd00860058 100644 --- a/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java +++ b/src/main/java/com/stripe/param/issuing/TransactionUpdateParams.java @@ -28,7 +28,7 @@ public class TransactionUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -140,7 +140,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -151,7 +151,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/radar/ValueListCreateParams.java b/src/main/java/com/stripe/param/radar/ValueListCreateParams.java index 2d5324dcde4..9e056deef5d 100644 --- a/src/main/java/com/stripe/param/radar/ValueListCreateParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListCreateParams.java @@ -40,7 +40,7 @@ public class ValueListCreateParams extends ApiRequestParams { ItemType itemType; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java b/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java index 0a4488796e4..29b56a14e5a 100644 --- a/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java +++ b/src/main/java/com/stripe/param/radar/ValueListUpdateParams.java @@ -32,7 +32,7 @@ public class ValueListUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java b/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java index ff66424a18b..86b36ad3099 100644 --- a/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java +++ b/src/main/java/com/stripe/param/reporting/ReportRunCreateParams.java @@ -29,7 +29,7 @@ public class ReportRunCreateParams extends ApiRequestParams { /** * Parameters specifying how the report should be run. Different Report Types have different * required and optional parameters, listed in the API Access to Reports + * href="https://docs.stripe.com/reporting/statements/api">API Access to Reports * documentation. */ @SerializedName("parameters") @@ -37,7 +37,7 @@ public class ReportRunCreateParams extends ApiRequestParams { /** * Required. The ID of the report type to run, + * href="https://docs.stripe.com/reporting/statements/api#report-types">report type to run, * such as {@code "balance.summary.1"}. */ @SerializedName("report_type") @@ -128,7 +128,7 @@ public Builder putAllExtraParam(Map map) { /** * Parameters specifying how the report should be run. Different Report Types have different * required and optional parameters, listed in the API Access to Reports + * href="https://docs.stripe.com/reporting/statements/api">API Access to Reports * documentation. */ public Builder setParameters(ReportRunCreateParams.Parameters parameters) { @@ -138,7 +138,7 @@ public Builder setParameters(ReportRunCreateParams.Parameters parameters) { /** * Required. The ID of the report type to run, + * href="https://docs.stripe.com/reporting/statements/api#report-types">report type to run, * such as {@code "balance.summary.1"}. */ public Builder setReportType(String reportType) { diff --git a/src/main/java/com/stripe/param/sharedpayment/GrantedTokenCreateParams.java b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenCreateParams.java new file mode 100644 index 00000000000..18398d3e454 --- /dev/null +++ b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenCreateParams.java @@ -0,0 +1,333 @@ +// File generated from our OpenAPI spec +package com.stripe.param.sharedpayment; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import com.stripe.param.common.EmptyParam; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class GrantedTokenCreateParams extends ApiRequestParams { + /** + * The Customer that the SharedPaymentGrantedToken belongs to. Should match the Customer that the + * PaymentMethod is attached to if any. + */ + @SerializedName("customer") + String customer; + + /** Specifies which fields in the response should be expanded. */ + @SerializedName("expand") + List expand; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. The PaymentMethod that is going to be shared by the + * SharedPaymentGrantedToken. + */ + @SerializedName("payment_method") + String paymentMethod; + + /** + * Set of key-value pairs that you can attach + * to the SharedPaymentGrantedToken. + */ + @SerializedName("shared_metadata") + Object sharedMetadata; + + /** Required. Limits on how this SharedPaymentGrantedToken can be used. */ + @SerializedName("usage_limits") + UsageLimits usageLimits; + + private GrantedTokenCreateParams( + String customer, + List expand, + Map extraParams, + String paymentMethod, + Object sharedMetadata, + UsageLimits usageLimits) { + this.customer = customer; + this.expand = expand; + this.extraParams = extraParams; + this.paymentMethod = paymentMethod; + this.sharedMetadata = sharedMetadata; + this.usageLimits = usageLimits; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String customer; + + private List expand; + + private Map extraParams; + + private String paymentMethod; + + private Object sharedMetadata; + + private UsageLimits usageLimits; + + /** Finalize and obtain parameter instance from this builder. */ + public GrantedTokenCreateParams build() { + return new GrantedTokenCreateParams( + this.customer, + this.expand, + this.extraParams, + this.paymentMethod, + this.sharedMetadata, + this.usageLimits); + } + + /** + * The Customer that the SharedPaymentGrantedToken belongs to. Should match the Customer that + * the PaymentMethod is attached to if any. + */ + public Builder setCustomer(String customer) { + this.customer = customer; + return this; + } + + /** + * Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenCreateParams#expand} for the field documentation. + */ + public Builder addExpand(String element) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.add(element); + return this; + } + + /** + * Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenCreateParams#expand} for the field documentation. + */ + public Builder addAllExpand(List elements) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.addAll(elements); + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * GrantedTokenCreateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link GrantedTokenCreateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. The PaymentMethod that is going to be shared by the + * SharedPaymentGrantedToken. + */ + public Builder setPaymentMethod(String paymentMethod) { + this.paymentMethod = paymentMethod; + return this; + } + + /** + * Add a key/value pair to `sharedMetadata` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * GrantedTokenCreateParams#sharedMetadata} for the field documentation. + */ + @SuppressWarnings("unchecked") + public Builder putSharedMetadata(String key, String value) { + if (this.sharedMetadata == null || this.sharedMetadata instanceof EmptyParam) { + this.sharedMetadata = new HashMap(); + } + ((Map) this.sharedMetadata).put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `sharedMetadata` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link GrantedTokenCreateParams#sharedMetadata} for the field documentation. + */ + @SuppressWarnings("unchecked") + public Builder putAllSharedMetadata(Map map) { + if (this.sharedMetadata == null || this.sharedMetadata instanceof EmptyParam) { + this.sharedMetadata = new HashMap(); + } + ((Map) this.sharedMetadata).putAll(map); + return this; + } + + /** + * Set of key-value pairs that you can attach + * to the SharedPaymentGrantedToken. + */ + public Builder setSharedMetadata(EmptyParam sharedMetadata) { + this.sharedMetadata = sharedMetadata; + return this; + } + + /** + * Set of key-value pairs that you can attach + * to the SharedPaymentGrantedToken. + */ + public Builder setSharedMetadata(Map sharedMetadata) { + this.sharedMetadata = sharedMetadata; + return this; + } + + /** Required. Limits on how this SharedPaymentGrantedToken can be used. */ + public Builder setUsageLimits(GrantedTokenCreateParams.UsageLimits usageLimits) { + this.usageLimits = usageLimits; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class UsageLimits { + /** + * Required. Three-letter ISO currency code, in lowercase. + * Must be a supported currency. + */ + @SerializedName("currency") + String currency; + + /** + * Required. Time at which this SharedPaymentToken expires and can no longer be + * used to confirm a PaymentIntent. + */ + @SerializedName("expires_at") + Long expiresAt; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. Max amount that can be captured using this SharedPaymentToken */ + @SerializedName("max_amount") + Long maxAmount; + + private UsageLimits( + String currency, Long expiresAt, Map extraParams, Long maxAmount) { + this.currency = currency; + this.expiresAt = expiresAt; + this.extraParams = extraParams; + this.maxAmount = maxAmount; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String currency; + + private Long expiresAt; + + private Map extraParams; + + private Long maxAmount; + + /** Finalize and obtain parameter instance from this builder. */ + public GrantedTokenCreateParams.UsageLimits build() { + return new GrantedTokenCreateParams.UsageLimits( + this.currency, this.expiresAt, this.extraParams, this.maxAmount); + } + + /** + * Required. Three-letter ISO currency code, in + * lowercase. Must be a supported currency. + */ + public Builder setCurrency(String currency) { + this.currency = currency; + return this; + } + + /** + * Required. Time at which this SharedPaymentToken expires and can no longer + * be used to confirm a PaymentIntent. + */ + public Builder setExpiresAt(Long expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * GrantedTokenCreateParams.UsageLimits#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link GrantedTokenCreateParams.UsageLimits#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. Max amount that can be captured using this SharedPaymentToken + */ + public Builder setMaxAmount(Long maxAmount) { + this.maxAmount = maxAmount; + return this; + } + } + } +} diff --git a/src/main/java/com/stripe/param/sharedpayment/GrantedTokenRetrieveParams.java b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenRetrieveParams.java new file mode 100644 index 00000000000..79cccfd847e --- /dev/null +++ b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenRetrieveParams.java @@ -0,0 +1,100 @@ +// File generated from our OpenAPI spec +package com.stripe.param.sharedpayment; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class GrantedTokenRetrieveParams extends ApiRequestParams { + /** Specifies which fields in the response should be expanded. */ + @SerializedName("expand") + List expand; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private GrantedTokenRetrieveParams(List expand, Map extraParams) { + this.expand = expand; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private List expand; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public GrantedTokenRetrieveParams build() { + return new GrantedTokenRetrieveParams(this.expand, this.extraParams); + } + + /** + * Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenRetrieveParams#expand} for the field documentation. + */ + public Builder addExpand(String element) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.add(element); + return this; + } + + /** + * Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenRetrieveParams#expand} for the field documentation. + */ + public Builder addAllExpand(List elements) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.addAll(elements); + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * GrantedTokenRetrieveParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link GrantedTokenRetrieveParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } +} diff --git a/src/main/java/com/stripe/param/sharedpayment/GrantedTokenUpdateParams.java b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenUpdateParams.java new file mode 100644 index 00000000000..032845acc7b --- /dev/null +++ b/src/main/java/com/stripe/param/sharedpayment/GrantedTokenUpdateParams.java @@ -0,0 +1,100 @@ +// File generated from our OpenAPI spec +package com.stripe.param.sharedpayment; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class GrantedTokenUpdateParams extends ApiRequestParams { + /** Specifies which fields in the response should be expanded. */ + @SerializedName("expand") + List expand; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private GrantedTokenUpdateParams(List expand, Map extraParams) { + this.expand = expand; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private List expand; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public GrantedTokenUpdateParams build() { + return new GrantedTokenUpdateParams(this.expand, this.extraParams); + } + + /** + * Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenUpdateParams#expand} for the field documentation. + */ + public Builder addExpand(String element) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.add(element); + return this; + } + + /** + * Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * GrantedTokenUpdateParams#expand} for the field documentation. + */ + public Builder addAllExpand(List elements) { + if (this.expand == null) { + this.expand = new ArrayList<>(); + } + this.expand.addAll(elements); + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * GrantedTokenUpdateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link GrantedTokenUpdateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } +} diff --git a/src/main/java/com/stripe/param/tax/AssociationFindParams.java b/src/main/java/com/stripe/param/tax/AssociationFindParams.java index 772b96a0c5d..4986e4489c2 100644 --- a/src/main/java/com/stripe/param/tax/AssociationFindParams.java +++ b/src/main/java/com/stripe/param/tax/AssociationFindParams.java @@ -28,7 +28,7 @@ public class AssociationFindParams extends ApiRequestParams { /** * Required. Valid PaymentIntent id + * href="https://docs.stripe.com/api/payment_intents/object">PaymentIntent id */ @SerializedName("payment_intent") String paymentIntent; @@ -110,7 +110,7 @@ public Builder putAllExtraParam(Map map) { /** * Required. Valid PaymentIntent id + * href="https://docs.stripe.com/api/payment_intents/object">PaymentIntent id */ public Builder setPaymentIntent(String paymentIntent) { this.paymentIntent = paymentIntent; diff --git a/src/main/java/com/stripe/param/tax/CalculationCreateParams.java b/src/main/java/com/stripe/param/tax/CalculationCreateParams.java index 81ca112fc49..10433a7db45 100644 --- a/src/main/java/com/stripe/param/tax/CalculationCreateParams.java +++ b/src/main/java/com/stripe/param/tax/CalculationCreateParams.java @@ -1125,7 +1125,7 @@ public enum TaxabilityOverride implements ApiRequestParams.EnumParam { public static class LineItem { /** * Required. A positive integer representing the line item's total price in the - * smallest currency unit. If + * smallest currency unit. If * {@code tax_behavior=inclusive}, then this amount includes taxes. Otherwise, taxes are * calculated on top of this amount. */ @@ -1142,7 +1142,7 @@ public static class LineItem { Map extraParams; /** - * 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. */ @@ -1166,7 +1166,7 @@ public static class LineItem { /** * A custom identifier for this line item, which must be unique across the line items in the * calculation. The reference helps identify each line item in exported tax reports. + * href="https://docs.stripe.com/tax/reports">tax reports. */ @SerializedName("reference") String reference; @@ -1176,7 +1176,7 @@ public static class LineItem { TaxBehavior taxBehavior; /** - * A tax code ID to use for this line + * A tax code ID to use for this line * item. If not provided, we will use the tax code from the provided {@code product} param. If * neither {@code tax_code} nor {@code product} is provided, we will use the default tax code * from your Tax Settings. @@ -1239,7 +1239,7 @@ public CalculationCreateParams.LineItem build() { /** * Required. A positive integer representing the line item's total price in - * the smallest currency unit. + * the smallest currency unit. * If {@code tax_behavior=inclusive}, then this amount includes taxes. Otherwise, taxes are * calculated on top of this amount. */ @@ -1322,7 +1322,7 @@ public Builder setQuantity(Long quantity) { /** * A custom identifier for this line item, which must be unique across the line items in the * calculation. The reference helps identify each line item in exported tax reports. + * href="https://docs.stripe.com/tax/reports">tax reports. */ public Builder setReference(String reference) { this.reference = reference; @@ -1336,7 +1336,7 @@ public Builder setTaxBehavior(CalculationCreateParams.LineItem.TaxBehavior taxBe } /** - * A tax code ID to use for this line + * A tax code ID to use for this line * item. If not provided, we will use the tax code from the provided {@code product} param. If * neither {@code tax_code} nor {@code product} is provided, we will use the default tax code * from your Tax Settings. @@ -1632,7 +1632,7 @@ public Builder setState(EmptyParam state) { @EqualsAndHashCode(callSuper = false) public static class ShippingCost { /** - * A positive integer in the smallest + * A positive integer in the smallest * currency unit representing the shipping charge. If {@code tax_behavior=inclusive}, then * this amount includes taxes. Otherwise, taxes are calculated on top of this amount. */ @@ -1649,7 +1649,7 @@ public static class ShippingCost { Map extraParams; /** - * If provided, the shipping + * If provided, the shipping * rate's {@code amount}, {@code tax_code} and {@code tax_behavior} are used. If you provide * a shipping rate, then you cannot pass the {@code amount}, {@code tax_code}, or {@code * tax_behavior} parameters. @@ -1665,7 +1665,7 @@ public static class ShippingCost { TaxBehavior taxBehavior; /** - * The tax code used to calculate tax + * The tax code used to calculate tax * on shipping. If not provided, the default shipping tax code from your Tax Settings is used. */ @@ -1708,7 +1708,7 @@ public CalculationCreateParams.ShippingCost build() { /** * A positive integer in the smallest currency unit + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit * representing the shipping charge. If {@code tax_behavior=inclusive}, then this amount * includes taxes. Otherwise, taxes are calculated on top of this amount. */ @@ -1744,7 +1744,7 @@ public Builder putAllExtraParam(Map map) { } /** - * If provided, the shipping + * If provided, the shipping * rate's {@code amount}, {@code tax_code} and {@code tax_behavior} are used. If you * provide a shipping rate, then you cannot pass the {@code amount}, {@code tax_code}, or * {@code tax_behavior} parameters. @@ -1764,7 +1764,7 @@ public Builder setTaxBehavior(CalculationCreateParams.ShippingCost.TaxBehavior t } /** - * The tax code used to calculate tax + * The tax code used to calculate tax * on shipping. If not provided, the default shipping tax code from your Tax Settings is used. */ diff --git a/src/main/java/com/stripe/param/tax/SettingsUpdateParams.java b/src/main/java/com/stripe/param/tax/SettingsUpdateParams.java index b107e321fc2..4085c17c6f1 100644 --- a/src/main/java/com/stripe/param/tax/SettingsUpdateParams.java +++ b/src/main/java/com/stripe/param/tax/SettingsUpdateParams.java @@ -151,7 +151,7 @@ public static class Defaults { @SerializedName("tax_behavior") TaxBehavior taxBehavior; - /** A tax code ID. */ + /** A tax code ID. */ @SerializedName("tax_code") Object taxCode; @@ -215,13 +215,13 @@ public Builder setTaxBehavior(SettingsUpdateParams.Defaults.TaxBehavior taxBehav return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(String taxCode) { this.taxCode = taxCode; return this; } - /** A tax code ID. */ + /** A tax code ID. */ public Builder setTaxCode(EmptyParam taxCode) { this.taxCode = taxCode; return this; diff --git a/src/main/java/com/stripe/param/tax/TransactionCreateFromCalculationParams.java b/src/main/java/com/stripe/param/tax/TransactionCreateFromCalculationParams.java index 771bb7fff18..d9bd62ac24a 100644 --- a/src/main/java/com/stripe/param/tax/TransactionCreateFromCalculationParams.java +++ b/src/main/java/com/stripe/param/tax/TransactionCreateFromCalculationParams.java @@ -34,7 +34,7 @@ public class TransactionCreateFromCalculationParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/tax/TransactionCreateReversalParams.java b/src/main/java/com/stripe/param/tax/TransactionCreateReversalParams.java index 7106a6f9816..7f345739fb4 100644 --- a/src/main/java/com/stripe/param/tax/TransactionCreateReversalParams.java +++ b/src/main/java/com/stripe/param/tax/TransactionCreateReversalParams.java @@ -28,7 +28,7 @@ public class TransactionCreateReversalParams extends ApiRequestParams { /** * A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in negative. * This value represents the total amount to refund from the transaction, including taxes. */ @SerializedName("flat_amount") @@ -39,7 +39,7 @@ public class TransactionCreateReversalParams extends ApiRequestParams { List lineItems; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -62,7 +62,7 @@ public class TransactionCreateReversalParams extends ApiRequestParams { * Required. A custom identifier for this reversal, such as {@code * myOrder_123-refund_1}, which must be unique across all transactions. The reference helps * identify this reversal transaction in exported tax reports. + * href="https://docs.stripe.com/tax/reports">tax reports. */ @SerializedName("reference") String reference; @@ -183,7 +183,7 @@ public Builder putAllExtraParam(Map map) { /** * A flat amount to reverse across the entire transaction, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. This value represents the total amount to refund from the transaction, including * taxes. */ @@ -263,7 +263,7 @@ public Builder setOriginalTransaction(String originalTransaction) { * Required. A custom identifier for this reversal, such as {@code * myOrder_123-refund_1}, which must be unique across all transactions. The reference helps * identify this reversal transaction in exported tax reports. + * href="https://docs.stripe.com/tax/reports">tax reports. */ public Builder setReference(String reference) { this.reference = reference; @@ -282,7 +282,7 @@ public Builder setShippingCost(TransactionCreateReversalParams.ShippingCost ship public static class LineItem { /** * Required. The amount to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ @SerializedName("amount") @@ -290,7 +290,7 @@ public static class LineItem { /** * Required. The amount of tax to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ @SerializedName("amount_tax") @@ -306,7 +306,7 @@ public static class LineItem { Map extraParams; /** - * 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. */ @@ -321,7 +321,7 @@ public static class LineItem { String originalLineItem; /** - * The quantity reversed. Appears in tax + * The quantity reversed. Appears in tax * exports, but does not affect the amount of tax reversed. */ @SerializedName("quantity") @@ -384,7 +384,7 @@ public TransactionCreateReversalParams.LineItem build() { /** * Required. The amount to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ public Builder setAmount(Long amount) { @@ -394,7 +394,7 @@ public Builder setAmount(Long amount) { /** * Required. The amount of tax to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ public Builder setAmountTax(Long amountTax) { @@ -465,7 +465,7 @@ public Builder setOriginalLineItem(String originalLineItem) { } /** - * The quantity reversed. Appears in tax + * The quantity reversed. Appears in tax * exports, but does not affect the amount of tax reversed. */ public Builder setQuantity(Long quantity) { @@ -489,7 +489,7 @@ public Builder setReference(String reference) { public static class ShippingCost { /** * Required. The amount to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ @SerializedName("amount") @@ -497,7 +497,7 @@ public static class ShippingCost { /** * Required. The amount of tax to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ @SerializedName("amount_tax") @@ -537,7 +537,7 @@ public TransactionCreateReversalParams.ShippingCost build() { /** * Required. The amount to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ public Builder setAmount(Long amount) { @@ -547,7 +547,7 @@ public Builder setAmount(Long amount) { /** * Required. The amount of tax to reverse, in the smallest currency unit in + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit in * negative. */ public Builder setAmountTax(Long amountTax) { diff --git a/src/main/java/com/stripe/param/terminal/LocationCreateParams.java b/src/main/java/com/stripe/param/terminal/LocationCreateParams.java index 307c21a8586..e44555a6f0c 100644 --- a/src/main/java/com/stripe/param/terminal/LocationCreateParams.java +++ b/src/main/java/com/stripe/param/terminal/LocationCreateParams.java @@ -62,7 +62,7 @@ public class LocationCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -271,7 +271,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -282,7 +282,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -334,7 +334,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") String state; @@ -445,7 +448,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java b/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java index 9ec35e22bca..dd39f624d90 100644 --- a/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java +++ b/src/main/java/com/stripe/param/terminal/LocationUpdateParams.java @@ -60,7 +60,7 @@ public class LocationUpdateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -291,7 +291,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -302,7 +302,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -360,7 +360,10 @@ public static class Address { @SerializedName("postal_code") Object postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ @SerializedName("state") Object state; @@ -504,13 +507,19 @@ public Builder setPostalCode(EmptyParam postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(String state) { this.state = state; return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO + * 3166-2). + */ public Builder setState(EmptyParam state) { this.state = state; return this; diff --git a/src/main/java/com/stripe/param/terminal/ReaderCollectInputsParams.java b/src/main/java/com/stripe/param/terminal/ReaderCollectInputsParams.java index e7bcf72ca73..2360aef69a2 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderCollectInputsParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderCollectInputsParams.java @@ -34,7 +34,7 @@ public class ReaderCollectInputsParams extends ApiRequestParams { List inputs; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java b/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java index 5135c31eac2..c29901a86a8 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderCreateParams.java @@ -39,7 +39,7 @@ public class ReaderCreateParams extends ApiRequestParams { String location; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -192,7 +192,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -203,7 +203,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/terminal/ReaderRefundPaymentParams.java b/src/main/java/com/stripe/param/terminal/ReaderRefundPaymentParams.java index dbfd525ecb1..06334f7ac1a 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderRefundPaymentParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderRefundPaymentParams.java @@ -37,7 +37,7 @@ public class ReaderRefundPaymentParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/terminal/ReaderSetReaderDisplayParams.java b/src/main/java/com/stripe/param/terminal/ReaderSetReaderDisplayParams.java index aa22daaa933..0ab5354728d 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderSetReaderDisplayParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderSetReaderDisplayParams.java @@ -158,7 +158,7 @@ public static class Cart { List lineItems; /** - * The amount of tax in the smallest + * The amount of tax in the smallest * currency unit. */ @SerializedName("tax") @@ -166,7 +166,7 @@ public static class Cart { /** * Required. Total balance of cart due in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("total") Long total; @@ -268,7 +268,7 @@ public Builder addAllLineItem(List e } /** - * The amount of tax in the smallest + * The amount of tax in the smallest * currency unit. */ public Builder setTax(Long tax) { @@ -278,7 +278,7 @@ public Builder setTax(Long tax) { /** * Required. Total balance of cart due in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setTotal(Long total) { this.total = total; @@ -291,7 +291,7 @@ public Builder setTotal(Long total) { public static class LineItem { /** * Required. The price of the item in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ @SerializedName("amount") Long amount; @@ -342,7 +342,7 @@ public ReaderSetReaderDisplayParams.Cart.LineItem build() { /** * Required. The price of the item in the smallest currency unit. + * href="https://docs.stripe.com/currencies#zero-decimal">smallest currency unit. */ public Builder setAmount(Long amount) { this.amount = amount; diff --git a/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java b/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java index 31151e0f8dd..0d1d1ecd7e6 100644 --- a/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java +++ b/src/main/java/com/stripe/param/terminal/ReaderUpdateParams.java @@ -32,7 +32,7 @@ public class ReaderUpdateParams extends ApiRequestParams { Object label; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -159,7 +159,7 @@ public Builder putAllMetadata(Map map) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -170,7 +170,7 @@ public Builder setMetadata(EmptyParam metadata) { } /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/treasury/CreditReversalCreateParams.java b/src/main/java/com/stripe/param/treasury/CreditReversalCreateParams.java index 9b6464fbc0c..a66e02d1f6f 100644 --- a/src/main/java/com/stripe/param/treasury/CreditReversalCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/CreditReversalCreateParams.java @@ -27,7 +27,7 @@ public class CreditReversalCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/treasury/DebitReversalCreateParams.java b/src/main/java/com/stripe/param/treasury/DebitReversalCreateParams.java index 14d891c2186..7505d27ee8a 100644 --- a/src/main/java/com/stripe/param/treasury/DebitReversalCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/DebitReversalCreateParams.java @@ -27,7 +27,7 @@ public class DebitReversalCreateParams extends ApiRequestParams { Map extraParams; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/treasury/FinancialAccountCreateParams.java b/src/main/java/com/stripe/param/treasury/FinancialAccountCreateParams.java index 41ae7f496ed..1e4ed28692f 100644 --- a/src/main/java/com/stripe/param/treasury/FinancialAccountCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/FinancialAccountCreateParams.java @@ -43,7 +43,7 @@ public class FinancialAccountCreateParams extends ApiRequestParams { Features features; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/treasury/FinancialAccountUpdateParams.java b/src/main/java/com/stripe/param/treasury/FinancialAccountUpdateParams.java index d2d8d2fa396..ab34eba00dc 100644 --- a/src/main/java/com/stripe/param/treasury/FinancialAccountUpdateParams.java +++ b/src/main/java/com/stripe/param/treasury/FinancialAccountUpdateParams.java @@ -51,7 +51,7 @@ public class FinancialAccountUpdateParams extends ApiRequestParams { ForwardingSettings forwardingSettings; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. diff --git a/src/main/java/com/stripe/param/treasury/InboundTransferCreateParams.java b/src/main/java/com/stripe/param/treasury/InboundTransferCreateParams.java index 9e15d5e2f07..65841aca18d 100644 --- a/src/main/java/com/stripe/param/treasury/InboundTransferCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/InboundTransferCreateParams.java @@ -47,7 +47,7 @@ public class InboundTransferCreateParams extends ApiRequestParams { String financialAccount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -59,7 +59,10 @@ public class InboundTransferCreateParams extends ApiRequestParams { @SerializedName("origin_payment_method") String originPaymentMethod; - /** The complete description that appears on your customers' statements. Maximum 10 characters. */ + /** + * The complete description that appears on your customers' statements. Maximum 10 characters. Can + * only include -#.$&*, spaces, and alphanumeric characters. + */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -237,6 +240,7 @@ public Builder setOriginPaymentMethod(String originPaymentMethod) { /** * The complete description that appears on your customers' statements. Maximum 10 characters. + * Can only include -#.$&*, spaces, and alphanumeric characters. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; diff --git a/src/main/java/com/stripe/param/treasury/OutboundPaymentCreateParams.java b/src/main/java/com/stripe/param/treasury/OutboundPaymentCreateParams.java index 7c73e4431d7..4217d8c020c 100644 --- a/src/main/java/com/stripe/param/treasury/OutboundPaymentCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/OutboundPaymentCreateParams.java @@ -77,7 +77,7 @@ public class OutboundPaymentCreateParams extends ApiRequestParams { String financialAccount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -89,7 +89,8 @@ public class OutboundPaymentCreateParams extends ApiRequestParams { * The description that appears on the receiving end for this OutboundPayment (for example, bank * statement for external bank transfer). Maximum 10 characters for {@code ach} payments, 140 * characters for {@code us_domestic_wire} payments, or 500 characters for {@code stripe} network - * transfers. The default value is "payment". + * transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value + * is "payment". */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -324,7 +325,8 @@ public Builder putAllMetadata(Map map) { * The description that appears on the receiving end for this OutboundPayment (for example, bank * statement for external bank transfer). Maximum 10 characters for {@code ach} payments, 140 * characters for {@code us_domestic_wire} payments, or 500 characters for {@code stripe} - * network transfers. The default value is "payment". + * network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The + * default value is "payment". */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -359,7 +361,7 @@ public static class DestinationPaymentMethodData { String financialAccount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys * can be unset by posting an empty value to {@code metadata}. @@ -694,7 +696,10 @@ public static class Address { @SerializedName("postal_code") String postalCode; - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ @SerializedName("state") String state; @@ -811,7 +816,10 @@ public Builder setPostalCode(String postalCode) { return this; } - /** State, county, province, or region. */ + /** + * State, county, province, or region (ISO 3166-2). + */ public Builder setState(String state) { this.state = state; return this; @@ -1100,7 +1108,7 @@ public static class UsBankAccount { /** * Specifies the network rails to be used. If not set, will default to the PaymentMethod's * preferred network. 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. */ @SerializedName("network") @@ -1159,7 +1167,7 @@ public Builder putAllExtraParam(Map map) { /** * Specifies the network rails to be used. If not set, will default to the PaymentMethod's * preferred network. 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. */ public Builder setNetwork( diff --git a/src/main/java/com/stripe/param/treasury/OutboundTransferCreateParams.java b/src/main/java/com/stripe/param/treasury/OutboundTransferCreateParams.java index dd043f22b93..cc9d16deba3 100644 --- a/src/main/java/com/stripe/param/treasury/OutboundTransferCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/OutboundTransferCreateParams.java @@ -63,7 +63,7 @@ public class OutboundTransferCreateParams extends ApiRequestParams { String financialAccount; /** - * 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. Individual keys can be unset by posting an empty value to them. All keys can * be unset by posting an empty value to {@code metadata}. @@ -78,7 +78,8 @@ public class OutboundTransferCreateParams extends ApiRequestParams { /** * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 * characters for {@code ach} transfers or 140 characters for {@code us_domestic_wire} transfers. - * The default value is "transfer". + * The default value is "transfer". Can only include -#.$&*, spaces, and + * alphanumeric characters. */ @SerializedName("statement_descriptor") String statementDescriptor; @@ -295,7 +296,8 @@ public Builder setNetworkDetails(OutboundTransferCreateParams.NetworkDetails net /** * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 * characters for {@code ach} transfers or 140 characters for {@code us_domestic_wire} - * transfers. The default value is "transfer". + * transfers. The default value is "transfer". Can only include -#.$&*, spaces, + * and alphanumeric characters. */ public Builder setStatementDescriptor(String statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -501,7 +503,7 @@ public static class UsBankAccount { /** * Specifies the network rails to be used. If not set, will default to the PaymentMethod's * preferred network. 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. */ @SerializedName("network") @@ -560,7 +562,7 @@ public Builder putAllExtraParam(Map map) { /** * Specifies the network rails to be used. If not set, will default to the PaymentMethod's * preferred network. 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. */ public Builder setNetwork( diff --git a/src/main/java/com/stripe/param/treasury/ReceivedCreditCreateParams.java b/src/main/java/com/stripe/param/treasury/ReceivedCreditCreateParams.java index cafb0f7e8b5..13e7d3e0542 100644 --- a/src/main/java/com/stripe/param/treasury/ReceivedCreditCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/ReceivedCreditCreateParams.java @@ -53,7 +53,7 @@ public class ReceivedCreditCreateParams extends ApiRequestParams { /** * Required. Specifies the network rails to be used. If not set, will default to * the PaymentMethod's preferred network. See the docs to learn more about + * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more about * money movement timelines for each network type. */ @SerializedName("network") @@ -211,7 +211,7 @@ public Builder setInitiatingPaymentMethodDetails( /** * Required. Specifies the network rails to be used. If not set, will default * to the PaymentMethod's preferred network. See the docs to learn more about + * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more about * money movement timelines for each network type. */ public Builder setNetwork(ReceivedCreditCreateParams.Network network) { diff --git a/src/main/java/com/stripe/param/treasury/ReceivedDebitCreateParams.java b/src/main/java/com/stripe/param/treasury/ReceivedDebitCreateParams.java index a7fa3061186..18f976f388e 100644 --- a/src/main/java/com/stripe/param/treasury/ReceivedDebitCreateParams.java +++ b/src/main/java/com/stripe/param/treasury/ReceivedDebitCreateParams.java @@ -53,7 +53,7 @@ public class ReceivedDebitCreateParams extends ApiRequestParams { /** * Required. Specifies the network rails to be used. If not set, will default to * the PaymentMethod's preferred network. See the docs to learn more about + * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more about * money movement timelines for each network type. */ @SerializedName("network") @@ -211,7 +211,7 @@ public Builder setInitiatingPaymentMethodDetails( /** * Required. Specifies the network rails to be used. If not set, will default * to the PaymentMethod's preferred network. See the docs to learn more about + * href="https://docs.stripe.com/treasury/money-movement/timelines">docs to learn more about * money movement timelines for each network type. */ public Builder setNetwork(ReceivedDebitCreateParams.Network network) { diff --git a/src/main/java/com/stripe/param/v2/billing/IntentCreateParams.java b/src/main/java/com/stripe/param/v2/billing/IntentCreateParams.java index df917424505..e66633d92c1 100644 --- a/src/main/java/com/stripe/param/v2/billing/IntentCreateParams.java +++ b/src/main/java/com/stripe/param/v2/billing/IntentCreateParams.java @@ -714,9 +714,9 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class Deactivate { - /** Configuration for the billing details. */ - @SerializedName("billing_details") - BillingDetails billingDetails; + /** Allows users to override the collect at behavior. */ + @SerializedName("collect_at") + CollectAt collectAt; /** * When the deactivate action will take effect. If not specified, the default behavior is @@ -743,12 +743,12 @@ public static class Deactivate { Type type; private Deactivate( - BillingDetails billingDetails, + CollectAt collectAt, EffectiveAt effectiveAt, Map extraParams, PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails, Type type) { - this.billingDetails = billingDetails; + this.collectAt = collectAt; this.effectiveAt = effectiveAt; this.extraParams = extraParams; this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; @@ -760,7 +760,7 @@ public static Builder builder() { } public static class Builder { - private BillingDetails billingDetails; + private CollectAt collectAt; private EffectiveAt effectiveAt; @@ -773,17 +773,16 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public IntentCreateParams.Action.Deactivate build() { return new IntentCreateParams.Action.Deactivate( - this.billingDetails, + this.collectAt, this.effectiveAt, this.extraParams, this.pricingPlanSubscriptionDetails, this.type); } - /** Configuration for the billing details. */ - public Builder setBillingDetails( - IntentCreateParams.Action.Deactivate.BillingDetails billingDetails) { - this.billingDetails = billingDetails; + /** Allows users to override the collect at behavior. */ + public Builder setCollectAt(IntentCreateParams.Action.Deactivate.CollectAt collectAt) { + this.collectAt = collectAt; return this; } @@ -840,97 +839,6 @@ public Builder setType(IntentCreateParams.Action.Deactivate.Type type) { } } - @Getter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails { - /** - * Map of extra parameters for custom features not available in this client library. The - * content in this map is not serialized under this field's {@code @SerializedName} value. - * Instead, each key/value pair is serialized as if the key is a root-level field - * (serialized) name in this param object. Effectively, this map is flattened to its parent - * instance. - */ - @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) - Map extraParams; - - /** This controls the proration adjustment for the partial servicing period. */ - @SerializedName("proration_behavior") - ProrationBehavior prorationBehavior; - - private BillingDetails( - Map extraParams, ProrationBehavior prorationBehavior) { - this.extraParams = extraParams; - this.prorationBehavior = prorationBehavior; - } - - public static Builder builder() { - return new Builder(); - } - - public static class Builder { - private Map extraParams; - - private ProrationBehavior prorationBehavior; - - /** Finalize and obtain parameter instance from this builder. */ - public IntentCreateParams.Action.Deactivate.BillingDetails build() { - return new IntentCreateParams.Action.Deactivate.BillingDetails( - this.extraParams, this.prorationBehavior); - } - - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Deactivate.BillingDetails#extraParams} for - * the field documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.put(key, value); - return this; - } - - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Deactivate.BillingDetails#extraParams} for - * the field documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.putAll(map); - return this; - } - - /** This controls the proration adjustment for the partial servicing period. */ - public Builder setProrationBehavior( - IntentCreateParams.Action.Deactivate.BillingDetails.ProrationBehavior - prorationBehavior) { - this.prorationBehavior = prorationBehavior; - return this; - } - } - - public enum ProrationBehavior implements ApiRequestParams.EnumParam { - @SerializedName("no_adjustment") - NO_ADJUSTMENT("no_adjustment"), - - @SerializedName("prorated_adjustment") - PRORATED_ADJUSTMENT("prorated_adjustment"); - - @Getter(onMethod_ = {@Override}) - private final String value; - - ProrationBehavior(String value) { - this.value = value; - } - } - } - @Getter @EqualsAndHashCode(callSuper = false) public static class EffectiveAt { @@ -1057,13 +965,18 @@ public static class PricingPlanSubscriptionDetails { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** Required. ID of the pricing plan subscription to deactivate. */ @SerializedName("pricing_plan_subscription") String pricingPlanSubscription; private PricingPlanSubscriptionDetails( - Map extraParams, String pricingPlanSubscription) { + Map extraParams, Overrides overrides, String pricingPlanSubscription) { this.extraParams = extraParams; + this.overrides = overrides; this.pricingPlanSubscription = pricingPlanSubscription; } @@ -1074,12 +987,14 @@ public static Builder builder() { public static class Builder { private Map extraParams; + private Overrides overrides; + private String pricingPlanSubscription; /** Finalize and obtain parameter instance from this builder. */ public IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails build() { return new IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails( - this.extraParams, this.pricingPlanSubscription); + this.extraParams, this.overrides, this.pricingPlanSubscription); } /** @@ -1112,245 +1027,508 @@ public Builder putAllExtraParam(Map map) { return this; } + /** Allows users to override the partial period behavior. */ + public Builder setOverrides( + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + overrides) { + this.overrides = overrides; + return this; + } + /** Required. ID of the pricing plan subscription to deactivate. */ public Builder setPricingPlanSubscription(String pricingPlanSubscription) { this.pricingPlanSubscription = pricingPlanSubscription; return this; } } - } - public enum Type implements ApiRequestParams.EnumParam { - @SerializedName("pricing_plan_subscription_details") - PRICING_PLAN_SUBSCRIPTION_DETAILS("pricing_plan_subscription_details"), + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Overrides { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; - @SerializedName("v1_subscription_details") - V1_SUBSCRIPTION_DETAILS("v1_subscription_details"); + /** Required. Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List< + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; - @Getter(onMethod_ = {@Override}) - private final String value; + private Overrides( + Map extraParams, + List< + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors) { + this.extraParams = extraParams; + this.partialPeriodBehaviors = partialPeriodBehaviors; + } - Type(String value) { - this.value = value; - } - } - } + public static Builder builder() { + return new Builder(); + } - @Getter - @EqualsAndHashCode(callSuper = false) - public static class Modify { - /** Configuration for the billing details. */ - @SerializedName("billing_details") - BillingDetails billingDetails; + public static class Builder { + private Map extraParams; - /** - * When the modify action will take effect. If not specified, the default behavior is - * on_reserve. - */ - @SerializedName("effective_at") - EffectiveAt effectiveAt; + private List< + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; - /** - * Map of extra parameters for custom features not available in this client library. The - * content in this map is not serialized under this field's {@code @SerializedName} value. - * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) - * name in this param object. Effectively, this map is flattened to its parent instance. - */ - @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) - Map extraParams; + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + build() { + return new IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails + .Overrides(this.extraParams, this.partialPeriodBehaviors); + } - /** Required. Details for modifying a pricing plan subscription. */ - @SerializedName("pricing_plan_subscription_details") - PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails; + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } - /** Required. Type of the action details. */ - @SerializedName("type") - Type type; + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } - private Modify( - BillingDetails billingDetails, - EffectiveAt effectiveAt, - Map extraParams, - PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails, - Type type) { - this.billingDetails = billingDetails; - this.effectiveAt = effectiveAt; - this.extraParams = extraParams; - this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; - this.type = type; - } + /** + * Add an element to `partialPeriodBehaviors` list. A list is initialized for the first + * `add/addAll` call, and subsequent calls adds additional elements to the original + * list. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addPartialPeriodBehavior( + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + element) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.add(element); + return this; + } - public static Builder builder() { - return new Builder(); - } + /** + * Add all elements to `partialPeriodBehaviors` list. A list is initialized for the + * first `add/addAll` call, and subsequent calls adds additional elements to the + * original list. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addAllPartialPeriodBehavior( + List< + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior> + elements) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.addAll(elements); + return this; + } + } - public static class Builder { - private BillingDetails billingDetails; + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} + * value. Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; - private EffectiveAt effectiveAt; + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; - private Map extraParams; + /** Required. Type of the partial period behavior override. */ + @SerializedName("type") + Type type; - private PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails; + private PartialPeriodBehavior( + Map extraParams, LicenseFee licenseFee, Type type) { + this.extraParams = extraParams; + this.licenseFee = licenseFee; + this.type = type; + } - private Type type; + public static Builder builder() { + return new Builder(); + } - /** Finalize and obtain parameter instance from this builder. */ - public IntentCreateParams.Action.Modify build() { - return new IntentCreateParams.Action.Modify( - this.billingDetails, - this.effectiveAt, - this.extraParams, - this.pricingPlanSubscriptionDetails, - this.type); - } + public static class Builder { + private Map extraParams; - /** Configuration for the billing details. */ - public Builder setBillingDetails( - IntentCreateParams.Action.Modify.BillingDetails billingDetails) { - this.billingDetails = billingDetails; - return this; - } + private LicenseFee licenseFee; - /** - * When the modify action will take effect. If not specified, the default behavior is - * on_reserve. - */ - public Builder setEffectiveAt(IntentCreateParams.Action.Modify.EffectiveAt effectiveAt) { - this.effectiveAt = effectiveAt; - return this; - } + private Type type; - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Modify#extraParams} for the field - * documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.put(key, value); - return this; - } + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + build() { + return new IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior(this.extraParams, this.licenseFee, this.type); + } - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Modify#extraParams} for the field - * documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.putAll(map); - return this; - } + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } - /** Required. Details for modifying a pricing plan subscription. */ - public Builder setPricingPlanSubscriptionDetails( - IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails - pricingPlanSubscriptionDetails) { - this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; - return this; - } + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } - /** Required. Type of the action details. */ - public Builder setType(IntentCreateParams.Action.Modify.Type type) { - this.type = type; - return this; + /** Override for the license fee. */ + public Builder setLicenseFee( + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + licenseFee) { + this.licenseFee = licenseFee; + return this; + } + + /** Required. Type of the partial period behavior override. */ + public Builder setType( + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.Type + type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee { + /** + * Required. The proration behavior for the partial servicing period. + * Defines how we prorate the license fee when the user is deactivating. + */ + @SerializedName("credit_proration_behavior") + CreditProrationBehavior creditProrationBehavior; + + /** + * Map of extra parameters for custom features not available in this client library. + * The content in this map is not serialized under this field's + * {@code @SerializedName} value. Instead, each key/value pair is serialized as if the + * key is a root-level field (serialized) name in this param object. Effectively, this + * map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private LicenseFee( + CreditProrationBehavior creditProrationBehavior, + Map extraParams) { + this.creditProrationBehavior = creditProrationBehavior; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private CreditProrationBehavior creditProrationBehavior; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + build() { + return new IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.LicenseFee( + this.creditProrationBehavior, this.extraParams); + } + + /** + * Required. The proration behavior for the partial servicing + * period. Defines how we prorate the license fee when the user is deactivating. + */ + public Builder setCreditProrationBehavior( + IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee.CreditProrationBehavior + creditProrationBehavior) { + this.creditProrationBehavior = creditProrationBehavior; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to + * the original map. See {@link + * IntentCreateParams.Action.Deactivate.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } + + public enum CreditProrationBehavior implements ApiRequestParams.EnumParam { + @SerializedName("none") + NONE("none"), + + @SerializedName("prorated") + PRORATED("prorated"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + CreditProrationBehavior(String value) { + this.value = value; + } + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("license_fee") + LICENSE_FEE("license_fee"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } + } } } - @Getter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails { - /** - * Map of extra parameters for custom features not available in this client library. The - * content in this map is not serialized under this field's {@code @SerializedName} value. - * Instead, each key/value pair is serialized as if the key is a root-level field - * (serialized) name in this param object. Effectively, this map is flattened to its parent - * instance. - */ - @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) - Map extraParams; + public enum CollectAt implements ApiRequestParams.EnumParam { + @SerializedName("next_billing_date") + NEXT_BILLING_DATE("next_billing_date"), - /** This controls the proration adjustment for the partial servicing period. */ - @SerializedName("proration_behavior") - ProrationBehavior prorationBehavior; + @SerializedName("on_effective_at") + ON_EFFECTIVE_AT("on_effective_at"); - private BillingDetails( - Map extraParams, ProrationBehavior prorationBehavior) { - this.extraParams = extraParams; - this.prorationBehavior = prorationBehavior; + @Getter(onMethod_ = {@Override}) + private final String value; + + CollectAt(String value) { + this.value = value; } + } - public static Builder builder() { - return new Builder(); + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("pricing_plan_subscription_details") + PRICING_PLAN_SUBSCRIPTION_DETAILS("pricing_plan_subscription_details"), + + @SerializedName("v1_subscription_details") + V1_SUBSCRIPTION_DETAILS("v1_subscription_details"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; } + } + } - public static class Builder { - private Map extraParams; + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Modify { + /** Allows users to override the collect at behavior. */ + @SerializedName("collect_at") + CollectAt collectAt; + + /** + * When the modify action will take effect. If not specified, the default behavior is + * on_reserve. + */ + @SerializedName("effective_at") + EffectiveAt effectiveAt; - private ProrationBehavior prorationBehavior; + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; - /** Finalize and obtain parameter instance from this builder. */ - public IntentCreateParams.Action.Modify.BillingDetails build() { - return new IntentCreateParams.Action.Modify.BillingDetails( - this.extraParams, this.prorationBehavior); - } + /** Required. Details for modifying a pricing plan subscription. */ + @SerializedName("pricing_plan_subscription_details") + PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails; - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Modify.BillingDetails#extraParams} for the - * field documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.put(key, value); - return this; - } + /** Required. Type of the action details. */ + @SerializedName("type") + Type type; - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Modify.BillingDetails#extraParams} for the - * field documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.putAll(map); - return this; - } + private Modify( + CollectAt collectAt, + EffectiveAt effectiveAt, + Map extraParams, + PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails, + Type type) { + this.collectAt = collectAt; + this.effectiveAt = effectiveAt; + this.extraParams = extraParams; + this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; + this.type = type; + } - /** This controls the proration adjustment for the partial servicing period. */ - public Builder setProrationBehavior( - IntentCreateParams.Action.Modify.BillingDetails.ProrationBehavior prorationBehavior) { - this.prorationBehavior = prorationBehavior; - return this; - } + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private CollectAt collectAt; + + private EffectiveAt effectiveAt; + + private Map extraParams; + + private PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Modify build() { + return new IntentCreateParams.Action.Modify( + this.collectAt, + this.effectiveAt, + this.extraParams, + this.pricingPlanSubscriptionDetails, + this.type); } - public enum ProrationBehavior implements ApiRequestParams.EnumParam { - @SerializedName("no_adjustment") - NO_ADJUSTMENT("no_adjustment"), + /** Allows users to override the collect at behavior. */ + public Builder setCollectAt(IntentCreateParams.Action.Modify.CollectAt collectAt) { + this.collectAt = collectAt; + return this; + } - @SerializedName("prorated_adjustment") - PRORATED_ADJUSTMENT("prorated_adjustment"); + /** + * When the modify action will take effect. If not specified, the default behavior is + * on_reserve. + */ + public Builder setEffectiveAt(IntentCreateParams.Action.Modify.EffectiveAt effectiveAt) { + this.effectiveAt = effectiveAt; + return this; + } - @Getter(onMethod_ = {@Override}) - private final String value; + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link IntentCreateParams.Action.Modify#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } - ProrationBehavior(String value) { - this.value = value; + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link IntentCreateParams.Action.Modify#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); } + this.extraParams.putAll(map); + return this; + } + + /** Required. Details for modifying a pricing plan subscription. */ + public Builder setPricingPlanSubscriptionDetails( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails + pricingPlanSubscriptionDetails) { + this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; + return this; + } + + /** Required. Type of the action details. */ + public Builder setType(IntentCreateParams.Action.Modify.Type type) { + this.type = type; + return this; } } @@ -1490,6 +1668,10 @@ public static class PricingPlanSubscriptionDetails { @SerializedName("new_pricing_plan_version") String newPricingPlanVersion; + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** Required. The ID of the Pricing Plan Subscription to modify. */ @SerializedName("pricing_plan_subscription") String pricingPlanSubscription; @@ -1502,11 +1684,13 @@ private PricingPlanSubscriptionDetails( Map extraParams, String newPricingPlan, String newPricingPlanVersion, + Overrides overrides, String pricingPlanSubscription) { this.componentConfigurations = componentConfigurations; this.extraParams = extraParams; this.newPricingPlan = newPricingPlan; this.newPricingPlanVersion = newPricingPlanVersion; + this.overrides = overrides; this.pricingPlanSubscription = pricingPlanSubscription; } @@ -1526,6 +1710,8 @@ public static class Builder { private String newPricingPlanVersion; + private Overrides overrides; + private String pricingPlanSubscription; /** Finalize and obtain parameter instance from this builder. */ @@ -1535,6 +1721,7 @@ public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails build() { this.extraParams, this.newPricingPlan, this.newPricingPlanVersion, + this.overrides, this.pricingPlanSubscription); } @@ -1604,134 +1791,525 @@ public Builder putAllExtraParam(Map map) { return this; } - /** The ID of the new Pricing Plan, if changing plans. */ - public Builder setNewPricingPlan(String newPricingPlan) { - this.newPricingPlan = newPricingPlan; - return this; - } + /** The ID of the new Pricing Plan, if changing plans. */ + public Builder setNewPricingPlan(String newPricingPlan) { + this.newPricingPlan = newPricingPlan; + return this; + } + + /** The ID of the new Pricing Plan Version to use. */ + public Builder setNewPricingPlanVersion(String newPricingPlanVersion) { + this.newPricingPlanVersion = newPricingPlanVersion; + return this; + } + + /** Allows users to override the partial period behavior. */ + public Builder setOverrides( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides overrides) { + this.overrides = overrides; + return this; + } + + /** Required. The ID of the Pricing Plan Subscription to modify. */ + public Builder setPricingPlanSubscription(String pricingPlanSubscription) { + this.pricingPlanSubscription = pricingPlanSubscription; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class ComponentConfiguration { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Lookup key for the pricing plan component. */ + @SerializedName("lookup_key") + String lookupKey; + + /** ID of the pricing plan component. */ + @SerializedName("pricing_plan_component") + String pricingPlanComponent; + + /** Quantity of the component to be used. */ + @SerializedName("quantity") + Long quantity; + + private ComponentConfiguration( + Map extraParams, + String lookupKey, + String pricingPlanComponent, + Long quantity) { + this.extraParams = extraParams; + this.lookupKey = lookupKey; + this.pricingPlanComponent = pricingPlanComponent; + this.quantity = quantity; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String lookupKey; + + private String pricingPlanComponent; + + private Long quantity; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails + .ComponentConfiguration + build() { + return new IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails + .ComponentConfiguration( + this.extraParams, this.lookupKey, this.pricingPlanComponent, this.quantity); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.ComponentConfiguration#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.ComponentConfiguration#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Lookup key for the pricing plan component. */ + public Builder setLookupKey(String lookupKey) { + this.lookupKey = lookupKey; + return this; + } + + /** ID of the pricing plan component. */ + public Builder setPricingPlanComponent(String pricingPlanComponent) { + this.pricingPlanComponent = pricingPlanComponent; + return this; + } + + /** Quantity of the component to be used. */ + public Builder setQuantity(Long quantity) { + this.quantity = quantity; + return this; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Overrides { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List< + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; + + private Overrides( + Map extraParams, + List< + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors) { + this.extraParams = extraParams; + this.partialPeriodBehaviors = partialPeriodBehaviors; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private List< + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + build() { + return new IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides( + this.extraParams, this.partialPeriodBehaviors); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Add an element to `partialPeriodBehaviors` list. A list is initialized for the first + * `add/addAll` call, and subsequent calls adds additional elements to the original + * list. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addPartialPeriodBehavior( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + element) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.add(element); + return this; + } + + /** + * Add all elements to `partialPeriodBehaviors` list. A list is initialized for the + * first `add/addAll` call, and subsequent calls adds additional elements to the + * original list. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addAllPartialPeriodBehavior( + List< + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + elements) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.addAll(elements); + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} + * value. Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; + + /** Required. Type of the partial period behavior override. */ + @SerializedName("type") + Type type; + + private PartialPeriodBehavior( + Map extraParams, LicenseFee licenseFee, Type type) { + this.extraParams = extraParams; + this.licenseFee = licenseFee; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private LicenseFee licenseFee; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + build() { + return new IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior(this.extraParams, this.licenseFee, this.type); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Override for the license fee. */ + public Builder setLicenseFee( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + licenseFee) { + this.licenseFee = licenseFee; + return this; + } + + /** Required. Type of the partial period behavior override. */ + public Builder setType( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.Type + type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee { + /** + * Required. The proration behavior for the partial servicing period. + * Defines how we prorate the license fee when the user is upgrading. + */ + @SerializedName("credit_proration_behavior") + CreditProrationBehavior creditProrationBehavior; - /** The ID of the new Pricing Plan Version to use. */ - public Builder setNewPricingPlanVersion(String newPricingPlanVersion) { - this.newPricingPlanVersion = newPricingPlanVersion; - return this; - } + /** + * Required. The proration behavior for the partial servicing period. + * Defines how we prorate the license fee when the user is downgrading. + */ + @SerializedName("debit_proration_behavior") + DebitProrationBehavior debitProrationBehavior; - /** Required. The ID of the Pricing Plan Subscription to modify. */ - public Builder setPricingPlanSubscription(String pricingPlanSubscription) { - this.pricingPlanSubscription = pricingPlanSubscription; - return this; - } - } + /** + * Map of extra parameters for custom features not available in this client library. + * The content in this map is not serialized under this field's + * {@code @SerializedName} value. Instead, each key/value pair is serialized as if the + * key is a root-level field (serialized) name in this param object. Effectively, this + * map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private LicenseFee( + CreditProrationBehavior creditProrationBehavior, + DebitProrationBehavior debitProrationBehavior, + Map extraParams) { + this.creditProrationBehavior = creditProrationBehavior; + this.debitProrationBehavior = debitProrationBehavior; + this.extraParams = extraParams; + } - @Getter - @EqualsAndHashCode(callSuper = false) - public static class ComponentConfiguration { - /** - * Map of extra parameters for custom features not available in this client library. The - * content in this map is not serialized under this field's {@code @SerializedName} value. - * Instead, each key/value pair is serialized as if the key is a root-level field - * (serialized) name in this param object. Effectively, this map is flattened to its - * parent instance. - */ - @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) - Map extraParams; + public static Builder builder() { + return new Builder(); + } - /** Lookup key for the pricing plan component. */ - @SerializedName("lookup_key") - String lookupKey; + public static class Builder { + private CreditProrationBehavior creditProrationBehavior; - /** ID of the pricing plan component. */ - @SerializedName("pricing_plan_component") - String pricingPlanComponent; + private DebitProrationBehavior debitProrationBehavior; - /** Quantity of the component to be used. */ - @SerializedName("quantity") - Long quantity; + private Map extraParams; - private ComponentConfiguration( - Map extraParams, - String lookupKey, - String pricingPlanComponent, - Long quantity) { - this.extraParams = extraParams; - this.lookupKey = lookupKey; - this.pricingPlanComponent = pricingPlanComponent; - this.quantity = quantity; - } + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + build() { + return new IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.LicenseFee( + this.creditProrationBehavior, this.debitProrationBehavior, this.extraParams); + } - public static Builder builder() { - return new Builder(); - } + /** + * Required. The proration behavior for the partial servicing + * period. Defines how we prorate the license fee when the user is upgrading. + */ + public Builder setCreditProrationBehavior( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee.CreditProrationBehavior + creditProrationBehavior) { + this.creditProrationBehavior = creditProrationBehavior; + return this; + } - public static class Builder { - private Map extraParams; + /** + * Required. The proration behavior for the partial servicing + * period. Defines how we prorate the license fee when the user is downgrading. + */ + public Builder setDebitProrationBehavior( + IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee.DebitProrationBehavior + debitProrationBehavior) { + this.debitProrationBehavior = debitProrationBehavior; + return this; + } - private String lookupKey; + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } - private String pricingPlanComponent; + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to + * the original map. See {@link + * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } - private Long quantity; + public enum CreditProrationBehavior implements ApiRequestParams.EnumParam { + @SerializedName("none") + NONE("none"), - /** Finalize and obtain parameter instance from this builder. */ - public IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails - .ComponentConfiguration - build() { - return new IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails - .ComponentConfiguration( - this.extraParams, this.lookupKey, this.pricingPlanComponent, this.quantity); - } + @SerializedName("prorated") + PRORATED("prorated"); - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the - * original map. See {@link - * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.ComponentConfiguration#extraParams} - * for the field documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); + @Getter(onMethod_ = {@Override}) + private final String value; + + CreditProrationBehavior(String value) { + this.value = value; + } } - this.extraParams.put(key, value); - return this; - } - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the - * original map. See {@link - * IntentCreateParams.Action.Modify.PricingPlanSubscriptionDetails.ComponentConfiguration#extraParams} - * for the field documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); + public enum DebitProrationBehavior implements ApiRequestParams.EnumParam { + @SerializedName("none") + NONE("none"), + + @SerializedName("prorated") + PRORATED("prorated"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + DebitProrationBehavior(String value) { + this.value = value; + } } - this.extraParams.putAll(map); - return this; } - /** Lookup key for the pricing plan component. */ - public Builder setLookupKey(String lookupKey) { - this.lookupKey = lookupKey; - return this; - } + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("license_fee") + LICENSE_FEE("license_fee"); - /** ID of the pricing plan component. */ - public Builder setPricingPlanComponent(String pricingPlanComponent) { - this.pricingPlanComponent = pricingPlanComponent; - return this; - } + @Getter(onMethod_ = {@Override}) + private final String value; - /** Quantity of the component to be used. */ - public Builder setQuantity(Long quantity) { - this.quantity = quantity; - return this; + Type(String value) { + this.value = value; + } } } } } + public enum CollectAt implements ApiRequestParams.EnumParam { + @SerializedName("next_billing_date") + NEXT_BILLING_DATE("next_billing_date"), + + @SerializedName("on_effective_at") + ON_EFFECTIVE_AT("on_effective_at"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + CollectAt(String value) { + this.value = value; + } + } + public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pricing_plan_subscription_details") PRICING_PLAN_SUBSCRIPTION_DETAILS("pricing_plan_subscription_details"), @@ -1848,12 +2426,9 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class Subscribe { - /** - * Configuration for the billing details. If not specified, see the default behavior for - * individual attributes. - */ - @SerializedName("billing_details") - BillingDetails billingDetails; + /** Allows users to override the collect at behavior. */ + @SerializedName("collect_at") + CollectAt collectAt; /** * When the subscribe action will take effect. If not specified, the default behavior is @@ -1884,13 +2459,13 @@ public static class Subscribe { V1SubscriptionDetails v1SubscriptionDetails; private Subscribe( - BillingDetails billingDetails, + CollectAt collectAt, EffectiveAt effectiveAt, Map extraParams, PricingPlanSubscriptionDetails pricingPlanSubscriptionDetails, Type type, V1SubscriptionDetails v1SubscriptionDetails) { - this.billingDetails = billingDetails; + this.collectAt = collectAt; this.effectiveAt = effectiveAt; this.extraParams = extraParams; this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; @@ -1903,7 +2478,7 @@ public static Builder builder() { } public static class Builder { - private BillingDetails billingDetails; + private CollectAt collectAt; private EffectiveAt effectiveAt; @@ -1918,7 +2493,7 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public IntentCreateParams.Action.Subscribe build() { return new IntentCreateParams.Action.Subscribe( - this.billingDetails, + this.collectAt, this.effectiveAt, this.extraParams, this.pricingPlanSubscriptionDetails, @@ -1926,163 +2501,68 @@ public IntentCreateParams.Action.Subscribe build() { this.v1SubscriptionDetails); } - /** - * Configuration for the billing details. If not specified, see the default behavior for - * individual attributes. - */ - public Builder setBillingDetails( - IntentCreateParams.Action.Subscribe.BillingDetails billingDetails) { - this.billingDetails = billingDetails; - return this; - } - - /** - * When the subscribe action will take effect. If not specified, the default behavior is - * on_reserve. - */ - public Builder setEffectiveAt(IntentCreateParams.Action.Subscribe.EffectiveAt effectiveAt) { - this.effectiveAt = effectiveAt; - return this; - } - - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Subscribe#extraParams} for the field - * documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.put(key, value); - return this; - } - - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Subscribe#extraParams} for the field - * documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.putAll(map); - return this; - } - - /** Details for subscribing to a pricing plan. */ - public Builder setPricingPlanSubscriptionDetails( - IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails - pricingPlanSubscriptionDetails) { - this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; - return this; - } - - /** Required. Type of the action details. */ - public Builder setType(IntentCreateParams.Action.Subscribe.Type type) { - this.type = type; - return this; - } - - /** Details for subscribing to a v1 subscription. */ - public Builder setV1SubscriptionDetails( - IntentCreateParams.Action.Subscribe.V1SubscriptionDetails v1SubscriptionDetails) { - this.v1SubscriptionDetails = v1SubscriptionDetails; + /** Allows users to override the collect at behavior. */ + public Builder setCollectAt(IntentCreateParams.Action.Subscribe.CollectAt collectAt) { + this.collectAt = collectAt; return this; - } - } - - @Getter - @EqualsAndHashCode(callSuper = false) - public static class BillingDetails { - /** - * Map of extra parameters for custom features not available in this client library. The - * content in this map is not serialized under this field's {@code @SerializedName} value. - * Instead, each key/value pair is serialized as if the key is a root-level field - * (serialized) name in this param object. Effectively, this map is flattened to its parent - * instance. - */ - @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) - Map extraParams; - - /** This controls the proration adjustment for the partial servicing period. */ - @SerializedName("proration_behavior") - ProrationBehavior prorationBehavior; - - private BillingDetails( - Map extraParams, ProrationBehavior prorationBehavior) { - this.extraParams = extraParams; - this.prorationBehavior = prorationBehavior; - } - - public static Builder builder() { - return new Builder(); - } - - public static class Builder { - private Map extraParams; - - private ProrationBehavior prorationBehavior; - - /** Finalize and obtain parameter instance from this builder. */ - public IntentCreateParams.Action.Subscribe.BillingDetails build() { - return new IntentCreateParams.Action.Subscribe.BillingDetails( - this.extraParams, this.prorationBehavior); - } - - /** - * Add a key/value pair to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Subscribe.BillingDetails#extraParams} for the - * field documentation. - */ - public Builder putExtraParam(String key, Object value) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.put(key, value); - return this; - } - - /** - * Add all map key/value pairs to `extraParams` map. A map is initialized for the first - * `put/putAll` call, and subsequent calls add additional key/value pairs to the original - * map. See {@link IntentCreateParams.Action.Subscribe.BillingDetails#extraParams} for the - * field documentation. - */ - public Builder putAllExtraParam(Map map) { - if (this.extraParams == null) { - this.extraParams = new HashMap<>(); - } - this.extraParams.putAll(map); - return this; - } + } - /** This controls the proration adjustment for the partial servicing period. */ - public Builder setProrationBehavior( - IntentCreateParams.Action.Subscribe.BillingDetails.ProrationBehavior - prorationBehavior) { - this.prorationBehavior = prorationBehavior; - return this; + /** + * When the subscribe action will take effect. If not specified, the default behavior is + * on_reserve. + */ + public Builder setEffectiveAt(IntentCreateParams.Action.Subscribe.EffectiveAt effectiveAt) { + this.effectiveAt = effectiveAt; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link IntentCreateParams.Action.Subscribe#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); } + this.extraParams.put(key, value); + return this; } - public enum ProrationBehavior implements ApiRequestParams.EnumParam { - @SerializedName("no_adjustment") - NO_ADJUSTMENT("no_adjustment"), + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link IntentCreateParams.Action.Subscribe#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } - @SerializedName("prorated_adjustment") - PRORATED_ADJUSTMENT("prorated_adjustment"); + /** Details for subscribing to a pricing plan. */ + public Builder setPricingPlanSubscriptionDetails( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails + pricingPlanSubscriptionDetails) { + this.pricingPlanSubscriptionDetails = pricingPlanSubscriptionDetails; + return this; + } - @Getter(onMethod_ = {@Override}) - private final String value; + /** Required. Type of the action details. */ + public Builder setType(IntentCreateParams.Action.Subscribe.Type type) { + this.type = type; + return this; + } - ProrationBehavior(String value) { - this.value = value; - } + /** Details for subscribing to a v1 subscription. */ + public Builder setV1SubscriptionDetails( + IntentCreateParams.Action.Subscribe.V1SubscriptionDetails v1SubscriptionDetails) { + this.v1SubscriptionDetails = v1SubscriptionDetails; + return this; } } @@ -2224,6 +2704,10 @@ public static class PricingPlanSubscriptionDetails { @SerializedName("metadata") Map metadata; + /** Allows users to override the partial period behavior. */ + @SerializedName("overrides") + Overrides overrides; + /** Required. ID of the Pricing Plan to subscribe to. */ @SerializedName("pricing_plan") String pricingPlan; @@ -2239,11 +2723,13 @@ private PricingPlanSubscriptionDetails( componentConfigurations, Map extraParams, Map metadata, + Overrides overrides, String pricingPlan, String pricingPlanVersion) { this.componentConfigurations = componentConfigurations; this.extraParams = extraParams; this.metadata = metadata; + this.overrides = overrides; this.pricingPlan = pricingPlan; this.pricingPlanVersion = pricingPlanVersion; } @@ -2262,6 +2748,8 @@ public static class Builder { private Map metadata; + private Overrides overrides; + private String pricingPlan; private String pricingPlanVersion; @@ -2272,6 +2760,7 @@ public IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails build( this.componentConfigurations, this.extraParams, this.metadata, + this.overrides, this.pricingPlan, this.pricingPlanVersion); } @@ -2372,6 +2861,14 @@ public Builder putAllMetadata(Map map) { return this; } + /** Allows users to override the partial period behavior. */ + public Builder setOverrides( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + overrides) { + this.overrides = overrides; + return this; + } + /** Required. ID of the Pricing Plan to subscribe to. */ public Builder setPricingPlan(String pricingPlan) { this.pricingPlan = pricingPlan; @@ -2492,6 +2989,336 @@ public Builder setQuantity(Long quantity) { } } } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Overrides { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. Override for the partial period behavior. */ + @SerializedName("partial_period_behaviors") + List< + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; + + private Overrides( + Map extraParams, + List< + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors) { + this.extraParams = extraParams; + this.partialPeriodBehaviors = partialPeriodBehaviors; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private List< + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + partialPeriodBehaviors; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + build() { + return new IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails + .Overrides(this.extraParams, this.partialPeriodBehaviors); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Add an element to `partialPeriodBehaviors` list. A list is initialized for the first + * `add/addAll` call, and subsequent calls adds additional elements to the original + * list. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addPartialPeriodBehavior( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + element) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.add(element); + return this; + } + + /** + * Add all elements to `partialPeriodBehaviors` list. A list is initialized for the + * first `add/addAll` call, and subsequent calls adds additional elements to the + * original list. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides#partialPeriodBehaviors} + * for the field documentation. + */ + public Builder addAllPartialPeriodBehavior( + List< + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior> + elements) { + if (this.partialPeriodBehaviors == null) { + this.partialPeriodBehaviors = new ArrayList<>(); + } + this.partialPeriodBehaviors.addAll(elements); + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PartialPeriodBehavior { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} + * value. Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Override for the license fee. */ + @SerializedName("license_fee") + LicenseFee licenseFee; + + /** Required. Type of the partial period behavior override. */ + @SerializedName("type") + Type type; + + private PartialPeriodBehavior( + Map extraParams, LicenseFee licenseFee, Type type) { + this.extraParams = extraParams; + this.licenseFee = licenseFee; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private LicenseFee licenseFee; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior + build() { + return new IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior(this.extraParams, this.licenseFee, this.type); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Override for the license fee. */ + public Builder setLicenseFee( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + licenseFee) { + this.licenseFee = licenseFee; + return this; + } + + /** Required. Type of the partial period behavior override. */ + public Builder setType( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.Type + type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class LicenseFee { + /** + * Required. The proration behavior for the partial servicing period. + * Defines how we prorate the license fee when the user is subscribing. + */ + @SerializedName("debit_proration_behavior") + DebitProrationBehavior debitProrationBehavior; + + /** + * Map of extra parameters for custom features not available in this client library. + * The content in this map is not serialized under this field's + * {@code @SerializedName} value. Instead, each key/value pair is serialized as if the + * key is a root-level field (serialized) name in this param object. Effectively, this + * map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private LicenseFee( + DebitProrationBehavior debitProrationBehavior, Map extraParams) { + this.debitProrationBehavior = debitProrationBehavior; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private DebitProrationBehavior debitProrationBehavior; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee + build() { + return new IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.LicenseFee( + this.debitProrationBehavior, this.extraParams); + } + + /** + * Required. The proration behavior for the partial servicing + * period. Defines how we prorate the license fee when the user is subscribing. + */ + public Builder setDebitProrationBehavior( + IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.LicenseFee.DebitProrationBehavior + debitProrationBehavior) { + this.debitProrationBehavior = debitProrationBehavior; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to + * the original map. See {@link + * IntentCreateParams.Action.Subscribe.PricingPlanSubscriptionDetails.Overrides.PartialPeriodBehavior.LicenseFee#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } + + public enum DebitProrationBehavior implements ApiRequestParams.EnumParam { + @SerializedName("none") + NONE("none"), + + @SerializedName("prorated") + PRORATED("prorated"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + DebitProrationBehavior(String value) { + this.value = value; + } + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("license_fee") + LICENSE_FEE("license_fee"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } + } + } } @Getter @@ -2789,6 +3616,21 @@ public Builder setQuantity(Long quantity) { } } + public enum CollectAt implements ApiRequestParams.EnumParam { + @SerializedName("next_billing_date") + NEXT_BILLING_DATE("next_billing_date"), + + @SerializedName("on_effective_at") + ON_EFFECTIVE_AT("on_effective_at"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + CollectAt(String value) { + this.value = value; + } + } + public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pricing_plan_subscription_details") PRICING_PLAN_SUBSCRIPTION_DETAILS("pricing_plan_subscription_details"), diff --git a/src/main/java/com/stripe/param/v2/core/AccountCreateParams.java b/src/main/java/com/stripe/param/v2/core/AccountCreateParams.java index e6d8d970123..4c91f5491a9 100644 --- a/src/main/java/com/stripe/param/v2/core/AccountCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/AccountCreateParams.java @@ -3,7 +3,6 @@ import com.google.gson.annotations.SerializedName; import com.stripe.net.ApiRequestParams; -import java.time.Instant; import java.util.ArrayList; import java.util.HashMap; import java.util.List; @@ -291,14 +290,20 @@ public static class Configuration { Map extraParams; /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your connected - * accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will be + * the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of + * set. */ @SerializedName("merchant") Merchant merchant; - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ @SerializedName("recipient") Recipient recipient; @@ -391,16 +396,22 @@ public Builder putAllExtraParam(Map map) { } /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your - * connected accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will + * be the Merchant of Record, like with Direct charges or Destination Charges with + * on_behalf_of set. */ public Builder setMerchant(AccountCreateParams.Configuration.Merchant merchant) { this.merchant = merchant; return this; } - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ public Builder setRecipient(AccountCreateParams.Configuration.Recipient recipient) { this.recipient = recipient; return this; @@ -1976,7 +1987,7 @@ public static class Billing { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Default settings used on invoices for this customer. */ + /** Default invoice settings for the customer account. */ @SerializedName("invoice") Invoice invoice; @@ -2028,7 +2039,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Default settings used on invoices for this customer. */ + /** Default invoice settings for the customer account. */ public Builder setInvoice( AccountCreateParams.Configuration.Customer.Billing.Invoice invoice) { this.invoice = invoice; @@ -2056,22 +2067,22 @@ public static class Invoice { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ @SerializedName("footer") String footer; - /** The sequence to be used on the customer's next invoice. Defaults to 1. */ + /** Sequence number to use on the customer account's next invoice. Defaults to 1. */ @SerializedName("next_sequence") Long nextSequence; /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ @SerializedName("prefix") String prefix; - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ @SerializedName("rendering") Rendering rendering; @@ -2183,28 +2194,28 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ public Builder setFooter(String footer) { this.footer = footer; return this; } - /** The sequence to be used on the customer's next invoice. Defaults to 1. */ + /** Sequence number to use on the customer account's next invoice. Defaults to 1. */ public Builder setNextSequence(Long nextSequence) { this.nextSequence = nextSequence; return this; } /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ public Builder setPrefix(String prefix) { this.prefix = prefix; return this; } - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ public Builder setRendering( AccountCreateParams.Configuration.Customer.Billing.Invoice.Rendering rendering) { this.rendering = rendering; @@ -2318,10 +2329,9 @@ public Builder setValue(String value) { @EqualsAndHashCode(callSuper = false) public static class Rendering { /** - * How line-item prices and amounts will be displayed with respect to tax on invoice - * PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include - * inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will - * exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. + * Indicates whether displayed line item prices and amounts on invoice PDFs include + * inclusive tax amounts. Must be either {@code include_inclusive_tax} or {@code + * exclude_tax}. */ @SerializedName("amount_tax_display") AmountTaxDisplay amountTaxDisplay; @@ -2367,11 +2377,9 @@ public AccountCreateParams.Configuration.Customer.Billing.Invoice.Rendering buil } /** - * How line-item prices and amounts will be displayed with respect to tax on invoice - * PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will - * include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. - * exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF - * amounts. + * Indicates whether displayed line item prices and amounts on invoice PDFs include + * inclusive tax amounts. Must be either {@code include_inclusive_tax} or {@code + * exclude_tax}. */ public Builder setAmountTaxDisplay( AccountCreateParams.Configuration.Customer.Billing.Invoice.Rendering @@ -2900,8 +2908,8 @@ public static class Merchant { KonbiniPayments konbiniPayments; /** - * The merchant category code for the Merchant Configuration. MCCs are used to classify - * businesses based on the goods or services they provide. + * The Merchant Category Code (MCC) for the Merchant Configuration. MCCs classify businesses + * based on the goods or services they provide. */ @SerializedName("mcc") String mcc; @@ -3047,8 +3055,8 @@ public Builder setKonbiniPayments( } /** - * The merchant category code for the Merchant Configuration. MCCs are used to classify - * businesses based on the goods or services they provide. + * The Merchant Category Code (MCC) for the Merchant Configuration. MCCs classify businesses + * based on the goods or services they provide. */ public Builder setMcc(String mcc) { this.mcc = mcc; @@ -3080,7 +3088,7 @@ public Builder setSupport(AccountCreateParams.Configuration.Merchant.Support sup @Getter @EqualsAndHashCode(callSuper = false) public static class BacsDebitPayments { - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ @SerializedName("display_name") String displayName; @@ -3114,7 +3122,7 @@ public AccountCreateParams.Configuration.Merchant.BacsDebitPayments build() { this.displayName, this.extraParams); } - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ public Builder setDisplayName(String displayName) { this.displayName = displayName; return this; @@ -8737,7 +8745,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -8863,7 +8871,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -9088,6 +9096,15 @@ public static class BankAccounts { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real time + * rails. + */ + @SerializedName("instant") + com.stripe.param.v2.core.AccountCreateParams.Configuration.Recipient.Capabilities + .BankAccounts.Instant + instant; + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -9099,8 +9116,15 @@ public static class BankAccounts { @SerializedName("wire") Wire wire; - private BankAccounts(Map extraParams, Local local, Wire wire) { + private BankAccounts( + Map extraParams, + com.stripe.param.v2.core.AccountCreateParams.Configuration.Recipient.Capabilities + .BankAccounts.Instant + instant, + Local local, + Wire wire) { this.extraParams = extraParams; + this.instant = instant; this.local = local; this.wire = wire; } @@ -9112,6 +9136,10 @@ public static Builder builder() { public static class Builder { private Map extraParams; + private com.stripe.param.v2.core.AccountCreateParams.Configuration.Recipient + .Capabilities.BankAccounts.Instant + instant; + private Local local; private Wire wire; @@ -9119,7 +9147,7 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts build() { return new AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts( - this.extraParams, this.local, this.wire); + this.extraParams, this.instant, this.local, this.wire); } /** @@ -9152,6 +9180,17 @@ public Builder putAllExtraParam(Map map) { return this; } + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real + * time rails. + */ + public Builder setInstant( + AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant + instant) { + this.instant = instant; + return this; + } + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -9172,6 +9211,88 @@ public Builder setWire( } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Instant { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} + * value. Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. To request a new Capability for an account, pass true. + * There can be a delay before the requested Capability becomes active. + */ + @SerializedName("requested") + Boolean requested; + + private Instant(Map extraParams, Boolean requested) { + this.extraParams = extraParams; + this.requested = requested; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Boolean requested; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant + build() { + return new AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts + .Instant(this.extraParams, this.requested); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * AccountCreateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. To request a new Capability for an account, pass true. + * There can be a delay before the requested Capability becomes active. + */ + public Builder setRequested(Boolean requested) { + this.requested = requested; + return this; + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Local { @@ -9513,7 +9634,7 @@ public static class StripeBalance { Map extraParams; /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). */ @SerializedName("stripe_transfers") StripeTransfers stripeTransfers; @@ -9569,7 +9690,8 @@ public Builder putAllExtraParam(Map map) { } /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance + * (/v1/balance). */ public Builder setStripeTransfers( AccountCreateParams.Configuration.Recipient.Capabilities.StripeBalance @@ -9686,7 +9808,7 @@ public static class Storer { @SerializedName("high_risk_activities") List highRiskActivities; - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ @SerializedName("high_risk_activities_description") String highRiskActivitiesDescription; @@ -9694,11 +9816,11 @@ public static class Storer { @SerializedName("money_services_description") String moneyServicesDescription; - /** Does the business operate in any prohibited countries. */ + /** Indicates whether the business operates in any prohibited countries. */ @SerializedName("operates_in_prohibited_countries") Boolean operatesInProhibitedCountries; - /** Does the business participate in any regulated activity. */ + /** Indicates whether the business participates in any regulated activity. */ @SerializedName("participates_in_regulated_activity") Boolean participatesInRegulatedActivity; @@ -9860,7 +9982,7 @@ public Builder addAllHighRiskActivity( return this; } - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ public Builder setHighRiskActivitiesDescription(String highRiskActivitiesDescription) { this.highRiskActivitiesDescription = highRiskActivitiesDescription; return this; @@ -9872,13 +9994,13 @@ public Builder setMoneyServicesDescription(String moneyServicesDescription) { return this; } - /** Does the business operate in any prohibited countries. */ + /** Indicates whether the business operates in any prohibited countries. */ public Builder setOperatesInProhibitedCountries(Boolean operatesInProhibitedCountries) { this.operatesInProhibitedCountries = operatesInProhibitedCountries; return this; } - /** Does the business participate in any regulated activity. */ + /** Indicates whether the business participates in any regulated activity. */ public Builder setParticipatesInRegulatedActivity(Boolean participatesInRegulatedActivity) { this.participatesInRegulatedActivity = participatesInRegulatedActivity; return this; @@ -13039,7 +13161,7 @@ public static class DirectorshipDeclaration { * & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13060,7 +13182,7 @@ public static class DirectorshipDeclaration { String userAgent; private DirectorshipDeclaration( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, Map extraParams, String ip, String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13072,7 +13194,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13090,7 +13212,7 @@ public AccountCreateParams.Identity.Attestations.DirectorshipDeclaration build() * The time marking when the director attestation was made. Represented as a RFC 3339 date * & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -13148,7 +13270,7 @@ public static class OwnershipDeclaration { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13169,7 +13291,7 @@ public static class OwnershipDeclaration { String userAgent; private OwnershipDeclaration( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, Map extraParams, String ip, String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13181,7 +13303,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13200,7 +13322,7 @@ public AccountCreateParams.Identity.Attestations.OwnershipDeclaration build() { * 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -13421,7 +13543,7 @@ public static class RepresentativeDeclaration { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13442,7 +13564,7 @@ public static class RepresentativeDeclaration { String userAgent; private RepresentativeDeclaration( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, Map extraParams, String ip, String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13454,7 +13576,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13473,7 +13595,7 @@ public AccountCreateParams.Identity.Attestations.RepresentativeDeclaration build * 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -13659,7 +13781,7 @@ public static class Account { * precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13686,7 +13808,10 @@ public static class Account { String userAgent; private Account( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13698,7 +13823,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13717,7 +13842,7 @@ public AccountCreateParams.Identity.Attestations.TermsOfService.Account build() * terms of service. Represented as a RFC 3339 date & time UTC value in millisecond * precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14026,7 +14151,7 @@ public static class AccountHolder { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -14053,7 +14178,10 @@ public static class AccountHolder { String userAgent; private AccountHolder( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14065,7 +14193,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14087,7 +14215,7 @@ public static class Builder { * the terms of service. Represented as a RFC 3339 date & time UTC value in * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14285,7 +14413,7 @@ public static class ApplePay { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -14312,7 +14440,10 @@ public static class ApplePay { String userAgent; private ApplePay( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14324,7 +14455,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14346,7 +14477,7 @@ public static class Builder { * the terms of service. Represented as a RFC 3339 date & time UTC value in * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14519,7 +14650,7 @@ public static class BankTerms { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -14546,7 +14677,10 @@ public static class BankTerms { String userAgent; private BankTerms( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14558,7 +14692,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14580,7 +14714,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14644,7 +14778,7 @@ public static class Platform { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -14671,7 +14805,10 @@ public static class Platform { String userAgent; private Platform( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14683,7 +14820,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14705,7 +14842,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14904,7 +15041,7 @@ public static class BankTerms { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -14931,7 +15068,10 @@ public static class BankTerms { String userAgent; private BankTerms( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14943,7 +15083,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14965,7 +15105,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15029,7 +15169,7 @@ public static class FinancingDisclosures { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15056,7 +15196,10 @@ public static class FinancingDisclosures { String userAgent; private FinancingDisclosures( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15068,7 +15211,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15090,7 +15233,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15154,7 +15297,7 @@ public static class Platform { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15181,7 +15324,10 @@ public static class Platform { String userAgent; private Platform( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15193,7 +15339,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15215,7 +15361,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15415,7 +15561,7 @@ public static class ApplePay { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -15442,7 +15588,10 @@ public static class ApplePay { String userAgent; private ApplePay( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15454,7 +15603,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15476,7 +15625,7 @@ public static class Builder { * the terms of service. Represented as a RFC 3339 date & time UTC value in * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15674,7 +15823,7 @@ public static class BankTerms { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15701,7 +15850,10 @@ public static class BankTerms { String userAgent; private BankTerms( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15713,7 +15865,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15735,7 +15887,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15799,7 +15951,7 @@ public static class FinancingDisclosures { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15826,7 +15978,10 @@ public static class FinancingDisclosures { String userAgent; private FinancingDisclosures( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15838,7 +15993,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15860,7 +16015,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15924,7 +16079,7 @@ public static class Platform { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15951,7 +16106,10 @@ public static class Platform { String userAgent; private Platform( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15963,7 +16121,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15985,7 +16143,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16161,7 +16319,7 @@ public static class BankTerms { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16188,7 +16346,10 @@ public static class BankTerms { String userAgent; private BankTerms( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16200,7 +16361,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16222,7 +16383,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16286,7 +16447,7 @@ public static class FinancingDisclosures { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16313,7 +16474,10 @@ public static class FinancingDisclosures { String userAgent; private FinancingDisclosures( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16325,7 +16489,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16347,7 +16511,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16413,7 +16577,7 @@ public static class GlobalAccountHolder { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -16440,7 +16604,10 @@ public static class GlobalAccountHolder { String userAgent; private GlobalAccountHolder( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16452,7 +16619,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16474,7 +16641,7 @@ public static class Builder { * the terms of service. Represented as a RFC 3339 date & time UTC value in * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16646,7 +16813,7 @@ public static class ApplePay { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -16673,7 +16840,10 @@ public static class ApplePay { String userAgent; private ApplePay( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16685,7 +16855,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16707,7 +16877,7 @@ public static class Builder { * the terms of service. Represented as a RFC 3339 date & time UTC value in * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16880,7 +17050,7 @@ public static class BankTerms { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16907,7 +17077,10 @@ public static class BankTerms { String userAgent; private BankTerms( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16919,7 +17092,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16941,7 +17114,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17005,7 +17178,7 @@ public static class Platform { * millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -17032,7 +17205,10 @@ public static class Platform { String userAgent; private Platform( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17044,7 +17220,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17066,7 +17242,7 @@ public static class Builder { * accepted the terms of service. Represented as a RFC 3339 date & time UTC * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17134,7 +17310,7 @@ public static class CryptoStorer { * precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -17161,7 +17337,10 @@ public static class CryptoStorer { String userAgent; private CryptoStorer( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17173,7 +17352,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17192,7 +17371,7 @@ public AccountCreateParams.Identity.Attestations.TermsOfService.CryptoStorer bui * terms of service. Represented as a RFC 3339 date & time UTC value in millisecond * precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17256,7 +17435,7 @@ public static class Storer { * precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -17283,7 +17462,10 @@ public static class Storer { String userAgent; private Storer( - Instant date, Map extraParams, String ip, String userAgent) { + java.time.Instant date, + Map extraParams, + String ip, + String userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17295,7 +17477,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17314,7 +17496,7 @@ public AccountCreateParams.Identity.Attestations.TermsOfService.Storer build() { * terms of service. Represented as a RFC 3339 date & time UTC value in millisecond * precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17394,8 +17576,8 @@ public static class BusinessDetails { Documents documents; /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for the - * business. + * Estimated maximum number of workers currently engaged by the business (including employees, + * contractors, and vendors). */ @SerializedName("estimated_worker_count") Long estimatedWorkerCount; @@ -17545,8 +17727,8 @@ public Builder setDocuments( } /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for - * the business. + * Estimated maximum number of workers currently engaged by the business (including + * employees, contractors, and vendors). */ public Builder setEstimatedWorkerCount(Long estimatedWorkerCount) { this.estimatedWorkerCount = estimatedWorkerCount; @@ -17690,7 +17872,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -17814,7 +17996,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -19853,6 +20035,12 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("at_fn") AT_FN("at_fn"), + @SerializedName("at_stn") + AT_STN("at_stn"), + + @SerializedName("at_vat") + AT_VAT("at_vat"), + @SerializedName("au_abn") AU_ABN("au_abn"), @@ -19871,9 +20059,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("be_cbe") BE_CBE("be_cbe"), + @SerializedName("be_vat") + BE_VAT("be_vat"), + @SerializedName("bg_uic") BG_UIC("bg_uic"), + @SerializedName("bg_vat") + BG_VAT("bg_vat"), + @SerializedName("br_cnpj") BR_CNPJ("br_cnpj"), @@ -19883,6 +20077,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ca_crarr") CA_CRARR("ca_crarr"), + @SerializedName("ca_gst_hst") + CA_GST_HST("ca_gst_hst"), + @SerializedName("ca_neq") CA_NEQ("ca_neq"), @@ -19901,33 +20098,60 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_he") + CY_HE("cy_he"), + @SerializedName("cy_tic") CY_TIC("cy_tic"), + @SerializedName("cy_vat") + CY_VAT("cy_vat"), + @SerializedName("cz_ico") CZ_ICO("cz_ico"), + @SerializedName("cz_vat") + CZ_VAT("cz_vat"), + @SerializedName("de_hrn") DE_HRN("de_hrn"), + @SerializedName("de_stn") + DE_STN("de_stn"), + @SerializedName("de_vat") DE_VAT("de_vat"), @SerializedName("dk_cvr") DK_CVR("dk_cvr"), + @SerializedName("dk_vat") + DK_VAT("dk_vat"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), @SerializedName("ee_rk") EE_RK("ee_rk"), + @SerializedName("ee_vat") + EE_VAT("ee_vat"), + @SerializedName("es_cif") ES_CIF("es_cif"), + @SerializedName("es_vat") + ES_VAT("es_vat"), + + @SerializedName("fi_vat") + FI_VAT("fi_vat"), + @SerializedName("fi_yt") FI_YT("fi_yt"), + @SerializedName("fr_rna") + FR_RNA("fr_rna"), + @SerializedName("fr_siren") FR_SIREN("fr_siren"), @@ -19940,9 +20164,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("gi_crn") GI_CRN("gi_crn"), + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gr_gemi") GR_GEMI("gr_gemi"), + @SerializedName("gr_vat") + GR_VAT("gr_vat"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @@ -19952,15 +20182,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("hk_cr") HK_CR("hk_cr"), - @SerializedName("hk_mbs") - HK_MBS("hk_mbs"), + @SerializedName("hr_mbs") + HR_MBS("hr_mbs"), + + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hr_vat") + HR_VAT("hr_vat"), @SerializedName("hu_cjs") HU_CJS("hu_cjs"), + @SerializedName("hu_tin") + HU_TIN("hu_tin"), + + @SerializedName("hu_vat") + HU_VAT("hu_vat"), + @SerializedName("ie_crn") IE_CRN("ie_crn"), + @SerializedName("ie_trn") + IE_TRN("ie_trn"), + + @SerializedName("ie_vat") + IE_VAT("ie_vat"), + @SerializedName("it_rea") IT_REA("it_rea"), @@ -19979,15 +20227,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("lt_ccrn") LT_CCRN("lt_ccrn"), + @SerializedName("lt_vat") + LT_VAT("lt_vat"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + @SerializedName("lu_rcs") LU_RCS("lu_rcs"), + @SerializedName("lu_vat") + LU_VAT("lu_vat"), + @SerializedName("lv_urn") LV_URN("lv_urn"), + @SerializedName("lv_vat") + LV_VAT("lv_vat"), + @SerializedName("mt_crn") MT_CRN("mt_crn"), + @SerializedName("mt_tin") + MT_TIN("mt_tin"), + + @SerializedName("mt_vat") + MT_VAT("mt_vat"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -19997,6 +20263,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("my_coid") MY_COID("my_coid"), + @SerializedName("my_itn") + MY_ITN("my_itn"), + @SerializedName("my_sst") MY_SST("my_sst"), @@ -20006,27 +20275,48 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("nl_kvk") NL_KVK("nl_kvk"), + @SerializedName("nl_rsin") + NL_RSIN("nl_rsin"), + + @SerializedName("nl_vat") + NL_VAT("nl_vat"), + @SerializedName("no_orgnr") NO_ORGNR("no_orgnr"), @SerializedName("nz_bn") NZ_BN("nz_bn"), + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_ruc") PE_RUC("pe_ruc"), @SerializedName("pk_ntn") PK_NTN("pk_ntn"), + @SerializedName("pl_nip") + PL_NIP("pl_nip"), + @SerializedName("pl_regon") PL_REGON("pl_regon"), + @SerializedName("pl_vat") + PL_VAT("pl_vat"), + @SerializedName("pt_vat") PT_VAT("pt_vat"), @SerializedName("ro_cui") RO_CUI("ro_cui"), + @SerializedName("ro_orc") + RO_ORC("ro_orc"), + + @SerializedName("ro_vat") + RO_VAT("ro_vat"), + @SerializedName("sa_crn") SA_CRN("sa_crn"), @@ -20036,15 +20326,30 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("se_orgnr") SE_ORGNR("se_orgnr"), + @SerializedName("se_vat") + SE_VAT("se_vat"), + @SerializedName("sg_uen") SG_UEN("sg_uen"), @SerializedName("si_msp") SI_MSP("si_msp"), + @SerializedName("si_tin") + SI_TIN("si_tin"), + + @SerializedName("si_vat") + SI_VAT("si_vat"), + + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("sk_ico") SK_ICO("sk_ico"), + @SerializedName("sk_vat") + SK_VAT("sk_vat"), + @SerializedName("th_crn") TH_CRN("th_crn"), @@ -20374,7 +20679,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -20500,7 +20805,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -20548,7 +20853,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -20674,7 +20979,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -21499,7 +21804,7 @@ public static class AdditionalAddress { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -21635,7 +21940,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -21828,7 +22133,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -21952,7 +22257,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -23185,9 +23490,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -23200,9 +23511,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -23212,21 +23550,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -23236,9 +23643,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -23248,21 +23664,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -23273,7 +23707,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -23561,7 +24001,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -23687,7 +24127,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -23735,7 +24175,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -23861,7 +24301,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/core/AccountLinkCreateParams.java b/src/main/java/com/stripe/param/v2/core/AccountLinkCreateParams.java index e7408b5612a..d54d854018e 100644 --- a/src/main/java/com/stripe/param/v2/core/AccountLinkCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/AccountLinkCreateParams.java @@ -95,11 +95,15 @@ public Builder setUseCase(AccountLinkCreateParams.UseCase useCase) { @Getter @EqualsAndHashCode(callSuper = false) public static class UseCase { - /** Indicates that the AccountLink provided should onboard an account. */ + /** + * Hash containing configuration options for an Account Link object that onboards a new account. + */ @SerializedName("account_onboarding") AccountOnboarding accountOnboarding; - /** Indicates that the AccountLink provided should update a previously onboarded account. */ + /** + * Hash containing configuration options for an Account Link that updates an existing account. + */ @SerializedName("account_update") AccountUpdate accountUpdate; @@ -112,7 +116,7 @@ public static class UseCase { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Required. Open Enum. The type of AccountLink the user is requesting. */ + /** Required. Open Enum. The type of Account Link the user is requesting. */ @SerializedName("type") Type type; @@ -146,14 +150,19 @@ public AccountLinkCreateParams.UseCase build() { this.accountOnboarding, this.accountUpdate, this.extraParams, this.type); } - /** Indicates that the AccountLink provided should onboard an account. */ + /** + * Hash containing configuration options for an Account Link object that onboards a new + * account. + */ public Builder setAccountOnboarding( AccountLinkCreateParams.UseCase.AccountOnboarding accountOnboarding) { this.accountOnboarding = accountOnboarding; return this; } - /** Indicates that the AccountLink provided should update a previously onboarded account. */ + /** + * Hash containing configuration options for an Account Link that updates an existing account. + */ public Builder setAccountUpdate(AccountLinkCreateParams.UseCase.AccountUpdate accountUpdate) { this.accountUpdate = accountUpdate; return this; @@ -185,7 +194,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Required. Open Enum. The type of AccountLink the user is requesting. */ + /** Required. Open Enum. The type of Account Link the user is requesting. */ public Builder setType(AccountLinkCreateParams.UseCase.Type type) { this.type = type; return this; @@ -551,13 +560,13 @@ public static class AccountUpdate { Map extraParams; /** - * Required. The URL the user will be redirected to if the AccountLink is + * Required. The URL the user will be redirected to if the Account Link is * expired, has been used, or is otherwise invalid. The URL you specify should attempt to - * generate a new AccountLink with the same parameters used to create the original - * AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the - * flow. If a new AccountLink cannot be generated or the redirect fails you should display a - * useful error to the user. Please make sure to implement authentication before redirecting - * the user in case this URL is leaked to a third party. + * generate a new Account Link with the same parameters used to create the original Account + * Link, then redirect the user to the new Account Link URL so they can continue the flow. + * Make sure to authenticate the user before redirecting to the new Account Link, in case the + * URL leaks to a third party. If a new Account Link can't be generated, or if the redirect + * fails, you should display a useful error to the user. */ @SerializedName("refresh_url") String refreshUrl; @@ -673,13 +682,13 @@ public Builder putAllExtraParam(Map map) { } /** - * Required. The URL the user will be redirected to if the AccountLink is + * Required. The URL the user will be redirected to if the Account Link is * expired, has been used, or is otherwise invalid. The URL you specify should attempt to - * generate a new AccountLink with the same parameters used to create the original - * AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the - * flow. If a new AccountLink cannot be generated or the redirect fails you should display a - * useful error to the user. Please make sure to implement authentication before redirecting - * the user in case this URL is leaked to a third party. + * generate a new Account Link with the same parameters used to create the original Account + * Link, then redirect the user to the new Account Link URL so they can continue the flow. + * Make sure to authenticate the user before redirecting to the new Account Link, in case + * the URL leaks to a third party. If a new Account Link can't be generated, or if the + * redirect fails, you should display a useful error to the user. */ public Builder setRefreshUrl(String refreshUrl) { this.refreshUrl = refreshUrl; @@ -709,8 +718,7 @@ public static class CollectionOptions { /** * Specifies whether the platform collects only currently_due requirements ({@code * currently_due}) or both currently_due and eventually_due requirements ({@code - * eventually_due}). If you don’t specify collection_options, the default value is - * currently_due. + * eventually_due}). The default value is {@code currently_due}. */ @SerializedName("fields") Fields fields; @@ -779,8 +787,7 @@ public Builder putAllExtraParam(Map map) { /** * Specifies whether the platform collects only currently_due requirements ({@code * currently_due}) or both currently_due and eventually_due requirements ({@code - * eventually_due}). If you don’t specify collection_options, the default value is - * currently_due. + * eventually_due}). The default value is {@code currently_due}. */ public Builder setFields( AccountLinkCreateParams.UseCase.AccountUpdate.CollectionOptions.Fields fields) { diff --git a/src/main/java/com/stripe/param/v2/core/AccountListParams.java b/src/main/java/com/stripe/param/v2/core/AccountListParams.java index 9f6d976161c..e74a576fcc0 100644 --- a/src/main/java/com/stripe/param/v2/core/AccountListParams.java +++ b/src/main/java/com/stripe/param/v2/core/AccountListParams.java @@ -18,7 +18,7 @@ public class AccountListParams extends ApiRequestParams { * accounts regardless of which configurations they have. */ @SerializedName("applied_configurations") - List appliedConfigurations; + List appliedConfigurations; /** * Filter by whether the account is closed. If omitted, returns only Accounts that are not closed. @@ -40,7 +40,7 @@ public class AccountListParams extends ApiRequestParams { Long limit; private AccountListParams( - List appliedConfigurations, + List appliedConfigurations, Boolean closed, Map extraParams, Long limit) { @@ -55,7 +55,7 @@ public static Builder builder() { } public static class Builder { - private List appliedConfigurations; + private List appliedConfigurations; private Boolean closed; @@ -74,7 +74,7 @@ public AccountListParams build() { * `add/addAll` call, and subsequent calls adds additional elements to the original list. See * {@link AccountListParams#appliedConfigurations} for the field documentation. */ - public Builder addAppliedConfiguration(String element) { + public Builder addAppliedConfiguration(AccountListParams.AppliedConfiguration element) { if (this.appliedConfigurations == null) { this.appliedConfigurations = new ArrayList<>(); } @@ -87,7 +87,8 @@ public Builder addAppliedConfiguration(String element) { * `add/addAll` call, and subsequent calls adds additional elements to the original list. See * {@link AccountListParams#appliedConfigurations} for the field documentation. */ - public Builder addAllAppliedConfiguration(List elements) { + public Builder addAllAppliedConfiguration( + List elements) { if (this.appliedConfigurations == null) { this.appliedConfigurations = new ArrayList<>(); } @@ -136,4 +137,28 @@ public Builder setLimit(Long limit) { return this; } } + + public enum AppliedConfiguration implements ApiRequestParams.EnumParam { + @SerializedName("card_creator") + CARD_CREATOR("card_creator"), + + @SerializedName("customer") + CUSTOMER("customer"), + + @SerializedName("merchant") + MERCHANT("merchant"), + + @SerializedName("recipient") + RECIPIENT("recipient"), + + @SerializedName("storer") + STORER("storer"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + AppliedConfiguration(String value) { + this.value = value; + } + } } diff --git a/src/main/java/com/stripe/param/v2/core/AccountTokenCreateParams.java b/src/main/java/com/stripe/param/v2/core/AccountTokenCreateParams.java index b6910871de9..ade31232af5 100644 --- a/src/main/java/com/stripe/param/v2/core/AccountTokenCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/AccountTokenCreateParams.java @@ -37,10 +37,7 @@ public class AccountTokenCreateParams extends ApiRequestParams { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** - * Required. Information about the company, individual, and business represented - * by the Account. - */ + /** Information about the company, individual, and business represented by the Account. */ @SerializedName("identity") Identity identity; @@ -115,10 +112,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** - * Required. Information about the company, individual, and business - * represented by the Account. - */ + /** Information about the company, individual, and business represented by the Account. */ public Builder setIdentity(AccountTokenCreateParams.Identity identity) { this.identity = identity; return this; @@ -3184,8 +3178,8 @@ public static class BusinessDetails { Documents documents; /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for the - * business. + * Estimated maximum number of workers currently engaged by the business (including employees, + * contractors, and vendors). */ @SerializedName("estimated_worker_count") Long estimatedWorkerCount; @@ -3336,8 +3330,8 @@ public Builder setDocuments( } /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for - * the business. + * Estimated maximum number of workers currently engaged by the business (including + * employees, contractors, and vendors). */ public Builder setEstimatedWorkerCount(Long estimatedWorkerCount) { this.estimatedWorkerCount = estimatedWorkerCount; @@ -3482,7 +3476,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -3606,7 +3600,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -5660,6 +5654,12 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("at_fn") AT_FN("at_fn"), + @SerializedName("at_stn") + AT_STN("at_stn"), + + @SerializedName("at_vat") + AT_VAT("at_vat"), + @SerializedName("au_abn") AU_ABN("au_abn"), @@ -5678,9 +5678,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("be_cbe") BE_CBE("be_cbe"), + @SerializedName("be_vat") + BE_VAT("be_vat"), + @SerializedName("bg_uic") BG_UIC("bg_uic"), + @SerializedName("bg_vat") + BG_VAT("bg_vat"), + @SerializedName("br_cnpj") BR_CNPJ("br_cnpj"), @@ -5690,6 +5696,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ca_crarr") CA_CRARR("ca_crarr"), + @SerializedName("ca_gst_hst") + CA_GST_HST("ca_gst_hst"), + @SerializedName("ca_neq") CA_NEQ("ca_neq"), @@ -5708,33 +5717,60 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_he") + CY_HE("cy_he"), + @SerializedName("cy_tic") CY_TIC("cy_tic"), + @SerializedName("cy_vat") + CY_VAT("cy_vat"), + @SerializedName("cz_ico") CZ_ICO("cz_ico"), + @SerializedName("cz_vat") + CZ_VAT("cz_vat"), + @SerializedName("de_hrn") DE_HRN("de_hrn"), + @SerializedName("de_stn") + DE_STN("de_stn"), + @SerializedName("de_vat") DE_VAT("de_vat"), @SerializedName("dk_cvr") DK_CVR("dk_cvr"), + @SerializedName("dk_vat") + DK_VAT("dk_vat"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), @SerializedName("ee_rk") EE_RK("ee_rk"), + @SerializedName("ee_vat") + EE_VAT("ee_vat"), + @SerializedName("es_cif") ES_CIF("es_cif"), + @SerializedName("es_vat") + ES_VAT("es_vat"), + + @SerializedName("fi_vat") + FI_VAT("fi_vat"), + @SerializedName("fi_yt") FI_YT("fi_yt"), + @SerializedName("fr_rna") + FR_RNA("fr_rna"), + @SerializedName("fr_siren") FR_SIREN("fr_siren"), @@ -5747,9 +5783,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("gi_crn") GI_CRN("gi_crn"), + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gr_gemi") GR_GEMI("gr_gemi"), + @SerializedName("gr_vat") + GR_VAT("gr_vat"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @@ -5759,15 +5801,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("hk_cr") HK_CR("hk_cr"), - @SerializedName("hk_mbs") - HK_MBS("hk_mbs"), + @SerializedName("hr_mbs") + HR_MBS("hr_mbs"), + + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hr_vat") + HR_VAT("hr_vat"), @SerializedName("hu_cjs") HU_CJS("hu_cjs"), + @SerializedName("hu_tin") + HU_TIN("hu_tin"), + + @SerializedName("hu_vat") + HU_VAT("hu_vat"), + @SerializedName("ie_crn") IE_CRN("ie_crn"), + @SerializedName("ie_trn") + IE_TRN("ie_trn"), + + @SerializedName("ie_vat") + IE_VAT("ie_vat"), + @SerializedName("it_rea") IT_REA("it_rea"), @@ -5786,15 +5846,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("lt_ccrn") LT_CCRN("lt_ccrn"), + @SerializedName("lt_vat") + LT_VAT("lt_vat"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + @SerializedName("lu_rcs") LU_RCS("lu_rcs"), + @SerializedName("lu_vat") + LU_VAT("lu_vat"), + @SerializedName("lv_urn") LV_URN("lv_urn"), + @SerializedName("lv_vat") + LV_VAT("lv_vat"), + @SerializedName("mt_crn") MT_CRN("mt_crn"), + @SerializedName("mt_tin") + MT_TIN("mt_tin"), + + @SerializedName("mt_vat") + MT_VAT("mt_vat"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -5804,6 +5882,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("my_coid") MY_COID("my_coid"), + @SerializedName("my_itn") + MY_ITN("my_itn"), + @SerializedName("my_sst") MY_SST("my_sst"), @@ -5813,27 +5894,48 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("nl_kvk") NL_KVK("nl_kvk"), + @SerializedName("nl_rsin") + NL_RSIN("nl_rsin"), + + @SerializedName("nl_vat") + NL_VAT("nl_vat"), + @SerializedName("no_orgnr") NO_ORGNR("no_orgnr"), @SerializedName("nz_bn") NZ_BN("nz_bn"), + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_ruc") PE_RUC("pe_ruc"), @SerializedName("pk_ntn") PK_NTN("pk_ntn"), + @SerializedName("pl_nip") + PL_NIP("pl_nip"), + @SerializedName("pl_regon") PL_REGON("pl_regon"), + @SerializedName("pl_vat") + PL_VAT("pl_vat"), + @SerializedName("pt_vat") PT_VAT("pt_vat"), @SerializedName("ro_cui") RO_CUI("ro_cui"), + @SerializedName("ro_orc") + RO_ORC("ro_orc"), + + @SerializedName("ro_vat") + RO_VAT("ro_vat"), + @SerializedName("sa_crn") SA_CRN("sa_crn"), @@ -5843,15 +5945,30 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("se_orgnr") SE_ORGNR("se_orgnr"), + @SerializedName("se_vat") + SE_VAT("se_vat"), + @SerializedName("sg_uen") SG_UEN("sg_uen"), @SerializedName("si_msp") SI_MSP("si_msp"), + @SerializedName("si_tin") + SI_TIN("si_tin"), + + @SerializedName("si_vat") + SI_VAT("si_vat"), + + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("sk_ico") SK_ICO("sk_ico"), + @SerializedName("sk_vat") + SK_VAT("sk_vat"), + @SerializedName("th_crn") TH_CRN("th_crn"), @@ -6182,7 +6299,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -6308,7 +6425,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -6356,7 +6473,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -6482,7 +6599,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -7330,7 +7447,7 @@ public static class AdditionalAddress { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -7468,7 +7585,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -7663,7 +7780,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -7787,7 +7904,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -9026,9 +9143,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -9041,9 +9164,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -9053,21 +9203,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -9077,9 +9296,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -9089,21 +9317,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -9114,7 +9360,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -9404,7 +9656,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -9530,7 +9782,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -9578,7 +9830,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -9704,7 +9956,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/core/AccountUpdateParams.java b/src/main/java/com/stripe/param/v2/core/AccountUpdateParams.java index 5d872dfaa14..80b2a8091f0 100644 --- a/src/main/java/com/stripe/param/v2/core/AccountUpdateParams.java +++ b/src/main/java/com/stripe/param/v2/core/AccountUpdateParams.java @@ -4,7 +4,6 @@ import com.google.gson.annotations.SerializedName; import com.stripe.net.ApiRequestParams; import com.stripe.param.common.EmptyParam; -import java.time.Instant; import java.util.ArrayList; import java.util.HashMap; import java.util.List; @@ -334,14 +333,20 @@ public static class Configuration { Map extraParams; /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your connected - * accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will be + * the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of + * set. */ @SerializedName("merchant") Merchant merchant; - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ @SerializedName("recipient") Recipient recipient; @@ -434,16 +439,22 @@ public Builder putAllExtraParam(Map map) { } /** - * The Merchant configuration allows the Account to act as a connected account and collect - * payments facilitated by a Connect platform. You can add this configuration to your - * connected accounts only if you’ve completed onboarding as a Connect platform. + * Enables the Account to act as a connected account and collect payments facilitated by a + * Connect platform. You must onboard your platform to Connect before you can add this + * configuration to your connected accounts. Utilize this configuration when the Account will + * be the Merchant of Record, like with Direct charges or Destination Charges with + * on_behalf_of set. */ public Builder setMerchant(AccountUpdateParams.Configuration.Merchant merchant) { this.merchant = merchant; return this; } - /** The Recipient Configuration allows the Account to receive funds. */ + /** + * The Recipient Configuration allows the Account to receive funds. Utilize this configuration + * if the Account will not be the Merchant of Record, like with Separate Charges & + * Transfers, or Destination Charges without on_behalf_of set. + */ public Builder setRecipient(AccountUpdateParams.Configuration.Recipient recipient) { this.recipient = recipient; return this; @@ -1893,9 +1904,9 @@ public Builder setTestClock(EmptyParam testClock) { @EqualsAndHashCode(callSuper = false) public static class AutomaticIndirectTax { /** - * Describes the customer's tax exemption status, which is {@code none}, {@code exempt}, or - * {@code reverse}. When set to reverse, invoice and receipt PDFs include the following - * text: “Reverse charge”. + * The customer account's tax exemption status: {@code none}, {@code exempt}, or {@code + * reverse}. When {@code reverse}, invoice and receipt PDFs include "Reverse + * charge". */ @SerializedName("exempt") Exempt exempt; @@ -1917,16 +1928,15 @@ public static class AutomaticIndirectTax { Object ipAddress; /** - * The data source used to identify the customer's tax location - defaults to {@code - * identity_address}. Will only be used for automatic tax calculation on the customer's - * Invoices and Subscriptions. This behavior is now deprecated for new users. + * Data source used to identify the customer account's tax location. Defaults to {@code + * identity_address}. Used for automatic indirect tax calculation. */ @SerializedName("location_source") LocationSource locationSource; /** * A per-request flag that indicates when Stripe should validate the customer tax location - - * defaults to 'auto'. + * defaults to {@code auto}. */ @SerializedName("validate_location") ValidateLocation validateLocation; @@ -1970,9 +1980,9 @@ public AccountUpdateParams.Configuration.Customer.AutomaticIndirectTax build() { } /** - * Describes the customer's tax exemption status, which is {@code none}, {@code exempt}, - * or {@code reverse}. When set to reverse, invoice and receipt PDFs include the following - * text: “Reverse charge”. + * The customer account's tax exemption status: {@code none}, {@code exempt}, or {@code + * reverse}. When {@code reverse}, invoice and receipt PDFs include "Reverse + * charge". */ public Builder setExempt( AccountUpdateParams.Configuration.Customer.AutomaticIndirectTax.Exempt exempt) { @@ -2027,9 +2037,8 @@ public Builder setIpAddress(EmptyParam ipAddress) { } /** - * The data source used to identify the customer's tax location - defaults to {@code - * identity_address}. Will only be used for automatic tax calculation on the customer's - * Invoices and Subscriptions. This behavior is now deprecated for new users. + * Data source used to identify the customer account's tax location. Defaults to {@code + * identity_address}. Used for automatic indirect tax calculation. */ public Builder setLocationSource( AccountUpdateParams.Configuration.Customer.AutomaticIndirectTax.LocationSource @@ -2040,7 +2049,7 @@ public Builder setLocationSource( /** * A per-request flag that indicates when Stripe should validate the customer tax location - * - defaults to 'auto'. + * - defaults to {@code auto}. */ public Builder setValidateLocation( AccountUpdateParams.Configuration.Customer.AutomaticIndirectTax.ValidateLocation @@ -2112,8 +2121,8 @@ public enum ValidateLocation implements ApiRequestParams.EnumParam { @EqualsAndHashCode(callSuper = false) public static class Billing { /** - * 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") Object defaultPaymentMethod; @@ -2128,7 +2137,7 @@ public static class Billing { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Default settings used on invoices for this customer. */ + /** Default invoice settings for the customer account. */ @SerializedName("invoice") Invoice invoice; @@ -2157,8 +2166,8 @@ public AccountUpdateParams.Configuration.Customer.Billing build() { } /** - * 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. */ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { this.defaultPaymentMethod = defaultPaymentMethod; @@ -2166,8 +2175,8 @@ public Builder setDefaultPaymentMethod(String defaultPaymentMethod) { } /** - * 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. */ public Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod) { this.defaultPaymentMethod = defaultPaymentMethod; @@ -2202,7 +2211,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Default settings used on invoices for this customer. */ + /** Default invoice settings for the customer account. */ public Builder setInvoice( AccountUpdateParams.Configuration.Customer.Billing.Invoice invoice) { this.invoice = invoice; @@ -2230,22 +2239,22 @@ public static class Invoice { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ @SerializedName("footer") Object footer; - /** The sequence to be used on the customer's next invoice. Defaults to 1. */ + /** Sequence number to use on the customer account's next invoice. Defaults to 1. */ @SerializedName("next_sequence") Long nextSequence; /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ @SerializedName("prefix") Object prefix; - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ @SerializedName("rendering") Rendering rendering; @@ -2357,27 +2366,27 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ public Builder setFooter(String footer) { this.footer = footer; return this; } - /** Default footer to be displayed on invoices for this customer. */ + /** Default invoice footer. */ public Builder setFooter(EmptyParam footer) { this.footer = footer; return this; } - /** The sequence to be used on the customer's next invoice. Defaults to 1. */ + /** Sequence number to use on the customer account's next invoice. Defaults to 1. */ public Builder setNextSequence(Long nextSequence) { this.nextSequence = nextSequence; return this; } /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ public Builder setPrefix(String prefix) { this.prefix = prefix; @@ -2385,15 +2394,15 @@ public Builder setPrefix(String prefix) { } /** - * The prefix for the customer used to generate unique invoice numbers. Must be 3–12 - * uppercase letters or numbers. + * Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or + * numbers. */ public Builder setPrefix(EmptyParam prefix) { this.prefix = prefix; return this; } - /** Default options for invoice PDF rendering for this customer. */ + /** Default invoice PDF rendering options. */ public Builder setRendering( AccountUpdateParams.Configuration.Customer.Billing.Invoice.Rendering rendering) { this.rendering = rendering; @@ -2526,10 +2535,9 @@ public Builder setValue(EmptyParam value) { @EqualsAndHashCode(callSuper = false) public static class Rendering { /** - * How line-item prices and amounts will be displayed with respect to tax on invoice - * PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include - * inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will - * exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. + * Indicates whether displayed line item prices and amounts on invoice PDFs include + * inclusive tax amounts. Must be either {@code include_inclusive_tax} or {@code + * exclude_tax}. */ @SerializedName("amount_tax_display") AmountTaxDisplay amountTaxDisplay; @@ -2575,11 +2583,9 @@ public AccountUpdateParams.Configuration.Customer.Billing.Invoice.Rendering buil } /** - * How line-item prices and amounts will be displayed with respect to tax on invoice - * PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will - * include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. - * exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF - * amounts. + * Indicates whether displayed line item prices and amounts on invoice PDFs include + * inclusive tax amounts. Must be either {@code include_inclusive_tax} or {@code + * exclude_tax}. */ public Builder setAmountTaxDisplay( AccountUpdateParams.Configuration.Customer.Billing.Invoice.Rendering @@ -3139,7 +3145,7 @@ public static class Merchant { @SerializedName("applied") Boolean applied; - /** Settings used for Bacs debit payments. */ + /** Settings for Bacs Direct Debit payments. */ @SerializedName("bacs_debit_payments") BacsDebitPayments bacsDebitPayments; @@ -3172,8 +3178,8 @@ public static class Merchant { KonbiniPayments konbiniPayments; /** - * The merchant category code for the merchant. MCCs are used to classify businesses based on - * the goods or services they provide. + * The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the + * goods or services they provide. */ @SerializedName("mcc") Object mcc; @@ -3182,7 +3188,10 @@ public static class Merchant { @SerializedName("script_statement_descriptor") ScriptStatementDescriptor scriptStatementDescriptor; - /** Statement descriptor. */ + /** + * Settings for the default statement descriptor text. + */ @SerializedName("statement_descriptor") StatementDescriptor statementDescriptor; @@ -3267,7 +3276,7 @@ public Builder setApplied(Boolean applied) { return this; } - /** Settings used for Bacs debit payments. */ + /** Settings for Bacs Direct Debit payments. */ public Builder setBacsDebitPayments( AccountUpdateParams.Configuration.Merchant.BacsDebitPayments bacsDebitPayments) { this.bacsDebitPayments = bacsDebitPayments; @@ -3333,8 +3342,8 @@ public Builder setKonbiniPayments( } /** - * The merchant category code for the merchant. MCCs are used to classify businesses based - * on the goods or services they provide. + * The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the + * goods or services they provide. */ public Builder setMcc(String mcc) { this.mcc = mcc; @@ -3342,8 +3351,8 @@ public Builder setMcc(String mcc) { } /** - * The merchant category code for the merchant. MCCs are used to classify businesses based - * on the goods or services they provide. + * The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the + * goods or services they provide. */ public Builder setMcc(EmptyParam mcc) { this.mcc = mcc; @@ -3358,7 +3367,10 @@ public Builder setScriptStatementDescriptor( return this; } - /** Statement descriptor. */ + /** + * Settings for the default statement descriptor text. + */ public Builder setStatementDescriptor( AccountUpdateParams.Configuration.Merchant.StatementDescriptor statementDescriptor) { this.statementDescriptor = statementDescriptor; @@ -3375,7 +3387,7 @@ public Builder setSupport(AccountUpdateParams.Configuration.Merchant.Support sup @Getter @EqualsAndHashCode(callSuper = false) public static class BacsDebitPayments { - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ @SerializedName("display_name") Object displayName; @@ -3409,13 +3421,13 @@ public AccountUpdateParams.Configuration.Merchant.BacsDebitPayments build() { this.displayName, this.extraParams); } - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ public Builder setDisplayName(String displayName) { this.displayName = displayName; return this; } - /** Display name for Bacs debit payments. */ + /** Display name for Bacs Direct Debit payments. */ public Builder setDisplayName(EmptyParam displayName) { this.displayName = displayName; return this; @@ -9192,7 +9204,7 @@ public static class Address { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -9357,13 +9369,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -9651,6 +9663,15 @@ public static class BankAccounts { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real time + * rails. + */ + @SerializedName("instant") + com.stripe.param.v2.core.AccountUpdateParams.Configuration.Recipient.Capabilities + .BankAccounts.Instant + instant; + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -9662,8 +9683,15 @@ public static class BankAccounts { @SerializedName("wire") Wire wire; - private BankAccounts(Map extraParams, Local local, Wire wire) { + private BankAccounts( + Map extraParams, + com.stripe.param.v2.core.AccountUpdateParams.Configuration.Recipient.Capabilities + .BankAccounts.Instant + instant, + Local local, + Wire wire) { this.extraParams = extraParams; + this.instant = instant; this.local = local; this.wire = wire; } @@ -9675,6 +9703,10 @@ public static Builder builder() { public static class Builder { private Map extraParams; + private com.stripe.param.v2.core.AccountUpdateParams.Configuration.Recipient + .Capabilities.BankAccounts.Instant + instant; + private Local local; private Wire wire; @@ -9682,7 +9714,7 @@ public static class Builder { /** Finalize and obtain parameter instance from this builder. */ public AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts build() { return new AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts( - this.extraParams, this.local, this.wire); + this.extraParams, this.instant, this.local, this.wire); } /** @@ -9715,6 +9747,17 @@ public Builder putAllExtraParam(Map map) { return this; } + /** + * Enables this Account to receive OutboundPayments to linked bank accounts over real + * time rails. + */ + public Builder setInstant( + AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant + instant) { + this.instant = instant; + return this; + } + /** * Enables this Account to receive OutboundPayments to linked bank accounts over local * networks. @@ -9735,6 +9778,88 @@ public Builder setWire( } } + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Instant { + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} + * value. Instead, each key/value pair is serialized as if the key is a root-level field + * (serialized) name in this param object. Effectively, this map is flattened to its + * parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * To request a new Capability for an account, pass true. There can be a delay before + * the requested Capability becomes active. + */ + @SerializedName("requested") + Boolean requested; + + private Instant(Map extraParams, Boolean requested) { + this.extraParams = extraParams; + this.requested = requested; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Boolean requested; + + /** Finalize and obtain parameter instance from this builder. */ + public AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant + build() { + return new AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts + .Instant(this.extraParams, this.requested); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant#extraParams} + * for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the + * first `put/putAll` call, and subsequent calls add additional key/value pairs to the + * original map. See {@link + * AccountUpdateParams.Configuration.Recipient.Capabilities.BankAccounts.Instant#extraParams} + * for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * To request a new Capability for an account, pass true. There can be a delay before + * the requested Capability becomes active. + */ + public Builder setRequested(Boolean requested) { + this.requested = requested; + return this; + } + } + } + @Getter @EqualsAndHashCode(callSuper = false) public static class Local { @@ -10076,7 +10201,7 @@ public static class StripeBalance { Map extraParams; /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). */ @SerializedName("stripe_transfers") StripeTransfers stripeTransfers; @@ -10132,7 +10257,8 @@ public Builder putAllExtraParam(Map map) { } /** - * Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance). + * Enables this Account to receive /v1/transfers into their Stripe Balance + * (/v1/balance). */ public Builder setStripeTransfers( AccountUpdateParams.Configuration.Recipient.Capabilities.StripeBalance @@ -10256,7 +10382,7 @@ public static class Storer { @SerializedName("high_risk_activities") List highRiskActivities; - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ @SerializedName("high_risk_activities_description") Object highRiskActivitiesDescription; @@ -10268,7 +10394,7 @@ public static class Storer { @SerializedName("operates_in_prohibited_countries") Boolean operatesInProhibitedCountries; - /** Does the business participate in any regulated activity. */ + /** Indicates whether the business participates in any regulated activity. */ @SerializedName("participates_in_regulated_activity") Boolean participatesInRegulatedActivity; @@ -10444,13 +10570,13 @@ public Builder addAllHighRiskActivity( return this; } - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ public Builder setHighRiskActivitiesDescription(String highRiskActivitiesDescription) { this.highRiskActivitiesDescription = highRiskActivitiesDescription; return this; } - /** An explanation of the high risk activities that the business performs. */ + /** Description of the high-risk activities the business offers. */ public Builder setHighRiskActivitiesDescription(EmptyParam highRiskActivitiesDescription) { this.highRiskActivitiesDescription = highRiskActivitiesDescription; return this; @@ -10474,7 +10600,7 @@ public Builder setOperatesInProhibitedCountries(Boolean operatesInProhibitedCoun return this; } - /** Does the business participate in any regulated activity. */ + /** Indicates whether the business participates in any regulated activity. */ public Builder setParticipatesInRegulatedActivity(Boolean participatesInRegulatedActivity) { this.participatesInRegulatedActivity = participatesInRegulatedActivity; return this; @@ -13731,7 +13857,7 @@ public static class DirectorshipDeclaration { * & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13752,7 +13878,7 @@ public static class DirectorshipDeclaration { Object userAgent; private DirectorshipDeclaration( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, Map extraParams, Object ip, Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13764,7 +13890,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13782,7 +13908,7 @@ public AccountUpdateParams.Identity.Attestations.DirectorshipDeclaration build() * The time marking when the director attestation was made. Represented as a RFC 3339 date * & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -13852,7 +13978,7 @@ public static class OwnershipDeclaration { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -13873,7 +13999,7 @@ public static class OwnershipDeclaration { Object userAgent; private OwnershipDeclaration( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, Map extraParams, Object ip, Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -13885,7 +14011,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -13904,7 +14030,7 @@ public AccountUpdateParams.Identity.Attestations.OwnershipDeclaration build() { * 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14137,7 +14263,7 @@ public static class RepresentativeDeclaration { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -14158,7 +14284,7 @@ public static class RepresentativeDeclaration { Object userAgent; private RepresentativeDeclaration( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, Map extraParams, Object ip, Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14170,7 +14296,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14189,7 +14315,7 @@ public AccountUpdateParams.Identity.Attestations.RepresentativeDeclaration build * 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14387,7 +14513,7 @@ public static class Account { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -14413,7 +14539,10 @@ public static class Account { Object userAgent; private Account( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14425,7 +14554,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14444,7 +14573,7 @@ public AccountUpdateParams.Identity.Attestations.TermsOfService.Account build() * as a RFC 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -14769,7 +14898,7 @@ public static class AccountHolder { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -14796,7 +14925,10 @@ public static class AccountHolder { Object userAgent; private AccountHolder( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -14808,7 +14940,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -14830,7 +14962,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, for * example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15046,7 +15178,7 @@ public static class ApplePay { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -15073,7 +15205,10 @@ public static class ApplePay { Object userAgent; private ApplePay( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15085,7 +15220,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15107,7 +15242,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15298,7 +15433,7 @@ public static class BankTerms { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15325,7 +15460,10 @@ public static class BankTerms { Object userAgent; private BankTerms( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15337,7 +15475,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15359,7 +15497,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15441,7 +15579,7 @@ public static class Platform { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15468,7 +15606,10 @@ public static class Platform { Object userAgent; private Platform( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15480,7 +15621,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15502,7 +15643,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15719,7 +15860,7 @@ public static class BankTerms { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15746,7 +15887,10 @@ public static class BankTerms { Object userAgent; private BankTerms( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15758,7 +15902,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15780,7 +15924,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -15862,7 +16006,7 @@ public static class FinancingDisclosures { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -15889,7 +16033,10 @@ public static class FinancingDisclosures { Object userAgent; private FinancingDisclosures( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -15901,7 +16048,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -15923,7 +16070,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16005,7 +16152,7 @@ public static class Platform { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16032,7 +16179,10 @@ public static class Platform { Object userAgent; private Platform( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16044,7 +16194,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16066,7 +16216,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16284,7 +16434,7 @@ public static class ApplePay { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -16311,7 +16461,10 @@ public static class ApplePay { Object userAgent; private ApplePay( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16323,7 +16476,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16345,7 +16498,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16561,7 +16714,7 @@ public static class BankTerms { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16588,7 +16741,10 @@ public static class BankTerms { Object userAgent; private BankTerms( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16600,7 +16756,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16622,7 +16778,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16704,7 +16860,7 @@ public static class FinancingDisclosures { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16731,7 +16887,10 @@ public static class FinancingDisclosures { Object userAgent; private FinancingDisclosures( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16743,7 +16902,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16765,7 +16924,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -16847,7 +17006,7 @@ public static class Platform { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -16874,7 +17033,10 @@ public static class Platform { Object userAgent; private Platform( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -16886,7 +17048,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -16908,7 +17070,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17102,7 +17264,7 @@ public static class BankTerms { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -17129,7 +17291,10 @@ public static class BankTerms { Object userAgent; private BankTerms( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17141,7 +17306,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17163,7 +17328,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17245,7 +17410,7 @@ public static class FinancingDisclosures { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -17272,7 +17437,10 @@ public static class FinancingDisclosures { Object userAgent; private FinancingDisclosures( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17284,7 +17452,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17306,7 +17474,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17390,7 +17558,7 @@ public static class GlobalAccountHolder { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -17417,7 +17585,10 @@ public static class GlobalAccountHolder { Object userAgent; private GlobalAccountHolder( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17429,7 +17600,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17451,7 +17622,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, for * example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17641,7 +17812,7 @@ public static class ApplePay { * example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. @@ -17668,7 +17839,10 @@ public static class ApplePay { Object userAgent; private ApplePay( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17680,7 +17854,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17702,7 +17876,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -17893,7 +18067,7 @@ public static class BankTerms { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -17920,7 +18094,10 @@ public static class BankTerms { Object userAgent; private BankTerms( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -17932,7 +18109,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -17954,7 +18131,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -18036,7 +18213,7 @@ public static class Platform { * for example: 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client @@ -18063,7 +18240,10 @@ public static class Platform { Object userAgent; private Platform( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -18075,7 +18255,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -18097,7 +18277,7 @@ public static class Builder { * Represented as a RFC 3339 date & time UTC value in millisecond precision, * for example: 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -18183,7 +18363,7 @@ public static class CryptoStorer { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -18209,7 +18389,10 @@ public static class CryptoStorer { Object userAgent; private CryptoStorer( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -18221,7 +18404,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -18240,7 +18423,7 @@ public AccountUpdateParams.Identity.Attestations.TermsOfService.CryptoStorer bui * as a RFC 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -18320,7 +18503,7 @@ public static class Storer { * 2022-09-18T13:22:18.123Z. */ @SerializedName("date") - Instant date; + java.time.Instant date; /** * Map of extra parameters for custom features not available in this client library. The @@ -18346,7 +18529,10 @@ public static class Storer { Object userAgent; private Storer( - Instant date, Map extraParams, Object ip, Object userAgent) { + java.time.Instant date, + Map extraParams, + Object ip, + Object userAgent) { this.date = date; this.extraParams = extraParams; this.ip = ip; @@ -18358,7 +18544,7 @@ public static Builder builder() { } public static class Builder { - private Instant date; + private java.time.Instant date; private Map extraParams; @@ -18377,7 +18563,7 @@ public AccountUpdateParams.Identity.Attestations.TermsOfService.Storer build() { * as a RFC 3339 date & time UTC value in millisecond precision, for example: * 2022-09-18T13:22:18.123Z. */ - public Builder setDate(Instant date) { + public Builder setDate(java.time.Instant date) { this.date = date; return this; } @@ -18473,8 +18659,8 @@ public static class BusinessDetails { Documents documents; /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for the - * business. + * Estimated maximum number of workers currently engaged by the business (including employees, + * contractors, and vendors). */ @SerializedName("estimated_worker_count") Long estimatedWorkerCount; @@ -18634,8 +18820,8 @@ public Builder setDocuments( } /** - * An estimated upper bound of employees, contractors, vendors, etc. currently working for - * the business. + * Estimated maximum number of workers currently engaged by the business (including + * employees, contractors, and vendors). */ public Builder setEstimatedWorkerCount(Long estimatedWorkerCount) { this.estimatedWorkerCount = estimatedWorkerCount; @@ -18791,7 +18977,7 @@ public static class Address { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -18954,13 +19140,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -21053,6 +21239,12 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("at_fn") AT_FN("at_fn"), + @SerializedName("at_stn") + AT_STN("at_stn"), + + @SerializedName("at_vat") + AT_VAT("at_vat"), + @SerializedName("au_abn") AU_ABN("au_abn"), @@ -21071,9 +21263,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("be_cbe") BE_CBE("be_cbe"), + @SerializedName("be_vat") + BE_VAT("be_vat"), + @SerializedName("bg_uic") BG_UIC("bg_uic"), + @SerializedName("bg_vat") + BG_VAT("bg_vat"), + @SerializedName("br_cnpj") BR_CNPJ("br_cnpj"), @@ -21083,6 +21281,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ca_crarr") CA_CRARR("ca_crarr"), + @SerializedName("ca_gst_hst") + CA_GST_HST("ca_gst_hst"), + @SerializedName("ca_neq") CA_NEQ("ca_neq"), @@ -21101,33 +21302,60 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_he") + CY_HE("cy_he"), + @SerializedName("cy_tic") CY_TIC("cy_tic"), + @SerializedName("cy_vat") + CY_VAT("cy_vat"), + @SerializedName("cz_ico") CZ_ICO("cz_ico"), + @SerializedName("cz_vat") + CZ_VAT("cz_vat"), + @SerializedName("de_hrn") DE_HRN("de_hrn"), + @SerializedName("de_stn") + DE_STN("de_stn"), + @SerializedName("de_vat") DE_VAT("de_vat"), @SerializedName("dk_cvr") DK_CVR("dk_cvr"), + @SerializedName("dk_vat") + DK_VAT("dk_vat"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), @SerializedName("ee_rk") EE_RK("ee_rk"), + @SerializedName("ee_vat") + EE_VAT("ee_vat"), + @SerializedName("es_cif") ES_CIF("es_cif"), + @SerializedName("es_vat") + ES_VAT("es_vat"), + + @SerializedName("fi_vat") + FI_VAT("fi_vat"), + @SerializedName("fi_yt") FI_YT("fi_yt"), + @SerializedName("fr_rna") + FR_RNA("fr_rna"), + @SerializedName("fr_siren") FR_SIREN("fr_siren"), @@ -21140,9 +21368,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("gi_crn") GI_CRN("gi_crn"), + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gr_gemi") GR_GEMI("gr_gemi"), + @SerializedName("gr_vat") + GR_VAT("gr_vat"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @@ -21152,15 +21386,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("hk_cr") HK_CR("hk_cr"), - @SerializedName("hk_mbs") - HK_MBS("hk_mbs"), + @SerializedName("hr_mbs") + HR_MBS("hr_mbs"), + + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hr_vat") + HR_VAT("hr_vat"), @SerializedName("hu_cjs") HU_CJS("hu_cjs"), + @SerializedName("hu_tin") + HU_TIN("hu_tin"), + + @SerializedName("hu_vat") + HU_VAT("hu_vat"), + @SerializedName("ie_crn") IE_CRN("ie_crn"), + @SerializedName("ie_trn") + IE_TRN("ie_trn"), + + @SerializedName("ie_vat") + IE_VAT("ie_vat"), + @SerializedName("it_rea") IT_REA("it_rea"), @@ -21179,15 +21431,33 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("lt_ccrn") LT_CCRN("lt_ccrn"), + @SerializedName("lt_vat") + LT_VAT("lt_vat"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + @SerializedName("lu_rcs") LU_RCS("lu_rcs"), + @SerializedName("lu_vat") + LU_VAT("lu_vat"), + @SerializedName("lv_urn") LV_URN("lv_urn"), + @SerializedName("lv_vat") + LV_VAT("lv_vat"), + @SerializedName("mt_crn") MT_CRN("mt_crn"), + @SerializedName("mt_tin") + MT_TIN("mt_tin"), + + @SerializedName("mt_vat") + MT_VAT("mt_vat"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -21197,6 +21467,9 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("my_coid") MY_COID("my_coid"), + @SerializedName("my_itn") + MY_ITN("my_itn"), + @SerializedName("my_sst") MY_SST("my_sst"), @@ -21206,27 +21479,48 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("nl_kvk") NL_KVK("nl_kvk"), + @SerializedName("nl_rsin") + NL_RSIN("nl_rsin"), + + @SerializedName("nl_vat") + NL_VAT("nl_vat"), + @SerializedName("no_orgnr") NO_ORGNR("no_orgnr"), @SerializedName("nz_bn") NZ_BN("nz_bn"), + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_ruc") PE_RUC("pe_ruc"), @SerializedName("pk_ntn") PK_NTN("pk_ntn"), + @SerializedName("pl_nip") + PL_NIP("pl_nip"), + @SerializedName("pl_regon") PL_REGON("pl_regon"), + @SerializedName("pl_vat") + PL_VAT("pl_vat"), + @SerializedName("pt_vat") PT_VAT("pt_vat"), @SerializedName("ro_cui") RO_CUI("ro_cui"), + @SerializedName("ro_orc") + RO_ORC("ro_orc"), + + @SerializedName("ro_vat") + RO_VAT("ro_vat"), + @SerializedName("sa_crn") SA_CRN("sa_crn"), @@ -21236,15 +21530,30 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("se_orgnr") SE_ORGNR("se_orgnr"), + @SerializedName("se_vat") + SE_VAT("se_vat"), + @SerializedName("sg_uen") SG_UEN("sg_uen"), @SerializedName("si_msp") SI_MSP("si_msp"), + @SerializedName("si_tin") + SI_TIN("si_tin"), + + @SerializedName("si_vat") + SI_VAT("si_vat"), + + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("sk_ico") SK_ICO("sk_ico"), + @SerializedName("sk_vat") + SK_VAT("sk_vat"), + @SerializedName("th_crn") TH_CRN("th_crn"), @@ -21584,7 +21893,7 @@ public static class Kana { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -21749,13 +22058,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -21803,7 +22112,7 @@ public static class Kanji { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -21968,13 +22277,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -22853,7 +23162,7 @@ public static class AdditionalAddress { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -23028,13 +23337,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -23245,7 +23554,7 @@ public static class Address { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -23408,13 +23717,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -24699,9 +25008,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -24714,9 +25029,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -24726,21 +25068,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -24750,9 +25161,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -24762,21 +25182,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -24787,7 +25225,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -25087,7 +25531,7 @@ public static class Kana { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -25252,13 +25696,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -25306,7 +25750,7 @@ public static class Kanji { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -25471,13 +25915,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/core/ClaimableSandboxCreateParams.java b/src/main/java/com/stripe/param/v2/core/ClaimableSandboxCreateParams.java index 7eeb4559b3a..236b15c7297 100644 --- a/src/main/java/com/stripe/param/v2/core/ClaimableSandboxCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/ClaimableSandboxCreateParams.java @@ -129,7 +129,7 @@ public static class Prefill { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - /** Name for the sandbox. If not provided, this will be generated. */ + /** Name for the sandbox. */ @SerializedName("name") String name; @@ -204,7 +204,7 @@ public Builder putAllExtraParam(Map map) { return this; } - /** Name for the sandbox. If not provided, this will be generated. */ + /** Name for the sandbox. */ public Builder setName(String name) { this.name = name; return this; diff --git a/src/main/java/com/stripe/param/v2/core/accounts/PersonCreateParams.java b/src/main/java/com/stripe/param/v2/core/accounts/PersonCreateParams.java index 3e428bab328..cb190454762 100644 --- a/src/main/java/com/stripe/param/v2/core/accounts/PersonCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/accounts/PersonCreateParams.java @@ -506,7 +506,7 @@ public static class AdditionalAddress { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -639,7 +639,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -1015,7 +1015,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -1137,7 +1137,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -2307,9 +2307,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -2322,9 +2328,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -2334,21 +2367,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -2358,9 +2460,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -2370,21 +2481,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -2395,7 +2524,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -2409,7 +2544,7 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class Relationship { - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ @SerializedName("authorizer") Boolean authorizer; @@ -2508,7 +2643,7 @@ public PersonCreateParams.Relationship build() { this.title); } - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ public Builder setAuthorizer(Boolean authorizer) { this.authorizer = authorizer; return this; @@ -2704,7 +2839,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -2828,7 +2963,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -2875,7 +3010,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -2999,7 +3134,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/core/accounts/PersonTokenCreateParams.java b/src/main/java/com/stripe/param/v2/core/accounts/PersonTokenCreateParams.java index 52981796e9c..5d4fae4ceb8 100644 --- a/src/main/java/com/stripe/param/v2/core/accounts/PersonTokenCreateParams.java +++ b/src/main/java/com/stripe/param/v2/core/accounts/PersonTokenCreateParams.java @@ -511,7 +511,7 @@ public static class AdditionalAddress { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -645,7 +645,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -981,7 +981,7 @@ public static class Address { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -1103,7 +1103,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -2277,9 +2277,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -2292,9 +2298,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -2304,21 +2337,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -2328,9 +2430,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -2340,21 +2451,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -2365,7 +2494,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -2379,7 +2514,7 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class Relationship { - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ @SerializedName("authorizer") Boolean authorizer; @@ -2478,7 +2613,7 @@ public PersonTokenCreateParams.Relationship build() { this.title); } - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ public Builder setAuthorizer(Boolean authorizer) { this.authorizer = authorizer; return this; @@ -2675,7 +2810,7 @@ public static class Kana { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -2799,7 +2934,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; @@ -2846,7 +2981,7 @@ public static class Kanji { @SerializedName("state") String state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") String town; @@ -2970,7 +3105,7 @@ public Builder setState(String state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/core/accounts/PersonUpdateParams.java b/src/main/java/com/stripe/param/v2/core/accounts/PersonUpdateParams.java index 93306020e7b..c886d483511 100644 --- a/src/main/java/com/stripe/param/v2/core/accounts/PersonUpdateParams.java +++ b/src/main/java/com/stripe/param/v2/core/accounts/PersonUpdateParams.java @@ -555,7 +555,7 @@ public static class AdditionalAddress { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -727,13 +727,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -1136,7 +1136,7 @@ public static class Address { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -1297,13 +1297,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -2525,9 +2525,15 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("ao_nif") AO_NIF("ao_nif"), + @SerializedName("ar_cuil") + AR_CUIL("ar_cuil"), + @SerializedName("ar_dni") AR_DNI("ar_dni"), + @SerializedName("at_stn") + AT_STN("at_stn"), + @SerializedName("az_tin") AZ_TIN("az_tin"), @@ -2540,9 +2546,36 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("bd_nid") BD_NID("bd_nid"), + @SerializedName("be_nrn") + BE_NRN("be_nrn"), + + @SerializedName("bg_ucn") + BG_UCN("bg_ucn"), + + @SerializedName("bn_nric") + BN_NRIC("bn_nric"), + @SerializedName("br_cpf") BR_CPF("br_cpf"), + @SerializedName("ca_sin") + CA_SIN("ca_sin"), + + @SerializedName("ch_oasi") + CH_OASI("ch_oasi"), + + @SerializedName("cl_rut") + CL_RUT("cl_rut"), + + @SerializedName("cn_pp") + CN_PP("cn_pp"), + + @SerializedName("co_nuip") + CO_NUIP("co_nuip"), + + @SerializedName("cr_ci") + CR_CI("cr_ci"), + @SerializedName("cr_cpf") CR_CPF("cr_cpf"), @@ -2552,21 +2585,90 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("cr_nite") CR_NITE("cr_nite"), + @SerializedName("cy_tic") + CY_TIC("cy_tic"), + + @SerializedName("cz_rc") + CZ_RC("cz_rc"), + @SerializedName("de_stn") DE_STN("de_stn"), + @SerializedName("dk_cpr") + DK_CPR("dk_cpr"), + + @SerializedName("do_cie") + DO_CIE("do_cie"), + @SerializedName("do_rcn") DO_RCN("do_rcn"), + @SerializedName("ec_ci") + EC_CI("ec_ci"), + + @SerializedName("ee_ik") + EE_IK("ee_ik"), + + @SerializedName("es_nif") + ES_NIF("es_nif"), + + @SerializedName("fi_hetu") + FI_HETU("fi_hetu"), + + @SerializedName("fr_nir") + FR_NIR("fr_nir"), + + @SerializedName("gb_nino") + GB_NINO("gb_nino"), + + @SerializedName("gr_afm") + GR_AFM("gr_afm"), + @SerializedName("gt_nit") GT_NIT("gt_nit"), @SerializedName("hk_id") HK_ID("hk_id"), + @SerializedName("hr_oib") + HR_OIB("hr_oib"), + + @SerializedName("hu_ad") + HU_AD("hu_ad"), + + @SerializedName("id_nik") + ID_NIK("id_nik"), + + @SerializedName("ie_ppsn") + IE_PPSN("ie_ppsn"), + + @SerializedName("is_kt") + IS_KT("is_kt"), + + @SerializedName("it_cf") + IT_CF("it_cf"), + + @SerializedName("jp_inc") + JP_INC("jp_inc"), + + @SerializedName("ke_pin") + KE_PIN("ke_pin"), + @SerializedName("kz_iin") KZ_IIN("kz_iin"), + @SerializedName("li_peid") + LI_PEID("li_peid"), + + @SerializedName("lt_ak") + LT_AK("lt_ak"), + + @SerializedName("lu_nif") + LU_NIF("lu_nif"), + + @SerializedName("lv_pk") + LV_PK("lv_pk"), + @SerializedName("mx_rfc") MX_RFC("mx_rfc"), @@ -2576,9 +2678,18 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("mz_nuit") MZ_NUIT("mz_nuit"), + @SerializedName("ng_nin") + NG_NIN("ng_nin"), + @SerializedName("nl_bsn") NL_BSN("nl_bsn"), + @SerializedName("no_nin") + NO_NIN("no_nin"), + + @SerializedName("nz_ird") + NZ_IRD("nz_ird"), + @SerializedName("pe_dni") PE_DNI("pe_dni"), @@ -2588,21 +2699,39 @@ public enum Type implements ApiRequestParams.EnumParam { @SerializedName("pk_snic") PK_SNIC("pk_snic"), + @SerializedName("pl_pesel") + PL_PESEL("pl_pesel"), + + @SerializedName("pt_nif") + PT_NIF("pt_nif"), + + @SerializedName("ro_cnp") + RO_CNP("ro_cnp"), + @SerializedName("sa_tin") SA_TIN("sa_tin"), + @SerializedName("se_pin") + SE_PIN("se_pin"), + @SerializedName("sg_fin") SG_FIN("sg_fin"), @SerializedName("sg_nric") SG_NRIC("sg_nric"), + @SerializedName("sk_dic") + SK_DIC("sk_dic"), + @SerializedName("th_lc") TH_LC("th_lc"), @SerializedName("th_pin") TH_PIN("th_pin"), + @SerializedName("tr_tin") + TR_TIN("tr_tin"), + @SerializedName("us_itin") US_ITIN("us_itin"), @@ -2613,7 +2742,13 @@ public enum Type implements ApiRequestParams.EnumParam { US_SSN("us_ssn"), @SerializedName("us_ssn_last_4") - US_SSN_LAST_4("us_ssn_last_4"); + US_SSN_LAST_4("us_ssn_last_4"), + + @SerializedName("uy_dni") + UY_DNI("uy_dni"), + + @SerializedName("za_id") + ZA_ID("za_id"); @Getter(onMethod_ = {@Override}) private final String value; @@ -2627,7 +2762,7 @@ public enum Type implements ApiRequestParams.EnumParam { @Getter @EqualsAndHashCode(callSuper = false) public static class Relationship { - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ @SerializedName("authorizer") Boolean authorizer; @@ -2726,7 +2861,7 @@ public PersonUpdateParams.Relationship build() { this.title); } - /** Whether the individual is an authorizer of the Account’s legal entity. */ + /** Whether the individual is an authorizer of the Account's identity. */ public Builder setAuthorizer(Boolean authorizer) { this.authorizer = authorizer; return this; @@ -2934,7 +3069,7 @@ public static class Kana { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -3097,13 +3232,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; @@ -3150,7 +3285,7 @@ public static class Kanji { @SerializedName("state") Object state; - /** Town or cho-me. */ + /** Town or district. */ @SerializedName("town") Object town; @@ -3313,13 +3448,13 @@ public Builder setState(EmptyParam state) { return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(String town) { this.town = town; return this; } - /** Town or cho-me. */ + /** Town or district. */ public Builder setTown(EmptyParam town) { this.town = town; return this; diff --git a/src/main/java/com/stripe/param/v2/iam/ApiKeyCreateParams.java b/src/main/java/com/stripe/param/v2/iam/ApiKeyCreateParams.java new file mode 100644 index 00000000000..82f0c3422df --- /dev/null +++ b/src/main/java/com/stripe/param/v2/iam/ApiKeyCreateParams.java @@ -0,0 +1,321 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.iam; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ApiKeyCreateParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Name for the API key. */ + @SerializedName("name") + String name; + + /** Note or description for the API key. */ + @SerializedName("note") + String note; + + /** + * Public key for encrypting the API key secret. This must a PEM-formatted RSA key suitable for + * encryption, >= 2048 bits. A public key is required when creating secret keys. Publishable + * keys are not encrypted and a public key should not be included. + */ + @SerializedName("public_key") + PublicKey publicKey; + + /** Required. Type of the API key to create (secret or publishable). */ + @SerializedName("type") + Type type; + + private ApiKeyCreateParams( + Map extraParams, String name, String note, PublicKey publicKey, Type type) { + this.extraParams = extraParams; + this.name = name; + this.note = note; + this.publicKey = publicKey; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String name; + + private String note; + + private PublicKey publicKey; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyCreateParams build() { + return new ApiKeyCreateParams( + this.extraParams, this.name, this.note, this.publicKey, this.type); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyCreateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyCreateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Name for the API key. */ + public Builder setName(String name) { + this.name = name; + return this; + } + + /** Note or description for the API key. */ + public Builder setNote(String note) { + this.note = note; + return this; + } + + /** + * Public key for encrypting the API key secret. This must a PEM-formatted RSA key suitable for + * encryption, >= 2048 bits. A public key is required when creating secret keys. Publishable + * keys are not encrypted and a public key should not be included. + */ + public Builder setPublicKey(ApiKeyCreateParams.PublicKey publicKey) { + this.publicKey = publicKey; + return this; + } + + /** Required. Type of the API key to create (secret or publishable). */ + public Builder setType(ApiKeyCreateParams.Type type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PublicKey { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Caller's identifier of the public key. This is used for tracking purposes only, and will be + * echoed in the response if provided. + */ + @SerializedName("id") + String id; + + /** PEM-formatted public key. */ + @SerializedName("pem_key") + PemKey pemKey; + + private PublicKey(Map extraParams, String id, PemKey pemKey) { + this.extraParams = extraParams; + this.id = id; + this.pemKey = pemKey; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String id; + + private PemKey pemKey; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyCreateParams.PublicKey build() { + return new ApiKeyCreateParams.PublicKey(this.extraParams, this.id, this.pemKey); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyCreateParams.PublicKey#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyCreateParams.PublicKey#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Caller's identifier of the public key. This is used for tracking purposes only, and will be + * echoed in the response if provided. + */ + public Builder setId(String id) { + this.id = id; + return this; + } + + /** PEM-formatted public key. */ + public Builder setPemKey(ApiKeyCreateParams.PublicKey.PemKey pemKey) { + this.pemKey = pemKey; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PemKey { + /** Required. The encryption algorithm used with this key (e.g., RSA). */ + @SerializedName("algorithm") + String algorithm; + + /** + * Required. The PEM-encoded public key data. Newlines are required between + * header/footer and body, and optional within the body. + */ + @SerializedName("data") + String data; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private PemKey(String algorithm, String data, Map extraParams) { + this.algorithm = algorithm; + this.data = data; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String algorithm; + + private String data; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyCreateParams.PublicKey.PemKey build() { + return new ApiKeyCreateParams.PublicKey.PemKey( + this.algorithm, this.data, this.extraParams); + } + + /** Required. The encryption algorithm used with this key (e.g., RSA). */ + public Builder setAlgorithm(String algorithm) { + this.algorithm = algorithm; + return this; + } + + /** + * Required. The PEM-encoded public key data. Newlines are required between + * header/footer and body, and optional within the body. + */ + public Builder setData(String data) { + this.data = data; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ApiKeyCreateParams.PublicKey.PemKey#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ApiKeyCreateParams.PublicKey.PemKey#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("publishable_key") + PUBLISHABLE_KEY("publishable_key"), + + @SerializedName("secret_key") + SECRET_KEY("secret_key"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } +} diff --git a/src/main/java/com/stripe/param/v2/iam/ApiKeyListParams.java b/src/main/java/com/stripe/param/v2/iam/ApiKeyListParams.java new file mode 100644 index 00000000000..e89cdcdb742 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/iam/ApiKeyListParams.java @@ -0,0 +1,91 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.iam; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ApiKeyListParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Whether to include expired API keys in the response. */ + @SerializedName("include_expired") + Boolean includeExpired; + + /** Limit of items to return per page. */ + @SerializedName("limit") + Long limit; + + private ApiKeyListParams(Map extraParams, Boolean includeExpired, Long limit) { + this.extraParams = extraParams; + this.includeExpired = includeExpired; + this.limit = limit; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Boolean includeExpired; + + private Long limit; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyListParams build() { + return new ApiKeyListParams(this.extraParams, this.includeExpired, this.limit); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyListParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyListParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Whether to include expired API keys in the response. */ + public Builder setIncludeExpired(Boolean includeExpired) { + this.includeExpired = includeExpired; + return this; + } + + /** Limit of items to return per page. */ + public Builder setLimit(Long limit) { + this.limit = limit; + return this; + } + } +} diff --git a/src/main/java/com/stripe/param/v2/iam/ApiKeyRotateParams.java b/src/main/java/com/stripe/param/v2/iam/ApiKeyRotateParams.java new file mode 100644 index 00000000000..d5f0085a653 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/iam/ApiKeyRotateParams.java @@ -0,0 +1,286 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.iam; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ApiKeyRotateParams extends ApiRequestParams { + /** + * Duration in minutes before the current key expires, with a maximum of 7 days (10080 minutes). + * If not provided, the current key expires immediately. + */ + @SerializedName("expire_current_key_in_minutes") + Long expireCurrentKeyInMinutes; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Public key for encrypting the new API key secret. This must a PEM-formatted RSA key suitable + * for encryption, >= 2048 bits. A public key is required when rotating secret keys. + * Publishable keys are not encrypted and a public key should not be included. + */ + @SerializedName("public_key") + PublicKey publicKey; + + private ApiKeyRotateParams( + Long expireCurrentKeyInMinutes, Map extraParams, PublicKey publicKey) { + this.expireCurrentKeyInMinutes = expireCurrentKeyInMinutes; + this.extraParams = extraParams; + this.publicKey = publicKey; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Long expireCurrentKeyInMinutes; + + private Map extraParams; + + private PublicKey publicKey; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyRotateParams build() { + return new ApiKeyRotateParams( + this.expireCurrentKeyInMinutes, this.extraParams, this.publicKey); + } + + /** + * Duration in minutes before the current key expires, with a maximum of 7 days (10080 minutes). + * If not provided, the current key expires immediately. + */ + public Builder setExpireCurrentKeyInMinutes(Long expireCurrentKeyInMinutes) { + this.expireCurrentKeyInMinutes = expireCurrentKeyInMinutes; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyRotateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyRotateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Public key for encrypting the new API key secret. This must a PEM-formatted RSA key suitable + * for encryption, >= 2048 bits. A public key is required when rotating secret keys. + * Publishable keys are not encrypted and a public key should not be included. + */ + public Builder setPublicKey(ApiKeyRotateParams.PublicKey publicKey) { + this.publicKey = publicKey; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PublicKey { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Caller's identifier of the public key. This is used for tracking purposes only, and will be + * echoed in the response if provided. + */ + @SerializedName("id") + String id; + + /** PEM-formatted public key. */ + @SerializedName("pem_key") + PemKey pemKey; + + private PublicKey(Map extraParams, String id, PemKey pemKey) { + this.extraParams = extraParams; + this.id = id; + this.pemKey = pemKey; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String id; + + private PemKey pemKey; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyRotateParams.PublicKey build() { + return new ApiKeyRotateParams.PublicKey(this.extraParams, this.id, this.pemKey); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyRotateParams.PublicKey#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyRotateParams.PublicKey#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Caller's identifier of the public key. This is used for tracking purposes only, and will be + * echoed in the response if provided. + */ + public Builder setId(String id) { + this.id = id; + return this; + } + + /** PEM-formatted public key. */ + public Builder setPemKey(ApiKeyRotateParams.PublicKey.PemKey pemKey) { + this.pemKey = pemKey; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class PemKey { + /** Required. The encryption algorithm used with this key (e.g., RSA). */ + @SerializedName("algorithm") + String algorithm; + + /** + * Required. The PEM-encoded public key data. Newlines are required between + * header/footer and body, and optional within the body. + */ + @SerializedName("data") + String data; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + private PemKey(String algorithm, String data, Map extraParams) { + this.algorithm = algorithm; + this.data = data; + this.extraParams = extraParams; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String algorithm; + + private String data; + + private Map extraParams; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyRotateParams.PublicKey.PemKey build() { + return new ApiKeyRotateParams.PublicKey.PemKey( + this.algorithm, this.data, this.extraParams); + } + + /** Required. The encryption algorithm used with this key (e.g., RSA). */ + public Builder setAlgorithm(String algorithm) { + this.algorithm = algorithm; + return this; + } + + /** + * Required. The PEM-encoded public key data. Newlines are required between + * header/footer and body, and optional within the body. + */ + public Builder setData(String data) { + this.data = data; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ApiKeyRotateParams.PublicKey.PemKey#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ApiKeyRotateParams.PublicKey.PemKey#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + } + } + } +} diff --git a/src/main/java/com/stripe/param/v2/iam/ApiKeyUpdateParams.java b/src/main/java/com/stripe/param/v2/iam/ApiKeyUpdateParams.java new file mode 100644 index 00000000000..49e1ad18c9e --- /dev/null +++ b/src/main/java/com/stripe/param/v2/iam/ApiKeyUpdateParams.java @@ -0,0 +1,104 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.iam; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import com.stripe.param.common.EmptyParam; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ApiKeyUpdateParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Name to set for the API key. If blank, the field is left unchanged. */ + @SerializedName("name") + Object name; + + /** Note or description to set for the API key. If blank, the field is left unchanged. */ + @SerializedName("note") + Object note; + + private ApiKeyUpdateParams(Map extraParams, Object name, Object note) { + this.extraParams = extraParams; + this.name = name; + this.note = note; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object name; + + private Object note; + + /** Finalize and obtain parameter instance from this builder. */ + public ApiKeyUpdateParams build() { + return new ApiKeyUpdateParams(this.extraParams, this.name, this.note); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ApiKeyUpdateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ApiKeyUpdateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Name to set for the API key. If blank, the field is left unchanged. */ + public Builder setName(String name) { + this.name = name; + return this; + } + + /** Name to set for the API key. If blank, the field is left unchanged. */ + public Builder setName(EmptyParam name) { + this.name = name; + return this; + } + + /** Note or description to set for the API key. If blank, the field is left unchanged. */ + public Builder setNote(String note) { + this.note = note; + return this; + } + + /** Note or description to set for the API key. If blank, the field is left unchanged. */ + public Builder setNote(EmptyParam note) { + this.note = note; + return this; + } + } +} diff --git a/src/main/java/com/stripe/param/v2/moneymanagement/FinancialAccountListParams.java b/src/main/java/com/stripe/param/v2/moneymanagement/FinancialAccountListParams.java index 62b3602e534..4a988fcb6d9 100644 --- a/src/main/java/com/stripe/param/v2/moneymanagement/FinancialAccountListParams.java +++ b/src/main/java/com/stripe/param/v2/moneymanagement/FinancialAccountListParams.java @@ -3,7 +3,9 @@ import com.google.gson.annotations.SerializedName; import com.stripe.net.ApiRequestParams; +import java.util.ArrayList; import java.util.HashMap; +import java.util.List; import java.util.Map; import lombok.EqualsAndHashCode; import lombok.Getter; @@ -31,10 +33,22 @@ public class FinancialAccountListParams extends ApiRequestParams { @SerializedName("status") Status status; - private FinancialAccountListParams(Map extraParams, Long limit, Status status) { + /** + * Filter for FinancialAccount {@code type}. By default, FinancialAccounts of any {@code type} are + * returned. + */ + @SerializedName("types") + List types; + + private FinancialAccountListParams( + Map extraParams, + Long limit, + Status status, + List types) { this.extraParams = extraParams; this.limit = limit; this.status = status; + this.types = types; } public static Builder builder() { @@ -48,9 +62,11 @@ public static class Builder { private Status status; + private List types; + /** Finalize and obtain parameter instance from this builder. */ public FinancialAccountListParams build() { - return new FinancialAccountListParams(this.extraParams, this.limit, this.status); + return new FinancialAccountListParams(this.extraParams, this.limit, this.status, this.types); } /** @@ -93,6 +109,32 @@ public Builder setStatus(FinancialAccountListParams.Status status) { this.status = status; return this; } + + /** + * Add an element to `types` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * FinancialAccountListParams#types} for the field documentation. + */ + public Builder addType(FinancialAccountListParams.Type element) { + if (this.types == null) { + this.types = new ArrayList<>(); + } + this.types.add(element); + return this; + } + + /** + * Add all elements to `types` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * FinancialAccountListParams#types} for the field documentation. + */ + public Builder addAllType(List elements) { + if (this.types == null) { + this.types = new ArrayList<>(); + } + this.types.addAll(elements); + return this; + } } public enum Status implements ApiRequestParams.EnumParam { @@ -112,4 +154,19 @@ public enum Status implements ApiRequestParams.EnumParam { this.value = value; } } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("payments") + PAYMENTS("payments"), + + @SerializedName("storage") + STORAGE("storage"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } } diff --git a/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentCreateParams.java b/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentCreateParams.java index b4d54abc095..667b561eb13 100644 --- a/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentCreateParams.java +++ b/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentCreateParams.java @@ -354,9 +354,14 @@ public static class DeliveryOptions { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - private DeliveryOptions(BankAccount bankAccount, Map extraParams) { + /** Open Enum. Speed of the payout. */ + @SerializedName("speed") + Speed speed; + + private DeliveryOptions(BankAccount bankAccount, Map extraParams, Speed speed) { this.bankAccount = bankAccount; this.extraParams = extraParams; + this.speed = speed; } public static Builder builder() { @@ -368,9 +373,12 @@ public static class Builder { private Map extraParams; + private Speed speed; + /** Finalize and obtain parameter instance from this builder. */ public OutboundPaymentCreateParams.DeliveryOptions build() { - return new OutboundPaymentCreateParams.DeliveryOptions(this.bankAccount, this.extraParams); + return new OutboundPaymentCreateParams.DeliveryOptions( + this.bankAccount, this.extraParams, this.speed); } /** Open Enum. Method for bank account. */ @@ -406,6 +414,12 @@ public Builder putAllExtraParam(Map map) { this.extraParams.putAll(map); return this; } + + /** Open Enum. Speed of the payout. */ + public Builder setSpeed(OutboundPaymentCreateParams.DeliveryOptions.Speed speed) { + this.speed = speed; + return this; + } } public enum BankAccount implements ApiRequestParams.EnumParam { @@ -425,6 +439,24 @@ public enum BankAccount implements ApiRequestParams.EnumParam { this.value = value; } } + + public enum Speed implements ApiRequestParams.EnumParam { + @SerializedName("instant") + INSTANT("instant"), + + @SerializedName("next_business_day") + NEXT_BUSINESS_DAY("next_business_day"), + + @SerializedName("standard") + STANDARD("standard"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Speed(String value) { + this.value = value; + } + } } @Getter diff --git a/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentQuoteCreateParams.java b/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentQuoteCreateParams.java index 5d98d20a1c7..4df9e63e02c 100644 --- a/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentQuoteCreateParams.java +++ b/src/main/java/com/stripe/param/v2/moneymanagement/OutboundPaymentQuoteCreateParams.java @@ -240,9 +240,14 @@ public static class DeliveryOptions { @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) Map extraParams; - private DeliveryOptions(BankAccount bankAccount, Map extraParams) { + /** Open Enum. Speed of the payout. */ + @SerializedName("speed") + Speed speed; + + private DeliveryOptions(BankAccount bankAccount, Map extraParams, Speed speed) { this.bankAccount = bankAccount; this.extraParams = extraParams; + this.speed = speed; } public static Builder builder() { @@ -254,10 +259,12 @@ public static class Builder { private Map extraParams; + private Speed speed; + /** Finalize and obtain parameter instance from this builder. */ public OutboundPaymentQuoteCreateParams.DeliveryOptions build() { return new OutboundPaymentQuoteCreateParams.DeliveryOptions( - this.bankAccount, this.extraParams); + this.bankAccount, this.extraParams, this.speed); } /** Open Enum. Method for bank account. */ @@ -293,6 +300,12 @@ public Builder putAllExtraParam(Map map) { this.extraParams.putAll(map); return this; } + + /** Open Enum. Speed of the payout. */ + public Builder setSpeed(OutboundPaymentQuoteCreateParams.DeliveryOptions.Speed speed) { + this.speed = speed; + return this; + } } public enum BankAccount implements ApiRequestParams.EnumParam { @@ -312,6 +325,24 @@ public enum BankAccount implements ApiRequestParams.EnumParam { this.value = value; } } + + public enum Speed implements ApiRequestParams.EnumParam { + @SerializedName("instant") + INSTANT("instant"), + + @SerializedName("next_business_day") + NEXT_BUSINESS_DAY("next_business_day"), + + @SerializedName("standard") + STANDARD("standard"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Speed(String value) { + this.value = value; + } + } } @Getter diff --git a/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentCreateParams.java b/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentCreateParams.java new file mode 100644 index 00000000000..db33535b888 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentCreateParams.java @@ -0,0 +1,285 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.payments; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.time.Instant; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class SettlementAllocationIntentCreateParams extends ApiRequestParams { + /** + * Required. The amount and currency of the SettlementAllocationIntent. Allowed + * Currencies are {@code gbp} | {@code eur}. + */ + @SerializedName("amount") + Amount amount; + + /** Required. Date when we expect to receive the funds. Must be in future . */ + @SerializedName("expected_settlement_date") + Instant expectedSettlementDate; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * Required. Financial Account Id where the funds are expected for this + * SettlementAllocationIntent. + */ + @SerializedName("financial_account") + String financialAccount; + + /** Metadata associated with the SettlementAllocationIntent. */ + @SerializedName("metadata") + Map metadata; + + /** + * Required. Reference for the SettlementAllocationIntent. This should be same as + * the transaction reference used by payments processor to send funds to Stripe. Must have length + * between 5 and 255 characters and it must be unique among existing SettlementAllocationIntents + * that have a non-terminal status ({@code pending}, {@code submitted}, {@code matched}, {@code + * errored}). + */ + @SerializedName("reference") + String reference; + + private SettlementAllocationIntentCreateParams( + Amount amount, + Instant expectedSettlementDate, + Map extraParams, + String financialAccount, + Map metadata, + String reference) { + this.amount = amount; + this.expectedSettlementDate = expectedSettlementDate; + this.extraParams = extraParams; + this.financialAccount = financialAccount; + this.metadata = metadata; + this.reference = reference; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Amount amount; + + private Instant expectedSettlementDate; + + private Map extraParams; + + private String financialAccount; + + private Map metadata; + + private String reference; + + /** Finalize and obtain parameter instance from this builder. */ + public SettlementAllocationIntentCreateParams build() { + return new SettlementAllocationIntentCreateParams( + this.amount, + this.expectedSettlementDate, + this.extraParams, + this.financialAccount, + this.metadata, + this.reference); + } + + /** + * Required. The amount and currency of the SettlementAllocationIntent. Allowed + * Currencies are {@code gbp} | {@code eur}. + */ + public Builder setAmount(SettlementAllocationIntentCreateParams.Amount amount) { + this.amount = amount; + return this; + } + + /** Required. Date when we expect to receive the funds. Must be in future . */ + public Builder setExpectedSettlementDate(Instant expectedSettlementDate) { + this.expectedSettlementDate = expectedSettlementDate; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SettlementAllocationIntentCreateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SettlementAllocationIntentCreateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Required. Financial Account Id where the funds are expected for this + * SettlementAllocationIntent. + */ + public Builder setFinancialAccount(String financialAccount) { + this.financialAccount = financialAccount; + return this; + } + + /** + * Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, + * and subsequent calls add additional key/value pairs to the original map. See {@link + * SettlementAllocationIntentCreateParams#metadata} for the field documentation. + */ + public Builder putMetadata(String key, String value) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `metadata` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SettlementAllocationIntentCreateParams#metadata} for the field documentation. + */ + public Builder putAllMetadata(Map map) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.putAll(map); + return this; + } + + /** + * Required. Reference for the SettlementAllocationIntent. This should be same + * as the transaction reference used by payments processor to send funds to Stripe. Must have + * length between 5 and 255 characters and it must be unique among existing + * SettlementAllocationIntents that have a non-terminal status ({@code pending}, {@code + * submitted}, {@code matched}, {@code errored}). + */ + public Builder setReference(String reference) { + this.reference = reference; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Amount { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + @SerializedName("value") + Long value; + + private Amount(String currency, Map extraParams, Long value) { + this.currency = currency; + this.extraParams = extraParams; + this.value = value; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String currency; + + private Map extraParams; + + private Long value; + + /** Finalize and obtain parameter instance from this builder. */ + public SettlementAllocationIntentCreateParams.Amount build() { + return new SettlementAllocationIntentCreateParams.Amount( + this.currency, this.extraParams, this.value); + } + + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + public Builder setCurrency(String currency) { + this.currency = currency; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SettlementAllocationIntentCreateParams.Amount#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SettlementAllocationIntentCreateParams.Amount#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + public Builder setValue(Long value) { + this.value = value; + return this; + } + } + } +} diff --git a/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentUpdateParams.java b/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentUpdateParams.java new file mode 100644 index 00000000000..4f3eedb5599 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/payments/SettlementAllocationIntentUpdateParams.java @@ -0,0 +1,214 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.payments; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import com.stripe.param.common.EmptyParam; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class SettlementAllocationIntentUpdateParams extends ApiRequestParams { + /** + * The new amount for the SettlementAllocationIntent. Only amount.value can be updated and + * currency must remain same. + */ + @SerializedName("amount") + Amount amount; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The new reference for the SettlementAllocationIntent. */ + @SerializedName("reference") + Object reference; + + private SettlementAllocationIntentUpdateParams( + Amount amount, Map extraParams, Object reference) { + this.amount = amount; + this.extraParams = extraParams; + this.reference = reference; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Amount amount; + + private Map extraParams; + + private Object reference; + + /** Finalize and obtain parameter instance from this builder. */ + public SettlementAllocationIntentUpdateParams build() { + return new SettlementAllocationIntentUpdateParams( + this.amount, this.extraParams, this.reference); + } + + /** + * The new amount for the SettlementAllocationIntent. Only amount.value can be updated and + * currency must remain same. + */ + public Builder setAmount(SettlementAllocationIntentUpdateParams.Amount amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SettlementAllocationIntentUpdateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SettlementAllocationIntentUpdateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The new reference for the SettlementAllocationIntent. */ + public Builder setReference(String reference) { + this.reference = reference; + return this; + } + + /** The new reference for the SettlementAllocationIntent. */ + public Builder setReference(EmptyParam reference) { + this.reference = reference; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Amount { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + Object currency; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + @SerializedName("value") + Long value; + + private Amount(Object currency, Map extraParams, Long value) { + this.currency = currency; + this.extraParams = extraParams; + this.value = value; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Object currency; + + private Map extraParams; + + private Long value; + + /** Finalize and obtain parameter instance from this builder. */ + public SettlementAllocationIntentUpdateParams.Amount build() { + return new SettlementAllocationIntentUpdateParams.Amount( + this.currency, this.extraParams, this.value); + } + + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + public Builder setCurrency(String currency) { + this.currency = currency; + return this; + } + + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + public Builder setCurrency(EmptyParam currency) { + this.currency = currency; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SettlementAllocationIntentUpdateParams.Amount#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SettlementAllocationIntentUpdateParams.Amount#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + public Builder setValue(Long value) { + this.value = value; + return this; + } + } + } +} diff --git a/src/main/java/com/stripe/param/v2/payments/settlementallocationintents/SplitCreateParams.java b/src/main/java/com/stripe/param/v2/payments/settlementallocationintents/SplitCreateParams.java new file mode 100644 index 00000000000..b39422a0562 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/payments/settlementallocationintents/SplitCreateParams.java @@ -0,0 +1,261 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.payments.settlementallocationintents; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class SplitCreateParams extends ApiRequestParams { + /** + * Required. The target account for settling the SettlementAllocationIntentSplit. + */ + @SerializedName("account") + String account; + + /** Required. The amount and currency of the SettlementAllocationIntentSplit. */ + @SerializedName("amount") + Amount amount; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Metadata associated with the SettlementAllocationIntentSplit. */ + @SerializedName("metadata") + Map metadata; + + /** Required. The type of the fund transfer. */ + @SerializedName("type") + Type type; + + private SplitCreateParams( + String account, + Amount amount, + Map extraParams, + Map metadata, + Type type) { + this.account = account; + this.amount = amount; + this.extraParams = extraParams; + this.metadata = metadata; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String account; + + private Amount amount; + + private Map extraParams; + + private Map metadata; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public SplitCreateParams build() { + return new SplitCreateParams( + this.account, this.amount, this.extraParams, this.metadata, this.type); + } + + /** + * Required. The target account for settling the + * SettlementAllocationIntentSplit. + */ + public Builder setAccount(String account) { + this.account = account; + return this; + } + + /** + * Required. The amount and currency of the SettlementAllocationIntentSplit. + */ + public Builder setAmount(SplitCreateParams.Amount amount) { + this.amount = amount; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SplitCreateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SplitCreateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, + * and subsequent calls add additional key/value pairs to the original map. See {@link + * SplitCreateParams#metadata} for the field documentation. + */ + public Builder putMetadata(String key, String value) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `metadata` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SplitCreateParams#metadata} for the field documentation. + */ + public Builder putAllMetadata(Map map) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.putAll(map); + return this; + } + + /** Required. The type of the fund transfer. */ + public Builder setType(SplitCreateParams.Type type) { + this.type = type; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Amount { + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + @SerializedName("currency") + String currency; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + @SerializedName("value") + Long value; + + private Amount(String currency, Map extraParams, Long value) { + this.currency = currency; + this.extraParams = extraParams; + this.value = value; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String currency; + + private Map extraParams; + + private Long value; + + /** Finalize and obtain parameter instance from this builder. */ + public SplitCreateParams.Amount build() { + return new SplitCreateParams.Amount(this.currency, this.extraParams, this.value); + } + + /** + * Three-letter ISO currency + * code, in lowercase. Must be a supported + * currency. + */ + public Builder setCurrency(String currency) { + this.currency = currency; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * SplitCreateParams.Amount#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link SplitCreateParams.Amount#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * A non-negative integer representing how much to charge in the smallest currency unit. + */ + public Builder setValue(Long value) { + this.value = value; + return this; + } + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("credit") + CREDIT("credit"), + + @SerializedName("debit") + DEBIT("debit"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } +} diff --git a/src/main/java/com/stripe/param/v2/tax/ManualRuleCreateParams.java b/src/main/java/com/stripe/param/v2/tax/ManualRuleCreateParams.java new file mode 100644 index 00000000000..b04ebe48578 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/tax/ManualRuleCreateParams.java @@ -0,0 +1,634 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.tax; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ManualRuleCreateParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Location where the rule applies. */ + @SerializedName("location") + Location location; + + /** Products associated with the rule. */ + @SerializedName("products") + List products; + + /** Required. Tax rates to be applied. */ + @SerializedName("scheduled_tax_rates") + List scheduledTaxRates; + + private ManualRuleCreateParams( + Map extraParams, + Location location, + List products, + List scheduledTaxRates) { + this.extraParams = extraParams; + this.location = location; + this.products = products; + this.scheduledTaxRates = scheduledTaxRates; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Location location; + + private List products; + + private List scheduledTaxRates; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleCreateParams build() { + return new ManualRuleCreateParams( + this.extraParams, this.location, this.products, this.scheduledTaxRates); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleCreateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleCreateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Location where the rule applies. */ + public Builder setLocation(ManualRuleCreateParams.Location location) { + this.location = location; + return this; + } + + /** + * Add an element to `products` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * ManualRuleCreateParams#products} for the field documentation. + */ + public Builder addProduct(ManualRuleCreateParams.Product element) { + if (this.products == null) { + this.products = new ArrayList<>(); + } + this.products.add(element); + return this; + } + + /** + * Add all elements to `products` list. A list is initialized for the first `add/addAll` call, + * and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleCreateParams#products} for the field documentation. + */ + public Builder addAllProduct(List elements) { + if (this.products == null) { + this.products = new ArrayList<>(); + } + this.products.addAll(elements); + return this; + } + + /** + * Add an element to `scheduledTaxRates` list. A list is initialized for the first `add/addAll` + * call, and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleCreateParams#scheduledTaxRates} for the field documentation. + */ + public Builder addScheduledTaxRate(ManualRuleCreateParams.ScheduledTaxRate element) { + if (this.scheduledTaxRates == null) { + this.scheduledTaxRates = new ArrayList<>(); + } + this.scheduledTaxRates.add(element); + return this; + } + + /** + * Add all elements to `scheduledTaxRates` list. A list is initialized for the first + * `add/addAll` call, and subsequent calls adds additional elements to the original list. See + * {@link ManualRuleCreateParams#scheduledTaxRates} for the field documentation. + */ + public Builder addAllScheduledTaxRate(List elements) { + if (this.scheduledTaxRates == null) { + this.scheduledTaxRates = new ArrayList<>(); + } + this.scheduledTaxRates.addAll(elements); + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Location { + /** Required. Country ISO-3166. */ + @SerializedName("country") + String country; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** State ISO-3166. */ + @SerializedName("state") + String state; + + private Location(String country, Map extraParams, String state) { + this.country = country; + this.extraParams = extraParams; + this.state = state; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String country; + + private Map extraParams; + + private String state; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleCreateParams.Location build() { + return new ManualRuleCreateParams.Location(this.country, this.extraParams, this.state); + } + + /** Required. Country ISO-3166. */ + public Builder setCountry(String country) { + this.country = country; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleCreateParams.Location#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleCreateParams.Location#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** State ISO-3166. */ + public Builder setState(String state) { + this.state = state; + return this; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Product { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The licensed item identifier. */ + @SerializedName("licensed_item") + String licensedItem; + + /** The metered item identifier. */ + @SerializedName("metered_item") + String meteredItem; + + /** The tax code for the product. */ + @SerializedName("tax_code") + String taxCode; + + /** Required. The type of the product. */ + @SerializedName("type") + Type type; + + private Product( + Map extraParams, + String licensedItem, + String meteredItem, + String taxCode, + Type type) { + this.extraParams = extraParams; + this.licensedItem = licensedItem; + this.meteredItem = meteredItem; + this.taxCode = taxCode; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private String licensedItem; + + private String meteredItem; + + private String taxCode; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleCreateParams.Product build() { + return new ManualRuleCreateParams.Product( + this.extraParams, this.licensedItem, this.meteredItem, this.taxCode, this.type); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleCreateParams.Product#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleCreateParams.Product#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The licensed item identifier. */ + public Builder setLicensedItem(String licensedItem) { + this.licensedItem = licensedItem; + return this; + } + + /** The metered item identifier. */ + public Builder setMeteredItem(String meteredItem) { + this.meteredItem = meteredItem; + return this; + } + + /** The tax code for the product. */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + + /** Required. The type of the product. */ + public Builder setType(ManualRuleCreateParams.Product.Type type) { + this.type = type; + return this; + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("licensed_item") + LICENSED_ITEM("licensed_item"), + + @SerializedName("metered_item") + METERED_ITEM("metered_item"), + + @SerializedName("tax_code") + TAX_CODE("tax_code"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class ScheduledTaxRate { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. The tax rates to be applied. */ + @SerializedName("rates") + List rates; + + /** The start time for the tax rate. */ + @SerializedName("starts_at") + Instant startsAt; + + private ScheduledTaxRate( + Map extraParams, + List rates, + Instant startsAt) { + this.extraParams = extraParams; + this.rates = rates; + this.startsAt = startsAt; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private List rates; + + private Instant startsAt; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleCreateParams.ScheduledTaxRate build() { + return new ManualRuleCreateParams.ScheduledTaxRate( + this.extraParams, this.rates, this.startsAt); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleCreateParams.ScheduledTaxRate#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleCreateParams.ScheduledTaxRate#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Add an element to `rates` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * ManualRuleCreateParams.ScheduledTaxRate#rates} for the field documentation. + */ + public Builder addRate(ManualRuleCreateParams.ScheduledTaxRate.Rate element) { + if (this.rates == null) { + this.rates = new ArrayList<>(); + } + this.rates.add(element); + return this; + } + + /** + * Add all elements to `rates` list. A list is initialized for the first `add/addAll` call, + * and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleCreateParams.ScheduledTaxRate#rates} for the field documentation. + */ + public Builder addAllRate(List elements) { + if (this.rates == null) { + this.rates = new ArrayList<>(); + } + this.rates.addAll(elements); + return this; + } + + /** The start time for the tax rate. */ + public Builder setStartsAt(Instant startsAt) { + this.startsAt = startsAt; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Rate { + /** Country of the tax rate. */ + @SerializedName("country") + String country; + + /** Description of the tax rate. */ + @SerializedName("description") + String description; + + /** + * Required. Display name of the tax rate as it will be shown on the invoice. + */ + @SerializedName("display_name") + String displayName; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + @SerializedName("jurisdiction") + String jurisdiction; + + /** + * Required. Percentage of the tax rate. Must be positive and maximum of 4 + * decimal points. + */ + @SerializedName("percentage") + String percentage; + + /** State of the tax rate. */ + @SerializedName("state") + String state; + + private Rate( + String country, + String description, + String displayName, + Map extraParams, + String jurisdiction, + String percentage, + String state) { + this.country = country; + this.description = description; + this.displayName = displayName; + this.extraParams = extraParams; + this.jurisdiction = jurisdiction; + this.percentage = percentage; + this.state = state; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String country; + + private String description; + + private String displayName; + + private Map extraParams; + + private String jurisdiction; + + private String percentage; + + private String state; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleCreateParams.ScheduledTaxRate.Rate build() { + return new ManualRuleCreateParams.ScheduledTaxRate.Rate( + this.country, + this.description, + this.displayName, + this.extraParams, + this.jurisdiction, + this.percentage, + this.state); + } + + /** Country of the tax rate. */ + public Builder setCountry(String country) { + this.country = country; + return this; + } + + /** Description of the tax rate. */ + public Builder setDescription(String description) { + this.description = description; + return this; + } + + /** + * Required. Display name of the tax rate as it will be shown on the + * invoice. + */ + public Builder setDisplayName(String displayName) { + this.displayName = displayName; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ManualRuleCreateParams.ScheduledTaxRate.Rate#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ManualRuleCreateParams.ScheduledTaxRate.Rate#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + public Builder setJurisdiction(String jurisdiction) { + this.jurisdiction = jurisdiction; + return this; + } + + /** + * Required. Percentage of the tax rate. Must be positive and maximum of 4 + * decimal points. + */ + public Builder setPercentage(String percentage) { + this.percentage = percentage; + return this; + } + + /** State of the tax rate. */ + public Builder setState(String state) { + this.state = state; + return this; + } + } + } + } +} diff --git a/src/main/java/com/stripe/param/v2/tax/ManualRuleListParams.java b/src/main/java/com/stripe/param/v2/tax/ManualRuleListParams.java new file mode 100644 index 00000000000..ba7837e8235 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/tax/ManualRuleListParams.java @@ -0,0 +1,78 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.tax; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import java.util.HashMap; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ManualRuleListParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Optionally set the maximum number of results per page. Defaults to 20. */ + @SerializedName("limit") + Long limit; + + private ManualRuleListParams(Map extraParams, Long limit) { + this.extraParams = extraParams; + this.limit = limit; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Long limit; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleListParams build() { + return new ManualRuleListParams(this.extraParams, this.limit); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleListParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleListParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Optionally set the maximum number of results per page. Defaults to 20. */ + public Builder setLimit(Long limit) { + this.limit = limit; + return this; + } + } +} diff --git a/src/main/java/com/stripe/param/v2/tax/ManualRuleUpdateParams.java b/src/main/java/com/stripe/param/v2/tax/ManualRuleUpdateParams.java new file mode 100644 index 00000000000..c6156d792b7 --- /dev/null +++ b/src/main/java/com/stripe/param/v2/tax/ManualRuleUpdateParams.java @@ -0,0 +1,707 @@ +// File generated from our OpenAPI spec +package com.stripe.param.v2.tax; + +import com.google.gson.annotations.SerializedName; +import com.stripe.net.ApiRequestParams; +import com.stripe.param.common.EmptyParam; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.EqualsAndHashCode; +import lombok.Getter; + +@Getter +@EqualsAndHashCode(callSuper = false) +public class ManualRuleUpdateParams extends ApiRequestParams { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Location where the rule applies. */ + @SerializedName("location") + Location location; + + /** Products associated with the rule. */ + @SerializedName("products") + List products; + + /** Required. Tax rates to be applied. */ + @SerializedName("scheduled_tax_rates") + List scheduledTaxRates; + + private ManualRuleUpdateParams( + Map extraParams, + Location location, + List products, + List scheduledTaxRates) { + this.extraParams = extraParams; + this.location = location; + this.products = products; + this.scheduledTaxRates = scheduledTaxRates; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Location location; + + private List products; + + private List scheduledTaxRates; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleUpdateParams build() { + return new ManualRuleUpdateParams( + this.extraParams, this.location, this.products, this.scheduledTaxRates); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleUpdateParams#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleUpdateParams#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Location where the rule applies. */ + public Builder setLocation(ManualRuleUpdateParams.Location location) { + this.location = location; + return this; + } + + /** + * Add an element to `products` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * ManualRuleUpdateParams#products} for the field documentation. + */ + public Builder addProduct(ManualRuleUpdateParams.Product element) { + if (this.products == null) { + this.products = new ArrayList<>(); + } + this.products.add(element); + return this; + } + + /** + * Add all elements to `products` list. A list is initialized for the first `add/addAll` call, + * and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleUpdateParams#products} for the field documentation. + */ + public Builder addAllProduct(List elements) { + if (this.products == null) { + this.products = new ArrayList<>(); + } + this.products.addAll(elements); + return this; + } + + /** + * Add an element to `scheduledTaxRates` list. A list is initialized for the first `add/addAll` + * call, and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleUpdateParams#scheduledTaxRates} for the field documentation. + */ + public Builder addScheduledTaxRate(ManualRuleUpdateParams.ScheduledTaxRate element) { + if (this.scheduledTaxRates == null) { + this.scheduledTaxRates = new ArrayList<>(); + } + this.scheduledTaxRates.add(element); + return this; + } + + /** + * Add all elements to `scheduledTaxRates` list. A list is initialized for the first + * `add/addAll` call, and subsequent calls adds additional elements to the original list. See + * {@link ManualRuleUpdateParams#scheduledTaxRates} for the field documentation. + */ + public Builder addAllScheduledTaxRate(List elements) { + if (this.scheduledTaxRates == null) { + this.scheduledTaxRates = new ArrayList<>(); + } + this.scheduledTaxRates.addAll(elements); + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Location { + /** Required. Country ISO-3166. */ + @SerializedName("country") + Object country; + + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** State ISO-3166. */ + @SerializedName("state") + Object state; + + private Location(Object country, Map extraParams, Object state) { + this.country = country; + this.extraParams = extraParams; + this.state = state; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Object country; + + private Map extraParams; + + private Object state; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleUpdateParams.Location build() { + return new ManualRuleUpdateParams.Location(this.country, this.extraParams, this.state); + } + + /** Required. Country ISO-3166. */ + public Builder setCountry(String country) { + this.country = country; + return this; + } + + /** Required. Country ISO-3166. */ + public Builder setCountry(EmptyParam country) { + this.country = country; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleUpdateParams.Location#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleUpdateParams.Location#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** State ISO-3166. */ + public Builder setState(String state) { + this.state = state; + return this; + } + + /** State ISO-3166. */ + public Builder setState(EmptyParam state) { + this.state = state; + return this; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Product { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** The licensed item identifier. */ + @SerializedName("licensed_item") + Object licensedItem; + + /** The metered item identifier. */ + @SerializedName("metered_item") + Object meteredItem; + + /** The tax code for the product. */ + @SerializedName("tax_code") + Object taxCode; + + /** Required. The type of the product. */ + @SerializedName("type") + Type type; + + private Product( + Map extraParams, + Object licensedItem, + Object meteredItem, + Object taxCode, + Type type) { + this.extraParams = extraParams; + this.licensedItem = licensedItem; + this.meteredItem = meteredItem; + this.taxCode = taxCode; + this.type = type; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private Object licensedItem; + + private Object meteredItem; + + private Object taxCode; + + private Type type; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleUpdateParams.Product build() { + return new ManualRuleUpdateParams.Product( + this.extraParams, this.licensedItem, this.meteredItem, this.taxCode, this.type); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleUpdateParams.Product#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleUpdateParams.Product#extraParams} for the field documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** The licensed item identifier. */ + public Builder setLicensedItem(String licensedItem) { + this.licensedItem = licensedItem; + return this; + } + + /** The licensed item identifier. */ + public Builder setLicensedItem(EmptyParam licensedItem) { + this.licensedItem = licensedItem; + return this; + } + + /** The metered item identifier. */ + public Builder setMeteredItem(String meteredItem) { + this.meteredItem = meteredItem; + return this; + } + + /** The metered item identifier. */ + public Builder setMeteredItem(EmptyParam meteredItem) { + this.meteredItem = meteredItem; + return this; + } + + /** The tax code for the product. */ + public Builder setTaxCode(String taxCode) { + this.taxCode = taxCode; + return this; + } + + /** The tax code for the product. */ + public Builder setTaxCode(EmptyParam taxCode) { + this.taxCode = taxCode; + return this; + } + + /** Required. The type of the product. */ + public Builder setType(ManualRuleUpdateParams.Product.Type type) { + this.type = type; + return this; + } + } + + public enum Type implements ApiRequestParams.EnumParam { + @SerializedName("licensed_item") + LICENSED_ITEM("licensed_item"), + + @SerializedName("metered_item") + METERED_ITEM("metered_item"), + + @SerializedName("tax_code") + TAX_CODE("tax_code"); + + @Getter(onMethod_ = {@Override}) + private final String value; + + Type(String value) { + this.value = value; + } + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class ScheduledTaxRate { + /** + * Map of extra parameters for custom features not available in this client library. The content + * in this map is not serialized under this field's {@code @SerializedName} value. Instead, each + * key/value pair is serialized as if the key is a root-level field (serialized) name in this + * param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Required. The tax rates to be applied. */ + @SerializedName("rates") + List rates; + + /** The start time for the tax rate. */ + @SerializedName("starts_at") + Instant startsAt; + + private ScheduledTaxRate( + Map extraParams, + List rates, + Instant startsAt) { + this.extraParams = extraParams; + this.rates = rates; + this.startsAt = startsAt; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Map extraParams; + + private List rates; + + private Instant startsAt; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleUpdateParams.ScheduledTaxRate build() { + return new ManualRuleUpdateParams.ScheduledTaxRate( + this.extraParams, this.rates, this.startsAt); + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` + * call, and subsequent calls add additional key/value pairs to the original map. See {@link + * ManualRuleUpdateParams.ScheduledTaxRate#extraParams} for the field documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. + * See {@link ManualRuleUpdateParams.ScheduledTaxRate#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** + * Add an element to `rates` list. A list is initialized for the first `add/addAll` call, and + * subsequent calls adds additional elements to the original list. See {@link + * ManualRuleUpdateParams.ScheduledTaxRate#rates} for the field documentation. + */ + public Builder addRate(ManualRuleUpdateParams.ScheduledTaxRate.Rate element) { + if (this.rates == null) { + this.rates = new ArrayList<>(); + } + this.rates.add(element); + return this; + } + + /** + * Add all elements to `rates` list. A list is initialized for the first `add/addAll` call, + * and subsequent calls adds additional elements to the original list. See {@link + * ManualRuleUpdateParams.ScheduledTaxRate#rates} for the field documentation. + */ + public Builder addAllRate(List elements) { + if (this.rates == null) { + this.rates = new ArrayList<>(); + } + this.rates.addAll(elements); + return this; + } + + /** The start time for the tax rate. */ + public Builder setStartsAt(Instant startsAt) { + this.startsAt = startsAt; + return this; + } + } + + @Getter + @EqualsAndHashCode(callSuper = false) + public static class Rate { + /** Country of the tax rate. */ + @SerializedName("country") + Object country; + + /** Description of the tax rate. */ + @SerializedName("description") + Object description; + + /** + * Required. Display name of the tax rate as it will be shown on the invoice. + */ + @SerializedName("display_name") + Object displayName; + + /** + * Map of extra parameters for custom features not available in this client library. The + * content in this map is not serialized under this field's {@code @SerializedName} value. + * Instead, each key/value pair is serialized as if the key is a root-level field (serialized) + * name in this param object. Effectively, this map is flattened to its parent instance. + */ + @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY) + Map extraParams; + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + @SerializedName("jurisdiction") + Object jurisdiction; + + /** + * Required. Percentage of the tax rate. Must be positive and maximum of 4 + * decimal points. + */ + @SerializedName("percentage") + Object percentage; + + /** State of the tax rate. */ + @SerializedName("state") + Object state; + + private Rate( + Object country, + Object description, + Object displayName, + Map extraParams, + Object jurisdiction, + Object percentage, + Object state) { + this.country = country; + this.description = description; + this.displayName = displayName; + this.extraParams = extraParams; + this.jurisdiction = jurisdiction; + this.percentage = percentage; + this.state = state; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Object country; + + private Object description; + + private Object displayName; + + private Map extraParams; + + private Object jurisdiction; + + private Object percentage; + + private Object state; + + /** Finalize and obtain parameter instance from this builder. */ + public ManualRuleUpdateParams.ScheduledTaxRate.Rate build() { + return new ManualRuleUpdateParams.ScheduledTaxRate.Rate( + this.country, + this.description, + this.displayName, + this.extraParams, + this.jurisdiction, + this.percentage, + this.state); + } + + /** Country of the tax rate. */ + public Builder setCountry(String country) { + this.country = country; + return this; + } + + /** Country of the tax rate. */ + public Builder setCountry(EmptyParam country) { + this.country = country; + return this; + } + + /** Description of the tax rate. */ + public Builder setDescription(String description) { + this.description = description; + return this; + } + + /** Description of the tax rate. */ + public Builder setDescription(EmptyParam description) { + this.description = description; + return this; + } + + /** + * Required. Display name of the tax rate as it will be shown on the + * invoice. + */ + public Builder setDisplayName(String displayName) { + this.displayName = displayName; + return this; + } + + /** + * Required. Display name of the tax rate as it will be shown on the + * invoice. + */ + public Builder setDisplayName(EmptyParam displayName) { + this.displayName = displayName; + return this; + } + + /** + * Add a key/value pair to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ManualRuleUpdateParams.ScheduledTaxRate.Rate#extraParams} for the field + * documentation. + */ + public Builder putExtraParam(String key, Object value) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.put(key, value); + return this; + } + + /** + * Add all map key/value pairs to `extraParams` map. A map is initialized for the first + * `put/putAll` call, and subsequent calls add additional key/value pairs to the original + * map. See {@link ManualRuleUpdateParams.ScheduledTaxRate.Rate#extraParams} for the field + * documentation. + */ + public Builder putAllExtraParam(Map map) { + if (this.extraParams == null) { + this.extraParams = new HashMap<>(); + } + this.extraParams.putAll(map); + return this; + } + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + public Builder setJurisdiction(String jurisdiction) { + this.jurisdiction = jurisdiction; + return this; + } + + /** Jurisdiction of the tax rate should apply as it will be shown on the invoice. */ + public Builder setJurisdiction(EmptyParam jurisdiction) { + this.jurisdiction = jurisdiction; + return this; + } + + /** + * Required. Percentage of the tax rate. Must be positive and maximum of 4 + * decimal points. + */ + public Builder setPercentage(String percentage) { + this.percentage = percentage; + return this; + } + + /** + * Required. Percentage of the tax rate. Must be positive and maximum of 4 + * decimal points. + */ + public Builder setPercentage(EmptyParam percentage) { + this.percentage = percentage; + return this; + } + + /** State of the tax rate. */ + public Builder setState(String state) { + this.state = state; + return this; + } + + /** State of the tax rate. */ + public Builder setState(EmptyParam state) { + this.state = state; + return this; + } + } + } + } +} diff --git a/src/main/java/com/stripe/service/PaymentMethodService.java b/src/main/java/com/stripe/service/PaymentMethodService.java index 303713c4803..4ff713c9d42 100644 --- a/src/main/java/com/stripe/service/PaymentMethodService.java +++ b/src/main/java/com/stripe/service/PaymentMethodService.java @@ -26,40 +26,20 @@ public PaymentMethodService(StripeResponseGetter responseGetter) { super(responseGetter); } - /** - * 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 StripeCollection list(PaymentMethodListParams params) throws StripeException { return list(params, (RequestOptions) null); } - /** - * 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 StripeCollection list(RequestOptions options) throws StripeException { return list((PaymentMethodListParams) null, options); } - /** - * 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 StripeCollection list() throws StripeException { return list((PaymentMethodListParams) null, (RequestOptions) null); } - /** - * 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 StripeCollection list( PaymentMethodListParams params, RequestOptions options) throws StripeException { String path = "/v1/payment_methods"; diff --git a/src/main/java/com/stripe/service/SharedPaymentService.java b/src/main/java/com/stripe/service/SharedPaymentService.java new file mode 100644 index 00000000000..69a468af821 --- /dev/null +++ b/src/main/java/com/stripe/service/SharedPaymentService.java @@ -0,0 +1,15 @@ +// File generated from our OpenAPI spec +package com.stripe.service; + +import com.stripe.net.ApiService; +import com.stripe.net.StripeResponseGetter; + +public final class SharedPaymentService extends ApiService { + public SharedPaymentService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + public com.stripe.service.sharedpayment.GrantedTokenService grantedTokens() { + return new com.stripe.service.sharedpayment.GrantedTokenService(this.getResponseGetter()); + } +} diff --git a/src/main/java/com/stripe/service/TestHelpersService.java b/src/main/java/com/stripe/service/TestHelpersService.java index 03820b70524..3d5347f3f08 100644 --- a/src/main/java/com/stripe/service/TestHelpersService.java +++ b/src/main/java/com/stripe/service/TestHelpersService.java @@ -29,6 +29,10 @@ public com.stripe.service.testhelpers.RefundService refunds() { return new com.stripe.service.testhelpers.RefundService(this.getResponseGetter()); } + public com.stripe.service.testhelpers.SharedPaymentService sharedPayment() { + return new com.stripe.service.testhelpers.SharedPaymentService(this.getResponseGetter()); + } + public com.stripe.service.testhelpers.TerminalService terminal() { return new com.stripe.service.testhelpers.TerminalService(this.getResponseGetter()); } diff --git a/src/main/java/com/stripe/service/V1Services.java b/src/main/java/com/stripe/service/V1Services.java index f89c0768fae..0540e4a1c39 100644 --- a/src/main/java/com/stripe/service/V1Services.java +++ b/src/main/java/com/stripe/service/V1Services.java @@ -269,6 +269,10 @@ public com.stripe.service.SetupIntentService setupIntents() { return new com.stripe.service.SetupIntentService(this.getResponseGetter()); } + public com.stripe.service.SharedPaymentService sharedPayment() { + return new com.stripe.service.SharedPaymentService(this.getResponseGetter()); + } + public com.stripe.service.ShippingRateService shippingRates() { return new com.stripe.service.ShippingRateService(this.getResponseGetter()); } diff --git a/src/main/java/com/stripe/service/V2Services.java b/src/main/java/com/stripe/service/V2Services.java index de7d06b52e2..f7557e710b3 100644 --- a/src/main/java/com/stripe/service/V2Services.java +++ b/src/main/java/com/stripe/service/V2Services.java @@ -17,6 +17,10 @@ public com.stripe.service.v2.CoreService core() { return new com.stripe.service.v2.CoreService(this.getResponseGetter()); } + public com.stripe.service.v2.IamService iam() { + return new com.stripe.service.v2.IamService(this.getResponseGetter()); + } + public com.stripe.service.v2.MoneyManagementService moneyManagement() { return new com.stripe.service.v2.MoneyManagementService(this.getResponseGetter()); } @@ -29,6 +33,10 @@ public com.stripe.service.v2.ReportingService reporting() { return new com.stripe.service.v2.ReportingService(this.getResponseGetter()); } + public com.stripe.service.v2.TaxService tax() { + return new com.stripe.service.v2.TaxService(this.getResponseGetter()); + } + public com.stripe.service.v2.TestHelperService testHelpers() { return new com.stripe.service.v2.TestHelperService(this.getResponseGetter()); } diff --git a/src/main/java/com/stripe/service/capital/FinancingSummaryService.java b/src/main/java/com/stripe/service/capital/FinancingSummaryService.java index 3f0584590c7..e42e14990d0 100644 --- a/src/main/java/com/stripe/service/capital/FinancingSummaryService.java +++ b/src/main/java/com/stripe/service/capital/FinancingSummaryService.java @@ -17,19 +17,19 @@ public FinancingSummaryService(StripeResponseGetter responseGetter) { super(responseGetter); } - /** Retrieve the financing state for the account that was authenticated in the request. */ + /** Retrieve the financing summary object for the account. */ public FinancingSummary retrieve(FinancingSummaryRetrieveParams params) throws StripeException { return retrieve(params, (RequestOptions) null); } - /** Retrieve the financing state for the account that was authenticated in the request. */ + /** Retrieve the financing summary object for the account. */ public FinancingSummary retrieve(RequestOptions options) throws StripeException { return retrieve((FinancingSummaryRetrieveParams) null, options); } - /** Retrieve the financing state for the account that was authenticated in the request. */ + /** Retrieve the financing summary object for the account. */ public FinancingSummary retrieve() throws StripeException { return retrieve((FinancingSummaryRetrieveParams) null, (RequestOptions) null); } - /** Retrieve the financing state for the account that was authenticated in the request. */ + /** Retrieve the financing summary object for the account. */ public FinancingSummary retrieve(FinancingSummaryRetrieveParams params, RequestOptions options) throws StripeException { String path = "/v1/capital/financing_summary"; diff --git a/src/main/java/com/stripe/service/sharedpayment/GrantedTokenService.java b/src/main/java/com/stripe/service/sharedpayment/GrantedTokenService.java new file mode 100644 index 00000000000..97f19fc96f5 --- /dev/null +++ b/src/main/java/com/stripe/service/sharedpayment/GrantedTokenService.java @@ -0,0 +1,52 @@ +// File generated from our OpenAPI spec +package com.stripe.service.sharedpayment; + +import com.stripe.exception.StripeException; +import com.stripe.model.sharedpayment.GrantedToken; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.sharedpayment.GrantedTokenRetrieveParams; + +public final class GrantedTokenService extends ApiService { + public GrantedTokenService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public GrantedToken retrieve(String sharedPaymentGrantedToken, GrantedTokenRetrieveParams params) + throws StripeException { + return retrieve(sharedPaymentGrantedToken, params, (RequestOptions) null); + } + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public GrantedToken retrieve(String sharedPaymentGrantedToken, RequestOptions options) + throws StripeException { + return retrieve(sharedPaymentGrantedToken, (GrantedTokenRetrieveParams) null, options); + } + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public GrantedToken retrieve(String sharedPaymentGrantedToken) throws StripeException { + return retrieve( + sharedPaymentGrantedToken, (GrantedTokenRetrieveParams) null, (RequestOptions) null); + } + /** Retrieves an existing SharedPaymentGrantedToken object. */ + public GrantedToken retrieve( + String sharedPaymentGrantedToken, GrantedTokenRetrieveParams params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/shared_payment/granted_tokens/%s", + ApiResource.urlEncodeId(sharedPaymentGrantedToken)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, GrantedToken.class); + } +} diff --git a/src/main/java/com/stripe/service/testhelpers/SharedPaymentService.java b/src/main/java/com/stripe/service/testhelpers/SharedPaymentService.java new file mode 100644 index 00000000000..4f1613353f5 --- /dev/null +++ b/src/main/java/com/stripe/service/testhelpers/SharedPaymentService.java @@ -0,0 +1,16 @@ +// File generated from our OpenAPI spec +package com.stripe.service.testhelpers; + +import com.stripe.net.ApiService; +import com.stripe.net.StripeResponseGetter; + +public final class SharedPaymentService extends ApiService { + public SharedPaymentService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + public com.stripe.service.testhelpers.sharedpayment.GrantedTokenService grantedTokens() { + return new com.stripe.service.testhelpers.sharedpayment.GrantedTokenService( + this.getResponseGetter()); + } +} diff --git a/src/main/java/com/stripe/service/testhelpers/sharedpayment/GrantedTokenService.java b/src/main/java/com/stripe/service/testhelpers/sharedpayment/GrantedTokenService.java new file mode 100644 index 00000000000..9ac86518c78 --- /dev/null +++ b/src/main/java/com/stripe/service/testhelpers/sharedpayment/GrantedTokenService.java @@ -0,0 +1,88 @@ +// File generated from our OpenAPI spec +package com.stripe.service.testhelpers.sharedpayment; + +import com.stripe.exception.StripeException; +import com.stripe.model.sharedpayment.GrantedToken; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.sharedpayment.GrantedTokenCreateParams; +import com.stripe.param.sharedpayment.GrantedTokenUpdateParams; + +public final class GrantedTokenService extends ApiService { + public GrantedTokenService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken create(GrantedTokenCreateParams params) throws StripeException { + return create(params, (RequestOptions) null); + } + /** + * Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test + * mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken create(GrantedTokenCreateParams params, RequestOptions options) + throws StripeException { + String path = "/v1/test_helpers/shared_payment/granted_tokens"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, GrantedToken.class); + } + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(String sharedPaymentGrantedToken, GrantedTokenUpdateParams params) + throws StripeException { + return update(sharedPaymentGrantedToken, params, (RequestOptions) null); + } + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(String sharedPaymentGrantedToken, RequestOptions options) + throws StripeException { + return update(sharedPaymentGrantedToken, (GrantedTokenUpdateParams) null, options); + } + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update(String sharedPaymentGrantedToken) throws StripeException { + return update( + sharedPaymentGrantedToken, (GrantedTokenUpdateParams) null, (RequestOptions) null); + } + /** + * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode + * and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration + */ + public GrantedToken update( + String sharedPaymentGrantedToken, GrantedTokenUpdateParams params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v1/test_helpers/shared_payment/granted_tokens/%s/revoke", + ApiResource.urlEncodeId(sharedPaymentGrantedToken)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, GrantedToken.class); + } +} diff --git a/src/main/java/com/stripe/service/v2/IamService.java b/src/main/java/com/stripe/service/v2/IamService.java new file mode 100644 index 00000000000..b78e09994f4 --- /dev/null +++ b/src/main/java/com/stripe/service/v2/IamService.java @@ -0,0 +1,15 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2; + +import com.stripe.net.ApiService; +import com.stripe.net.StripeResponseGetter; + +public final class IamService extends ApiService { + public IamService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + public com.stripe.service.v2.iam.ApiKeyService apiKeys() { + return new com.stripe.service.v2.iam.ApiKeyService(this.getResponseGetter()); + } +} diff --git a/src/main/java/com/stripe/service/v2/PaymentService.java b/src/main/java/com/stripe/service/v2/PaymentService.java index 28d12615a13..2d64e99c9cf 100644 --- a/src/main/java/com/stripe/service/v2/PaymentService.java +++ b/src/main/java/com/stripe/service/v2/PaymentService.java @@ -12,4 +12,10 @@ public PaymentService(StripeResponseGetter responseGetter) { public com.stripe.service.v2.payments.OffSessionPaymentService offSessionPayments() { return new com.stripe.service.v2.payments.OffSessionPaymentService(this.getResponseGetter()); } + + public com.stripe.service.v2.payments.SettlementAllocationIntentService + settlementAllocationIntents() { + return new com.stripe.service.v2.payments.SettlementAllocationIntentService( + this.getResponseGetter()); + } } diff --git a/src/main/java/com/stripe/service/v2/TaxService.java b/src/main/java/com/stripe/service/v2/TaxService.java new file mode 100644 index 00000000000..db6c7463658 --- /dev/null +++ b/src/main/java/com/stripe/service/v2/TaxService.java @@ -0,0 +1,15 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2; + +import com.stripe.net.ApiService; +import com.stripe.net.StripeResponseGetter; + +public final class TaxService extends ApiService { + public TaxService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + public com.stripe.service.v2.tax.ManualRuleService manualRules() { + return new com.stripe.service.v2.tax.ManualRuleService(this.getResponseGetter()); + } +} diff --git a/src/main/java/com/stripe/service/v2/core/AccountLinkService.java b/src/main/java/com/stripe/service/v2/core/AccountLinkService.java index 45ded50e263..a47c0c59b5d 100644 --- a/src/main/java/com/stripe/service/v2/core/AccountLinkService.java +++ b/src/main/java/com/stripe/service/v2/core/AccountLinkService.java @@ -18,17 +18,15 @@ public AccountLinkService(StripeResponseGetter responseGetter) { } /** - * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can - * redirect their user to in order to take them to a Stripe-hosted application such as Recipient - * Onboarding. + * Creates an AccountLink object that includes a single-use URL that an account can use to access + * a Stripe-hosted flow for collecting or updating required information. */ public AccountLink create(AccountLinkCreateParams params) throws StripeException { return create(params, (RequestOptions) null); } /** - * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can - * redirect their user to in order to take them to a Stripe-hosted application such as Recipient - * Onboarding. + * Creates an AccountLink object that includes a single-use URL that an account can use to access + * a Stripe-hosted flow for collecting or updating required information. */ public AccountLink create(AccountLinkCreateParams params, RequestOptions options) throws StripeException { diff --git a/src/main/java/com/stripe/service/v2/core/AccountService.java b/src/main/java/com/stripe/service/v2/core/AccountService.java index a0ba9d38115..0ba14c9d182 100644 --- a/src/main/java/com/stripe/service/v2/core/AccountService.java +++ b/src/main/java/com/stripe/service/v2/core/AccountService.java @@ -2,7 +2,6 @@ package com.stripe.service.v2.core; import com.google.gson.reflect.TypeToken; -import com.stripe.exception.RateLimitException; import com.stripe.exception.StripeException; import com.stripe.model.v2.StripeCollection; import com.stripe.model.v2.core.Account; @@ -94,22 +93,20 @@ public Account create(AccountCreateParams params, RequestOptions options) throws return this.request(request, Account.class); } /** Retrieves the details of an Account. */ - public Account retrieve(String id, AccountRetrieveParams params) - throws StripeException, RateLimitException { + public Account retrieve(String id, AccountRetrieveParams params) throws StripeException { return retrieve(id, params, (RequestOptions) null); } /** Retrieves the details of an Account. */ - public Account retrieve(String id, RequestOptions options) - throws StripeException, RateLimitException { + public Account retrieve(String id, RequestOptions options) throws StripeException { return retrieve(id, (AccountRetrieveParams) null, options); } /** Retrieves the details of an Account. */ - public Account retrieve(String id) throws StripeException, RateLimitException { + public Account retrieve(String id) throws StripeException { return retrieve(id, (AccountRetrieveParams) null, (RequestOptions) null); } /** Retrieves the details of an Account. */ public Account retrieve(String id, AccountRetrieveParams params, RequestOptions options) - throws StripeException, RateLimitException { + throws StripeException { String path = String.format("/v2/core/accounts/%s", ApiResource.urlEncodeId(id)); ApiRequest request = new ApiRequest( @@ -121,22 +118,20 @@ public Account retrieve(String id, AccountRetrieveParams params, RequestOptions return this.request(request, Account.class); } /** Updates the details of an Account. */ - public Account update(String id, AccountUpdateParams params) - throws StripeException, RateLimitException { + public Account update(String id, AccountUpdateParams params) throws StripeException { return update(id, params, (RequestOptions) null); } /** Updates the details of an Account. */ - public Account update(String id, RequestOptions options) - throws StripeException, RateLimitException { + public Account update(String id, RequestOptions options) throws StripeException { return update(id, (AccountUpdateParams) null, options); } /** Updates the details of an Account. */ - public Account update(String id) throws StripeException, RateLimitException { + public Account update(String id) throws StripeException { return update(id, (AccountUpdateParams) null, (RequestOptions) null); } /** Updates the details of an Account. */ public Account update(String id, AccountUpdateParams params, RequestOptions options) - throws StripeException, RateLimitException { + throws StripeException { String path = String.format("/v2/core/accounts/%s", ApiResource.urlEncodeId(id)); ApiRequest request = new ApiRequest( diff --git a/src/main/java/com/stripe/service/v2/core/AccountTokenService.java b/src/main/java/com/stripe/service/v2/core/AccountTokenService.java index e1041147d39..cc7c754b89a 100644 --- a/src/main/java/com/stripe/service/v2/core/AccountTokenService.java +++ b/src/main/java/com/stripe/service/v2/core/AccountTokenService.java @@ -22,6 +22,14 @@ public AccountToken create(AccountTokenCreateParams params) throws StripeExcepti return create(params, (RequestOptions) null); } /** Creates an Account Token. */ + public AccountToken create(RequestOptions options) throws StripeException { + return create((AccountTokenCreateParams) null, options); + } + /** Creates an Account Token. */ + public AccountToken create() throws StripeException { + return create((AccountTokenCreateParams) null, (RequestOptions) null); + } + /** Creates an Account Token. */ public AccountToken create(AccountTokenCreateParams params, RequestOptions options) throws StripeException { String path = "/v2/core/account_tokens"; diff --git a/src/main/java/com/stripe/service/v2/core/accounts/PersonService.java b/src/main/java/com/stripe/service/v2/core/accounts/PersonService.java index ef109771dcf..1ba7615b0cc 100644 --- a/src/main/java/com/stripe/service/v2/core/accounts/PersonService.java +++ b/src/main/java/com/stripe/service/v2/core/accounts/PersonService.java @@ -22,21 +22,21 @@ public PersonService(StripeResponseGetter responseGetter) { super(responseGetter); } - /** Returns a list of Persons associated with an Account. */ + /** Returns a paginated list of Persons associated with an Account. */ public StripeCollection list(String accountId, PersonListParams params) throws StripeException { return list(accountId, params, (RequestOptions) null); } - /** Returns a list of Persons associated with an Account. */ + /** Returns a paginated list of Persons associated with an Account. */ public StripeCollection list(String accountId, RequestOptions options) throws StripeException { return list(accountId, (PersonListParams) null, options); } - /** Returns a list of Persons associated with an Account. */ + /** Returns a paginated list of Persons associated with an Account. */ public StripeCollection list(String accountId) throws StripeException { return list(accountId, (PersonListParams) null, (RequestOptions) null); } - /** Returns a list of Persons associated with an Account. */ + /** Returns a paginated list of Persons associated with an Account. */ public StripeCollection list( String accountId, PersonListParams params, RequestOptions options) throws StripeException { String path = String.format("/v2/core/accounts/%s/persons", ApiResource.urlEncodeId(accountId)); @@ -49,19 +49,31 @@ public StripeCollection list( options); return this.request(request, new TypeToken>() {}.getType()); } - /** Create a Person associated with an Account. */ + /** + * Create a Person. Adds an individual to an Account's identity. You can set relationship + * attributes and identity information at creation. + */ public AccountPerson create(String accountId, PersonCreateParams params) throws StripeException { return create(accountId, params, (RequestOptions) null); } - /** Create a Person associated with an Account. */ + /** + * Create a Person. Adds an individual to an Account's identity. You can set relationship + * attributes and identity information at creation. + */ public AccountPerson create(String accountId, RequestOptions options) throws StripeException { return create(accountId, (PersonCreateParams) null, options); } - /** Create a Person associated with an Account. */ + /** + * Create a Person. Adds an individual to an Account's identity. You can set relationship + * attributes and identity information at creation. + */ public AccountPerson create(String accountId) throws StripeException { return create(accountId, (PersonCreateParams) null, (RequestOptions) null); } - /** Create a Person associated with an Account. */ + /** + * Create a Person. Adds an individual to an Account's identity. You can set relationship + * attributes and identity information at creation. + */ public AccountPerson create(String accountId, PersonCreateParams params, RequestOptions options) throws StripeException { String path = String.format("/v2/core/accounts/%s/persons", ApiResource.urlEncodeId(accountId)); diff --git a/src/main/java/com/stripe/service/v2/iam/ApiKeyService.java b/src/main/java/com/stripe/service/v2/iam/ApiKeyService.java new file mode 100644 index 00000000000..cb19f38439b --- /dev/null +++ b/src/main/java/com/stripe/service/v2/iam/ApiKeyService.java @@ -0,0 +1,138 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2.iam; + +import com.google.gson.reflect.TypeToken; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.StripeCollection; +import com.stripe.model.v2.iam.ApiKey; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.v2.iam.ApiKeyCreateParams; +import com.stripe.param.v2.iam.ApiKeyListParams; +import com.stripe.param.v2.iam.ApiKeyRotateParams; +import com.stripe.param.v2.iam.ApiKeyUpdateParams; + +public final class ApiKeyService extends ApiService { + public ApiKeyService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** List all API keys of an account. */ + public StripeCollection list(ApiKeyListParams params) throws StripeException { + return list(params, (RequestOptions) null); + } + /** List all API keys of an account. */ + public StripeCollection list(RequestOptions options) throws StripeException { + return list((ApiKeyListParams) null, options); + } + /** List all API keys of an account. */ + public StripeCollection list() throws StripeException { + return list((ApiKeyListParams) null, (RequestOptions) null); + } + /** List all API keys of an account. */ + public StripeCollection list(ApiKeyListParams params, RequestOptions options) + throws StripeException { + String path = "/v2/iam/api_keys"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, new TypeToken>() {}.getType()); + } + /** Create an API key. */ + public ApiKey create(ApiKeyCreateParams params) throws StripeException { + return create(params, (RequestOptions) null); + } + /** Create an API key. */ + public ApiKey create(ApiKeyCreateParams params, RequestOptions options) throws StripeException { + String path = "/v2/iam/api_keys"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, ApiKey.class); + } + /** Retrieve an API key. */ + public ApiKey retrieve(String id) throws StripeException { + return retrieve(id, (RequestOptions) null); + } + /** Retrieve an API key. */ + public ApiKey retrieve(String id, RequestOptions options) throws StripeException { + String path = String.format("/v2/iam/api_keys/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, null, options); + return this.request(request, ApiKey.class); + } + /** Update an API key. */ + public ApiKey update(String id, ApiKeyUpdateParams params) throws StripeException { + return update(id, params, (RequestOptions) null); + } + /** Update an API key. */ + public ApiKey update(String id, RequestOptions options) throws StripeException { + return update(id, (ApiKeyUpdateParams) null, options); + } + /** Update an API key. */ + public ApiKey update(String id) throws StripeException { + return update(id, (ApiKeyUpdateParams) null, (RequestOptions) null); + } + /** Update an API key. */ + public ApiKey update(String id, ApiKeyUpdateParams params, RequestOptions options) + throws StripeException { + String path = String.format("/v2/iam/api_keys/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, ApiKey.class); + } + /** Expire an API key. */ + public ApiKey expire(String id) throws StripeException { + return expire(id, (RequestOptions) null); + } + /** Expire an API key. */ + public ApiKey expire(String id, RequestOptions options) throws StripeException { + String path = String.format("/v2/iam/api_keys/%s/expire", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, null, options); + return this.request(request, ApiKey.class); + } + /** Rotate an API key. */ + public ApiKey rotate(String id, ApiKeyRotateParams params) throws StripeException { + return rotate(id, params, (RequestOptions) null); + } + /** Rotate an API key. */ + public ApiKey rotate(String id, RequestOptions options) throws StripeException { + return rotate(id, (ApiKeyRotateParams) null, options); + } + /** Rotate an API key. */ + public ApiKey rotate(String id) throws StripeException { + return rotate(id, (ApiKeyRotateParams) null, (RequestOptions) null); + } + /** Rotate an API key. */ + public ApiKey rotate(String id, ApiKeyRotateParams params, RequestOptions options) + throws StripeException { + String path = String.format("/v2/iam/api_keys/%s/rotate", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, ApiKey.class); + } +} diff --git a/src/main/java/com/stripe/service/v2/moneymanagement/OutboundSetupIntentService.java b/src/main/java/com/stripe/service/v2/moneymanagement/OutboundSetupIntentService.java index 3f513461b0b..95a56807de4 100644 --- a/src/main/java/com/stripe/service/v2/moneymanagement/OutboundSetupIntentService.java +++ b/src/main/java/com/stripe/service/v2/moneymanagement/OutboundSetupIntentService.java @@ -3,6 +3,7 @@ import com.google.gson.reflect.TypeToken; import com.stripe.exception.BlockedByStripeException; +import com.stripe.exception.ControlledByAlternateResourceException; import com.stripe.exception.InvalidPayoutMethodException; import com.stripe.exception.QuotaExceededException; import com.stripe.exception.StripeException; @@ -54,25 +55,25 @@ public StripeCollection list( /** Create an OutboundSetupIntent object. */ public OutboundSetupIntent create(OutboundSetupIntentCreateParams params) throws StripeException, BlockedByStripeException, InvalidPayoutMethodException, - QuotaExceededException { + QuotaExceededException, ControlledByAlternateResourceException { return create(params, (RequestOptions) null); } /** Create an OutboundSetupIntent object. */ public OutboundSetupIntent create(RequestOptions options) throws StripeException, BlockedByStripeException, InvalidPayoutMethodException, - QuotaExceededException { + QuotaExceededException, ControlledByAlternateResourceException { return create((OutboundSetupIntentCreateParams) null, options); } /** Create an OutboundSetupIntent object. */ public OutboundSetupIntent create() throws StripeException, BlockedByStripeException, InvalidPayoutMethodException, - QuotaExceededException { + QuotaExceededException, ControlledByAlternateResourceException { return create((OutboundSetupIntentCreateParams) null, (RequestOptions) null); } /** Create an OutboundSetupIntent object. */ public OutboundSetupIntent create(OutboundSetupIntentCreateParams params, RequestOptions options) throws StripeException, BlockedByStripeException, InvalidPayoutMethodException, - QuotaExceededException { + QuotaExceededException, ControlledByAlternateResourceException { String path = "/v2/money_management/outbound_setup_intents"; ApiRequest request = new ApiRequest( @@ -99,26 +100,26 @@ public OutboundSetupIntent retrieve(String id, RequestOptions options) throws St /** Update an OutboundSetupIntent object. */ public OutboundSetupIntent update(String id, OutboundSetupIntentUpdateParams params) throws StripeException, QuotaExceededException, BlockedByStripeException, - InvalidPayoutMethodException { + InvalidPayoutMethodException, ControlledByAlternateResourceException { return update(id, params, (RequestOptions) null); } /** Update an OutboundSetupIntent object. */ public OutboundSetupIntent update(String id, RequestOptions options) throws StripeException, QuotaExceededException, BlockedByStripeException, - InvalidPayoutMethodException { + InvalidPayoutMethodException, ControlledByAlternateResourceException { return update(id, (OutboundSetupIntentUpdateParams) null, options); } /** Update an OutboundSetupIntent object. */ public OutboundSetupIntent update(String id) throws StripeException, QuotaExceededException, BlockedByStripeException, - InvalidPayoutMethodException { + InvalidPayoutMethodException, ControlledByAlternateResourceException { return update(id, (OutboundSetupIntentUpdateParams) null, (RequestOptions) null); } /** Update an OutboundSetupIntent object. */ public OutboundSetupIntent update( String id, OutboundSetupIntentUpdateParams params, RequestOptions options) throws StripeException, QuotaExceededException, BlockedByStripeException, - InvalidPayoutMethodException { + InvalidPayoutMethodException, ControlledByAlternateResourceException { String path = String.format( "/v2/money_management/outbound_setup_intents/%s", ApiResource.urlEncodeId(id)); diff --git a/src/main/java/com/stripe/service/v2/moneymanagement/PayoutMethodService.java b/src/main/java/com/stripe/service/v2/moneymanagement/PayoutMethodService.java index 7887d42b156..e9ae637ca52 100644 --- a/src/main/java/com/stripe/service/v2/moneymanagement/PayoutMethodService.java +++ b/src/main/java/com/stripe/service/v2/moneymanagement/PayoutMethodService.java @@ -2,6 +2,7 @@ package com.stripe.service.v2.moneymanagement; import com.google.gson.reflect.TypeToken; +import com.stripe.exception.ControlledByAlternateResourceException; import com.stripe.exception.ControlledByDashboardException; import com.stripe.exception.InvalidPayoutMethodException; import com.stripe.exception.StripeException; @@ -64,7 +65,8 @@ public PayoutMethod retrieve(String id, RequestOptions options) * appear in the payout method list. */ public PayoutMethod archive(String id) - throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException { + throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException, + ControlledByAlternateResourceException { return archive(id, (RequestOptions) null); } /** @@ -72,7 +74,8 @@ public PayoutMethod archive(String id) * appear in the payout method list. */ public PayoutMethod archive(String id, RequestOptions options) - throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException { + throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException, + ControlledByAlternateResourceException { String path = String.format( "/v2/money_management/payout_methods/%s/archive", ApiResource.urlEncodeId(id)); @@ -82,12 +85,14 @@ public PayoutMethod archive(String id, RequestOptions options) } /** Unarchive an PayoutMethod object. */ public PayoutMethod unarchive(String id) - throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException { + throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException, + ControlledByAlternateResourceException { return unarchive(id, (RequestOptions) null); } /** Unarchive an PayoutMethod object. */ public PayoutMethod unarchive(String id, RequestOptions options) - throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException { + throws StripeException, ControlledByDashboardException, InvalidPayoutMethodException, + ControlledByAlternateResourceException { String path = String.format( "/v2/money_management/payout_methods/%s/unarchive", ApiResource.urlEncodeId(id)); diff --git a/src/main/java/com/stripe/service/v2/payments/SettlementAllocationIntentService.java b/src/main/java/com/stripe/service/v2/payments/SettlementAllocationIntentService.java new file mode 100644 index 00000000000..33b28ac2496 --- /dev/null +++ b/src/main/java/com/stripe/service/v2/payments/SettlementAllocationIntentService.java @@ -0,0 +1,157 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2.payments; + +import com.stripe.exception.StripeException; +import com.stripe.model.v2.payments.SettlementAllocationIntent; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.v2.payments.SettlementAllocationIntentCreateParams; +import com.stripe.param.v2.payments.SettlementAllocationIntentUpdateParams; + +public final class SettlementAllocationIntentService extends ApiService { + public SettlementAllocationIntentService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** Create a new SettlementAllocationIntent. */ + public SettlementAllocationIntent create(SettlementAllocationIntentCreateParams params) + throws StripeException { + return create(params, (RequestOptions) null); + } + /** Create a new SettlementAllocationIntent. */ + public SettlementAllocationIntent create( + SettlementAllocationIntentCreateParams params, RequestOptions options) + throws StripeException { + String path = "/v2/payments/settlement_allocation_intents"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, SettlementAllocationIntent.class); + } + /** Retrieve an existing SettlementAllocationIntent. */ + public SettlementAllocationIntent retrieve(String id) throws StripeException { + return retrieve(id, (RequestOptions) null); + } + /** Retrieve an existing SettlementAllocationIntent. */ + public SettlementAllocationIntent retrieve(String id, RequestOptions options) + throws StripeException { + String path = + String.format("/v2/payments/settlement_allocation_intents/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, null, options); + return this.request(request, SettlementAllocationIntent.class); + } + /** + * Updates SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending}, {@code submitted} and {@code errored} can be updated. Only amount and reference + * fields can be updated for a SettlementAllocationIntent and at least one must be present. + * Updating an {@code amount} moves the SettlementAllocationIntent {@code pending} status and + * updating the {@code reference} for {@code errored} SettlementAllocationIntent moves it to + * {@code submitted}. + */ + public SettlementAllocationIntent update(String id, SettlementAllocationIntentUpdateParams params) + throws StripeException { + return update(id, params, (RequestOptions) null); + } + /** + * Updates SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending}, {@code submitted} and {@code errored} can be updated. Only amount and reference + * fields can be updated for a SettlementAllocationIntent and at least one must be present. + * Updating an {@code amount} moves the SettlementAllocationIntent {@code pending} status and + * updating the {@code reference} for {@code errored} SettlementAllocationIntent moves it to + * {@code submitted}. + */ + public SettlementAllocationIntent update(String id, RequestOptions options) + throws StripeException { + return update(id, (SettlementAllocationIntentUpdateParams) null, options); + } + /** + * Updates SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending}, {@code submitted} and {@code errored} can be updated. Only amount and reference + * fields can be updated for a SettlementAllocationIntent and at least one must be present. + * Updating an {@code amount} moves the SettlementAllocationIntent {@code pending} status and + * updating the {@code reference} for {@code errored} SettlementAllocationIntent moves it to + * {@code submitted}. + */ + public SettlementAllocationIntent update(String id) throws StripeException { + return update(id, (SettlementAllocationIntentUpdateParams) null, (RequestOptions) null); + } + /** + * Updates SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending}, {@code submitted} and {@code errored} can be updated. Only amount and reference + * fields can be updated for a SettlementAllocationIntent and at least one must be present. + * Updating an {@code amount} moves the SettlementAllocationIntent {@code pending} status and + * updating the {@code reference} for {@code errored} SettlementAllocationIntent moves it to + * {@code submitted}. + */ + public SettlementAllocationIntent update( + String id, SettlementAllocationIntentUpdateParams params, RequestOptions options) + throws StripeException { + String path = + String.format("/v2/payments/settlement_allocation_intents/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, SettlementAllocationIntent.class); + } + /** + * Cancels an existing SettlementAllocationIntent. Only SettlementAllocationIntent with status + * {@code pending}, {@code submitted} and {@code errored} can be {@code canceled}. + */ + public SettlementAllocationIntent cancel(String id) throws StripeException { + return cancel(id, (RequestOptions) null); + } + /** + * Cancels an existing SettlementAllocationIntent. Only SettlementAllocationIntent with status + * {@code pending}, {@code submitted} and {@code errored} can be {@code canceled}. + */ + public SettlementAllocationIntent cancel(String id, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v2/payments/settlement_allocation_intents/%s/cancel", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, null, options); + return this.request(request, SettlementAllocationIntent.class); + } + /** + * Submits a SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending} can be {@code submitted}. The net sum of SettlementAllocationIntentSplit amount must + * be equal to SettlementAllocationIntent amount to be eligible to be submitted. + */ + public SettlementAllocationIntent submit(String id) throws StripeException { + return submit(id, (RequestOptions) null); + } + /** + * Submits a SettlementAllocationIntent. Only SettlementAllocationIntent with status {@code + * pending} can be {@code submitted}. The net sum of SettlementAllocationIntentSplit amount must + * be equal to SettlementAllocationIntent amount to be eligible to be submitted. + */ + public SettlementAllocationIntent submit(String id, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v2/payments/settlement_allocation_intents/%s/submit", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, null, options); + return this.request(request, SettlementAllocationIntent.class); + } + + public com.stripe.service.v2.payments.settlementallocationintents.SplitService splits() { + return new com.stripe.service.v2.payments.settlementallocationintents.SplitService( + this.getResponseGetter()); + } +} diff --git a/src/main/java/com/stripe/service/v2/payments/settlementallocationintents/SplitService.java b/src/main/java/com/stripe/service/v2/payments/settlementallocationintents/SplitService.java new file mode 100644 index 00000000000..91fd3348ac9 --- /dev/null +++ b/src/main/java/com/stripe/service/v2/payments/settlementallocationintents/SplitService.java @@ -0,0 +1,76 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2.payments.settlementallocationintents; + +import com.stripe.exception.StripeException; +import com.stripe.model.v2.payments.SettlementAllocationIntentSplit; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.v2.payments.settlementallocationintents.SplitCreateParams; + +public final class SplitService extends ApiService { + public SplitService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** Create SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit create( + String settlementAllocationIntentId, SplitCreateParams params) throws StripeException { + return create(settlementAllocationIntentId, params, (RequestOptions) null); + } + /** Create SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit create( + String settlementAllocationIntentId, SplitCreateParams params, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v2/payments/settlement_allocation_intents/%s/splits", + ApiResource.urlEncodeId(settlementAllocationIntentId)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, SettlementAllocationIntentSplit.class); + } + /** Retrieve SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit retrieve(String settlementAllocationIntentId, String id) + throws StripeException { + return retrieve(settlementAllocationIntentId, id, (RequestOptions) null); + } + /** Retrieve SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit retrieve( + String settlementAllocationIntentId, String id, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v2/payments/settlement_allocation_intents/%s/splits/%s", + ApiResource.urlEncodeId(settlementAllocationIntentId), ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, null, options); + return this.request(request, SettlementAllocationIntentSplit.class); + } + /** Cancel SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit cancel(String settlementAllocationIntentId, String id) + throws StripeException { + return cancel(settlementAllocationIntentId, id, (RequestOptions) null); + } + /** Cancel SettlementAllocationIntentSplit API. */ + public SettlementAllocationIntentSplit cancel( + String settlementAllocationIntentId, String id, RequestOptions options) + throws StripeException { + String path = + String.format( + "/v2/payments/settlement_allocation_intents/%s/splits/%s/cancel", + ApiResource.urlEncodeId(settlementAllocationIntentId), ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, null, options); + return this.request(request, SettlementAllocationIntentSplit.class); + } +} diff --git a/src/main/java/com/stripe/service/v2/tax/ManualRuleService.java b/src/main/java/com/stripe/service/v2/tax/ManualRuleService.java new file mode 100644 index 00000000000..f13bd99a0f6 --- /dev/null +++ b/src/main/java/com/stripe/service/v2/tax/ManualRuleService.java @@ -0,0 +1,105 @@ +// File generated from our OpenAPI spec +package com.stripe.service.v2.tax; + +import com.google.gson.reflect.TypeToken; +import com.stripe.exception.StripeException; +import com.stripe.model.v2.StripeCollection; +import com.stripe.model.v2.tax.ManualRule; +import com.stripe.net.ApiRequest; +import com.stripe.net.ApiRequestParams; +import com.stripe.net.ApiResource; +import com.stripe.net.ApiService; +import com.stripe.net.BaseAddress; +import com.stripe.net.RequestOptions; +import com.stripe.net.StripeResponseGetter; +import com.stripe.param.v2.tax.ManualRuleCreateParams; +import com.stripe.param.v2.tax.ManualRuleListParams; +import com.stripe.param.v2.tax.ManualRuleUpdateParams; + +public final class ManualRuleService extends ApiService { + public ManualRuleService(StripeResponseGetter responseGetter) { + super(responseGetter); + } + + /** List all ManualRule objects. */ + public StripeCollection list(ManualRuleListParams params) throws StripeException { + return list(params, (RequestOptions) null); + } + /** List all ManualRule objects. */ + public StripeCollection list(RequestOptions options) throws StripeException { + return list((ManualRuleListParams) null, options); + } + /** List all ManualRule objects. */ + public StripeCollection list() throws StripeException { + return list((ManualRuleListParams) null, (RequestOptions) null); + } + /** List all ManualRule objects. */ + public StripeCollection list(ManualRuleListParams params, RequestOptions options) + throws StripeException { + String path = "/v2/tax/manual_rules"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, new TypeToken>() {}.getType()); + } + /** Creates a ManualRule object. */ + public ManualRule create(ManualRuleCreateParams params) throws StripeException { + return create(params, (RequestOptions) null); + } + /** Creates a ManualRule object. */ + public ManualRule create(ManualRuleCreateParams params, RequestOptions options) + throws StripeException { + String path = "/v2/tax/manual_rules"; + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, ManualRule.class); + } + /** Retrieves a ManualRule object by ID. */ + public ManualRule retrieve(String id) throws StripeException { + return retrieve(id, (RequestOptions) null); + } + /** Retrieves a ManualRule object by ID. */ + public ManualRule retrieve(String id, RequestOptions options) throws StripeException { + String path = String.format("/v2/tax/manual_rules/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, null, options); + return this.request(request, ManualRule.class); + } + /** Updates the Tax configuration for a ManualRule object. */ + public ManualRule update(String id, ManualRuleUpdateParams params) throws StripeException { + return update(id, params, (RequestOptions) null); + } + /** Updates the Tax configuration for a ManualRule object. */ + public ManualRule update(String id, ManualRuleUpdateParams params, RequestOptions options) + throws StripeException { + String path = String.format("/v2/tax/manual_rules/%s", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + path, + ApiRequestParams.paramsToMap(params), + options); + return this.request(request, ManualRule.class); + } + /** Deactivates a ManualRule object. */ + public ManualRule deactivate(String id) throws StripeException { + return deactivate(id, (RequestOptions) null); + } + /** Deactivates a ManualRule object. */ + public ManualRule deactivate(String id, RequestOptions options) throws StripeException { + String path = String.format("/v2/tax/manual_rules/%s/deactivate", ApiResource.urlEncodeId(id)); + ApiRequest request = + new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, null, options); + return this.request(request, ManualRule.class); + } +} diff --git a/src/test/java/com/stripe/functional/GeneratedExamples.java b/src/test/java/com/stripe/functional/GeneratedExamples.java index 1b41ccd535f..6f26b5f025b 100644 --- a/src/test/java/com/stripe/functional/GeneratedExamples.java +++ b/src/test/java/com/stripe/functional/GeneratedExamples.java @@ -25071,14 +25071,9 @@ public void testV2BillingIntentPostServices() throws StripeException { .build()) .setDeactivate( com.stripe.param.v2.billing.IntentCreateParams.Action.Deactivate.builder() - .setBillingDetails( + .setCollectAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Deactivate - .BillingDetails.builder() - .setProrationBehavior( - com.stripe.param.v2.billing.IntentCreateParams.Action - .Deactivate.BillingDetails.ProrationBehavior - .PRORATED_ADJUSTMENT) - .build()) + .CollectAt.NEXT_BILLING_DATE) .setEffectiveAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Deactivate .EffectiveAt.builder() @@ -25090,6 +25085,39 @@ public void testV2BillingIntentPostServices() throws StripeException { .setPricingPlanSubscriptionDetails( com.stripe.param.v2.billing.IntentCreateParams.Action.Deactivate .PricingPlanSubscriptionDetails.builder() + .setOverrides( + com.stripe.param.v2.billing.IntentCreateParams.Action + .Deactivate.PricingPlanSubscriptionDetails.Overrides + .builder() + .addPartialPeriodBehavior( + com.stripe.param.v2.billing.IntentCreateParams + .Action.Deactivate + .PricingPlanSubscriptionDetails.Overrides + .PartialPeriodBehavior.builder() + .setType( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Deactivate + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.Type + .LICENSE_FEE) + .setLicenseFee( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Deactivate + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee.builder() + .setCreditProrationBehavior( + com.stripe.param.v2.billing + .IntentCreateParams.Action + .Deactivate + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee + .CreditProrationBehavior + .PRORATED) + .build()) + .build()) + .build()) .setPricingPlanSubscription("pricing_plan_subscription") .build()) .setType( @@ -25098,13 +25126,9 @@ public void testV2BillingIntentPostServices() throws StripeException { .build()) .setModify( com.stripe.param.v2.billing.IntentCreateParams.Action.Modify.builder() - .setBillingDetails( + .setCollectAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Modify - .BillingDetails.builder() - .setProrationBehavior( - com.stripe.param.v2.billing.IntentCreateParams.Action.Modify - .BillingDetails.ProrationBehavior.PRORATED_ADJUSTMENT) - .build()) + .CollectAt.NEXT_BILLING_DATE) .setEffectiveAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Modify .EffectiveAt.builder() @@ -25126,6 +25150,45 @@ public void testV2BillingIntentPostServices() throws StripeException { .build()) .setNewPricingPlan("new_pricing_plan") .setNewPricingPlanVersion("new_pricing_plan_version") + .setOverrides( + com.stripe.param.v2.billing.IntentCreateParams.Action.Modify + .PricingPlanSubscriptionDetails.Overrides.builder() + .addPartialPeriodBehavior( + com.stripe.param.v2.billing.IntentCreateParams + .Action.Modify.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.builder() + .setType( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Modify + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.Type + .LICENSE_FEE) + .setLicenseFee( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Modify + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee.builder() + .setCreditProrationBehavior( + com.stripe.param.v2.billing + .IntentCreateParams.Action + .Modify + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee + .CreditProrationBehavior + .PRORATED) + .setDebitProrationBehavior( + com.stripe.param.v2.billing + .IntentCreateParams.Action + .Modify + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee + .DebitProrationBehavior.NONE) + .build()) + .build()) + .build()) .setPricingPlanSubscription("pricing_plan_subscription") .build()) .setType( @@ -25141,14 +25204,9 @@ public void testV2BillingIntentPostServices() throws StripeException { .build()) .setSubscribe( com.stripe.param.v2.billing.IntentCreateParams.Action.Subscribe.builder() - .setBillingDetails( + .setCollectAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Subscribe - .BillingDetails.builder() - .setProrationBehavior( - com.stripe.param.v2.billing.IntentCreateParams.Action - .Subscribe.BillingDetails.ProrationBehavior - .PRORATED_ADJUSTMENT) - .build()) + .CollectAt.NEXT_BILLING_DATE) .setEffectiveAt( com.stripe.param.v2.billing.IntentCreateParams.Action.Subscribe .EffectiveAt.builder() @@ -25173,6 +25231,37 @@ public void testV2BillingIntentPostServices() throws StripeException { .setPricingPlanComponent("pricing_plan_component") .build()) .putMetadata("key", "metadata") + .setOverrides( + com.stripe.param.v2.billing.IntentCreateParams.Action + .Subscribe.PricingPlanSubscriptionDetails.Overrides + .builder() + .addPartialPeriodBehavior( + com.stripe.param.v2.billing.IntentCreateParams + .Action.Subscribe.PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.builder() + .setType( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Subscribe + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior.Type + .LICENSE_FEE) + .setLicenseFee( + com.stripe.param.v2.billing + .IntentCreateParams.Action.Subscribe + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee.builder() + .setDebitProrationBehavior( + com.stripe.param.v2.billing + .IntentCreateParams.Action + .Subscribe + .PricingPlanSubscriptionDetails + .Overrides.PartialPeriodBehavior + .LicenseFee + .DebitProrationBehavior.NONE) + .build()) + .build()) + .build()) .setPricingPlan("pricing_plan") .setPricingPlanVersion("pricing_plan_version") .build()) @@ -27234,635 +27323,7 @@ public void testV2CoreAccountTokenPostServices() throws StripeException { StripeClient client = new StripeClient(networkSpy); com.stripe.param.v2.core.AccountTokenCreateParams params = - com.stripe.param.v2.core.AccountTokenCreateParams.builder() - .setIdentity( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity.builder() - .setAttestations( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity.Attestations - .builder() - .setDirectorshipDeclaration( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.DirectorshipDeclaration.builder() - .setAttested(true) - .build()) - .setOwnershipDeclaration( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.OwnershipDeclaration.builder() - .setAttested(true) - .build()) - .setPersonsProvided( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.PersonsProvided.builder() - .setDirectors(true) - .setExecutives(true) - .setOwners(true) - .setOwnershipExemptionReason( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.PersonsProvided.OwnershipExemptionReason - .QUALIFIED_ENTITY_EXCEEDS_OWNERSHIP_THRESHOLD) - .build()) - .setRepresentativeDeclaration( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.RepresentativeDeclaration.builder() - .setAttested(true) - .build()) - .setTermsOfService( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.TermsOfService.builder() - .setAccount( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.TermsOfService.Account.builder() - .setShownAndAccepted(true) - .build()) - .setCardCreator( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.TermsOfService.CardCreator.builder() - .setCommercial( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Attestations.TermsOfService - .CardCreator.Commercial.builder() - .setAccountHolder( - com.stripe.param.v2.core - .AccountTokenCreateParams.Identity - .Attestations.TermsOfService.CardCreator - .Commercial.AccountHolder.builder() - .setShownAndAccepted(true) - .build()) - .setCeltic( - com.stripe.param.v2.core - .AccountTokenCreateParams.Identity - .Attestations.TermsOfService.CardCreator - .Commercial.Celtic.builder() - .setApplePay( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.Celtic.ApplePay - .builder() - .setShownAndAccepted(true) - .build()) - .setChargeCard( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.Celtic.ChargeCard - .builder() - .setBankTerms( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .Celtic.ChargeCard - .BankTerms.builder() - .setShownAndAccepted( - true) - .build()) - .setPlatform( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .Celtic.ChargeCard - .Platform.builder() - .setShownAndAccepted( - true) - .build()) - .build()) - .setSpendCard( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.Celtic.SpendCard - .builder() - .setBankTerms( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .Celtic.SpendCard - .BankTerms.builder() - .setShownAndAccepted( - true) - .build()) - .setFinancingDisclosures( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .Celtic.SpendCard - .FinancingDisclosures - .builder() - .setShownAndAccepted( - true) - .build()) - .setPlatform( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .Celtic.SpendCard - .Platform.builder() - .setShownAndAccepted( - true) - .build()) - .build()) - .build()) - .setCrossRiverBank( - com.stripe.param.v2.core - .AccountTokenCreateParams.Identity - .Attestations.TermsOfService.CardCreator - .Commercial.CrossRiverBank.builder() - .setApplePay( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.CrossRiverBank - .ApplePay.builder() - .setShownAndAccepted(true) - .build()) - .setChargeCard( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.CrossRiverBank - .ChargeCard.builder() - .setBankTerms( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .CrossRiverBank - .ChargeCard.BankTerms - .builder() - .setShownAndAccepted( - true) - .build()) - .setFinancingDisclosures( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .CrossRiverBank - .ChargeCard - .FinancingDisclosures - .builder() - .setShownAndAccepted( - true) - .build()) - .setPlatform( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .CrossRiverBank - .ChargeCard.Platform - .builder() - .setShownAndAccepted( - true) - .build()) - .build()) - .setSpendCard( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService.CardCreator - .Commercial.CrossRiverBank - .SpendCard.builder() - .setBankTerms( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .CrossRiverBank - .SpendCard.BankTerms - .builder() - .setShownAndAccepted( - true) - .build()) - .setFinancingDisclosures( - com.stripe.param.v2.core - .AccountTokenCreateParams - .Identity.Attestations - .TermsOfService - .CardCreator.Commercial - .CrossRiverBank - .SpendCard - .FinancingDisclosures - .builder() - .setShownAndAccepted( - true) - .build()) - .build()) - .build()) - .build()) - .build()) - .setCryptoStorer( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.TermsOfService.CryptoStorer.builder() - .setShownAndAccepted(true) - .build()) - .setStorer( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Attestations.TermsOfService.Storer.builder() - .setShownAndAccepted(true) - .build()) - .build()) - .build()) - .setBusinessDetails( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity.BusinessDetails - .builder() - .setAddress( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Address.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .setAnnualRevenue( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.AnnualRevenue.builder() - .setAmount( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.AnnualRevenue.Amount.builder() - .setValue(111972721L) - .setCurrency("usd") - .build()) - .setFiscalYearEnd("fiscal_year_end") - .build()) - .setComplianceScreeningDescription("compliance_screening_description") - .setDocuments( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.builder() - .setBankAccountOwnershipVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents - .BankAccountOwnershipVerification.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .BankAccountOwnershipVerification.Type.FILES) - .build()) - .setCompanyLicense( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.CompanyLicense.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .CompanyLicense.Type.FILES) - .build()) - .setCompanyMemorandumOfAssociation( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents - .CompanyMemorandumOfAssociation.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .CompanyMemorandumOfAssociation.Type.FILES) - .build()) - .setCompanyMinisterialDecree( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.CompanyMinisterialDecree - .builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .CompanyMinisterialDecree.Type.FILES) - .build()) - .setCompanyRegistrationVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents - .CompanyRegistrationVerification.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .CompanyRegistrationVerification.Type.FILES) - .build()) - .setCompanyTaxIdVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.CompanyTaxIdVerification - .builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .CompanyTaxIdVerification.Type.FILES) - .build()) - .setPrimaryVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.PrimaryVerification.builder() - .setFrontBack( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .PrimaryVerification.FrontBack.builder() - .setBack("back") - .setFront("front") - .build()) - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .PrimaryVerification.Type.FRONT_BACK) - .build()) - .setProofOfAddress( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.ProofOfAddress.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .ProofOfAddress.Type.FILES) - .build()) - .setProofOfRegistration( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents.ProofOfRegistration.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .ProofOfRegistration.Type.FILES) - .build()) - .setProofOfUltimateBeneficialOwnership( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Documents - .ProofOfUltimateBeneficialOwnership.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.BusinessDetails.Documents - .ProofOfUltimateBeneficialOwnership.Type.FILES) - .build()) - .build()) - .setEstimatedWorkerCount(884794319L) - .addIdNumber( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.IdNumber.builder() - .setRegistrar("registrar") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.IdNumber.Type.TH_PRN) - .setValue("value") - .build()) - .setMonthlyEstimatedRevenue( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.MonthlyEstimatedRevenue.builder() - .setAmount( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.MonthlyEstimatedRevenue.Amount - .builder() - .setValue(111972721L) - .setCurrency("usd") - .build()) - .build()) - .setPhone("phone") - .setRegisteredName("registered_name") - .setScriptAddresses( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptAddresses.builder() - .setKana( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptAddresses.Kana.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .setKanji( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptAddresses.Kanji.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .build()) - .setScriptNames( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptNames.builder() - .setKana( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptNames.Kana.builder() - .setRegisteredName("registered_name") - .build()) - .setKanji( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.ScriptNames.Kanji.builder() - .setRegisteredName("registered_name") - .build()) - .build()) - .setStructure( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .BusinessDetails.Structure.PUBLIC_LISTED_CORPORATION) - .build()) - .setEntityType( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity.EntityType - .INDIVIDUAL) - .setIndividual( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity.Individual - .builder() - .addAdditionalAddress( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.AdditionalAddress.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setPurpose( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.AdditionalAddress.Purpose.REGISTERED) - .setState("state") - .setTown("town") - .build()) - .addAdditionalName( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.AdditionalName.builder() - .setFullName("full_name") - .setGivenName("given_name") - .setPurpose( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.AdditionalName.Purpose.ALIAS) - .setSurname("surname") - .build()) - .setAddress( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Address.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .setDateOfBirth( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.DateOfBirth.builder() - .setDay(99228L) - .setMonth(104080000L) - .setYear(3704893L) - .build()) - .setDocuments( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.builder() - .setCompanyAuthorization( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.CompanyAuthorization.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents - .CompanyAuthorization.Type.FILES) - .build()) - .setPassport( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.Passport.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents.Passport.Type - .FILES) - .build()) - .setPrimaryVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.PrimaryVerification.builder() - .setFrontBack( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents - .PrimaryVerification.FrontBack.builder() - .setBack("back") - .setFront("front") - .build()) - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents - .PrimaryVerification.Type.FRONT_BACK) - .build()) - .setSecondaryVerification( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.SecondaryVerification.builder() - .setFrontBack( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents - .SecondaryVerification.FrontBack.builder() - .setBack("back") - .setFront("front") - .build()) - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents - .SecondaryVerification.Type.FRONT_BACK) - .build()) - .setVisa( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Documents.Visa.builder() - .addFile("files") - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams - .Identity.Individual.Documents.Visa.Type.FILES) - .build()) - .build()) - .setEmail("email") - .setGivenName("given_name") - .addIdNumber( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.IdNumber.builder() - .setType( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.IdNumber.Type.TH_LC) - .setValue("value") - .build()) - .setLegalGender( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.LegalGender.MALE) - .putMetadata("key", "metadata") - .addNationality("nationalities") - .setPhone("phone") - .setPoliticalExposure( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.PoliticalExposure.NONE) - .setRelationship( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.Relationship.builder() - .setDirector(true) - .setExecutive(true) - .setOwner(true) - .setPercentOwnership("percent_ownership") - .setTitle("title") - .build()) - .setScriptAddresses( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptAddresses.builder() - .setKana( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptAddresses.Kana.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .setKanji( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptAddresses.Kanji.builder() - .setCity("city") - .setCountry("country") - .setLine1("line1") - .setLine2("line2") - .setPostalCode("postal_code") - .setState("state") - .setTown("town") - .build()) - .build()) - .setScriptNames( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptNames.builder() - .setKana( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptNames.Kana.builder() - .setGivenName("given_name") - .setSurname("surname") - .build()) - .setKanji( - com.stripe.param.v2.core.AccountTokenCreateParams.Identity - .Individual.ScriptNames.Kanji.builder() - .setGivenName("given_name") - .setSurname("surname") - .build()) - .build()) - .setSurname("surname") - .build()) - .build()) - .build(); + com.stripe.param.v2.core.AccountTokenCreateParams.builder().build(); com.stripe.model.v2.core.AccountToken accountToken = client.v2().core().accountTokens().create(params); @@ -28536,6 +27997,142 @@ public void testV2CoreVaultUsBankAccountPost5Services() throws StripeException { null); } + @Test + public void testV2IamApiKeyGetServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/iam/api_keys", + null, + null, + new TypeToken< + com.stripe.model.v2.StripeCollection>() {}.getType(), + "{\"data\":[{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}],\"next_page_url\":null,\"previous_page_url\":null}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.iam.ApiKeyListParams params = + com.stripe.param.v2.iam.ApiKeyListParams.builder().build(); + + com.stripe.model.v2.StripeCollection stripeCollection = + client.v2().iam().apiKeys().list(params); + assertNotNull(stripeCollection); + verifyRequest( + BaseAddress.API, ApiResource.RequestMethod.GET, "/v2/iam/api_keys", params.toMap(), null); + } + + @Test + public void testV2IamApiKeyPostServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys", + null, + null, + com.stripe.model.v2.iam.ApiKey.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.iam.ApiKeyCreateParams params = + com.stripe.param.v2.iam.ApiKeyCreateParams.builder() + .setType(com.stripe.param.v2.iam.ApiKeyCreateParams.Type.PUBLISHABLE_KEY) + .build(); + + com.stripe.model.v2.iam.ApiKey apiKey = client.v2().iam().apiKeys().create(params); + assertNotNull(apiKey); + verifyRequest( + BaseAddress.API, ApiResource.RequestMethod.POST, "/v2/iam/api_keys", params.toMap(), null); + } + + @Test + public void testV2IamApiKeyGet2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/iam/api_keys/id_123", + null, + null, + com.stripe.model.v2.iam.ApiKey.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.iam.ApiKey apiKey = client.v2().iam().apiKeys().retrieve("id_123"); + assertNotNull(apiKey); + verifyRequest( + BaseAddress.API, ApiResource.RequestMethod.GET, "/v2/iam/api_keys/id_123", null, null); + } + + @Test + public void testV2IamApiKeyPost2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123", + null, + null, + com.stripe.model.v2.iam.ApiKey.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.iam.ApiKeyUpdateParams params = + com.stripe.param.v2.iam.ApiKeyUpdateParams.builder().build(); + + com.stripe.model.v2.iam.ApiKey apiKey = client.v2().iam().apiKeys().update("id_123", params); + assertNotNull(apiKey); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123", + params.toMap(), + null); + } + + @Test + public void testV2IamApiKeyPost3Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123/expire", + null, + null, + com.stripe.model.v2.iam.ApiKey.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.iam.ApiKey apiKey = client.v2().iam().apiKeys().expire("id_123"); + assertNotNull(apiKey); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123/expire", + null, + null); + } + + @Test + public void testV2IamApiKeyPost4Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123/rotate", + null, + null, + com.stripe.model.v2.iam.ApiKey.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"ip_allowlist\":[\"ip_allowlist\"],\"object\":\"v2.iam.api_key\",\"status\":\"active\",\"type\":\"publishable_key\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.iam.ApiKeyRotateParams params = + com.stripe.param.v2.iam.ApiKeyRotateParams.builder().build(); + + com.stripe.model.v2.iam.ApiKey apiKey = client.v2().iam().apiKeys().rotate("id_123", params); + assertNotNull(apiKey); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/iam/api_keys/id_123/rotate", + params.toMap(), + null); + } + @Test public void testV2MoneyManagementAdjustmentGetServices() throws StripeException { stubRequest( @@ -29963,6 +29560,234 @@ public void testV2PaymentsOffSessionPaymentPost3Services() throws StripeExceptio null); } + @Test + public void testV2PaymentsSettlementAllocationIntentPostServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntent.class, + "{\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"expected_settlement_date\":\"1970-01-22T14:14:13.629Z\",\"financial_account\":\"financial_account\",\"id\":\"obj_123\",\"linked_credits\":[\"linked_credits\"],\"object\":\"v2.payments.settlement_allocation_intent\",\"reference\":\"reference\",\"status\":\"canceled\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.payments.SettlementAllocationIntentCreateParams params = + com.stripe.param.v2.payments.SettlementAllocationIntentCreateParams.builder() + .setAmount( + com.stripe.param.v2.payments.SettlementAllocationIntentCreateParams.Amount.builder() + .setValue(111972721L) + .setCurrency("usd") + .build()) + .setExpectedSettlementDate(Instant.parse("1970-01-22T14:14:13.629Z")) + .setFinancialAccount("financial_account") + .setReference("reference") + .build(); + + com.stripe.model.v2.payments.SettlementAllocationIntent settlementAllocationIntent = + client.v2().payments().settlementAllocationIntents().create(params); + assertNotNull(settlementAllocationIntent); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents", + params.toMap(), + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentGetServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/payments/settlement_allocation_intents/id_123", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntent.class, + "{\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"expected_settlement_date\":\"1970-01-22T14:14:13.629Z\",\"financial_account\":\"financial_account\",\"id\":\"obj_123\",\"linked_credits\":[\"linked_credits\"],\"object\":\"v2.payments.settlement_allocation_intent\",\"reference\":\"reference\",\"status\":\"canceled\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.payments.SettlementAllocationIntent settlementAllocationIntent = + client.v2().payments().settlementAllocationIntents().retrieve("id_123"); + assertNotNull(settlementAllocationIntent); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/payments/settlement_allocation_intents/id_123", + null, + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentPost2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntent.class, + "{\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"expected_settlement_date\":\"1970-01-22T14:14:13.629Z\",\"financial_account\":\"financial_account\",\"id\":\"obj_123\",\"linked_credits\":[\"linked_credits\"],\"object\":\"v2.payments.settlement_allocation_intent\",\"reference\":\"reference\",\"status\":\"canceled\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.payments.SettlementAllocationIntentUpdateParams params = + com.stripe.param.v2.payments.SettlementAllocationIntentUpdateParams.builder().build(); + + com.stripe.model.v2.payments.SettlementAllocationIntent settlementAllocationIntent = + client.v2().payments().settlementAllocationIntents().update("id_123", params); + assertNotNull(settlementAllocationIntent); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123", + params.toMap(), + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentPost3Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123/cancel", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntent.class, + "{\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"expected_settlement_date\":\"1970-01-22T14:14:13.629Z\",\"financial_account\":\"financial_account\",\"id\":\"obj_123\",\"linked_credits\":[\"linked_credits\"],\"object\":\"v2.payments.settlement_allocation_intent\",\"reference\":\"reference\",\"status\":\"canceled\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.payments.SettlementAllocationIntent settlementAllocationIntent = + client.v2().payments().settlementAllocationIntents().cancel("id_123"); + assertNotNull(settlementAllocationIntent); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123/cancel", + null, + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentPost4Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123/submit", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntent.class, + "{\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"expected_settlement_date\":\"1970-01-22T14:14:13.629Z\",\"financial_account\":\"financial_account\",\"id\":\"obj_123\",\"linked_credits\":[\"linked_credits\"],\"object\":\"v2.payments.settlement_allocation_intent\",\"reference\":\"reference\",\"status\":\"canceled\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.payments.SettlementAllocationIntent settlementAllocationIntent = + client.v2().payments().settlementAllocationIntents().submit("id_123"); + assertNotNull(settlementAllocationIntent); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/id_123/submit", + null, + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentsSplitPostServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntentSplit.class, + "{\"account\":\"account\",\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"flow\":{\"type\":\"outbound_payment\"},\"id\":\"obj_123\",\"object\":\"v2.payments.settlement_allocation_intent_split\",\"settlement_allocation_intent\":\"settlement_allocation_intent\",\"status\":\"canceled\",\"type\":\"credit\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.payments.settlementallocationintents.SplitCreateParams params = + com.stripe.param.v2.payments.settlementallocationintents.SplitCreateParams.builder() + .setAccount("account") + .setAmount( + com.stripe.param.v2.payments.settlementallocationintents.SplitCreateParams.Amount + .builder() + .setValue(111972721L) + .setCurrency("usd") + .build()) + .setType( + com.stripe.param.v2.payments.settlementallocationintents.SplitCreateParams.Type + .CREDIT) + .build(); + + com.stripe.model.v2.payments.SettlementAllocationIntentSplit settlementAllocationIntentSplit = + client + .v2() + .payments() + .settlementAllocationIntents() + .splits() + .create("settlement_allocation_intent_id_123", params); + assertNotNull(settlementAllocationIntentSplit); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits", + params.toMap(), + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentsSplitGetServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits/id_123", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntentSplit.class, + "{\"account\":\"account\",\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"flow\":{\"type\":\"outbound_payment\"},\"id\":\"obj_123\",\"object\":\"v2.payments.settlement_allocation_intent_split\",\"settlement_allocation_intent\":\"settlement_allocation_intent\",\"status\":\"canceled\",\"type\":\"credit\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.payments.SettlementAllocationIntentSplit settlementAllocationIntentSplit = + client + .v2() + .payments() + .settlementAllocationIntents() + .splits() + .retrieve("settlement_allocation_intent_id_123", "id_123"); + assertNotNull(settlementAllocationIntentSplit); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits/id_123", + null, + null); + } + + @Test + public void testV2PaymentsSettlementAllocationIntentsSplitPost2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits/id_123/cancel", + null, + null, + com.stripe.model.v2.payments.SettlementAllocationIntentSplit.class, + "{\"account\":\"account\",\"amount\":{},\"created\":\"1970-01-12T21:42:34.472Z\",\"flow\":{\"type\":\"outbound_payment\"},\"id\":\"obj_123\",\"object\":\"v2.payments.settlement_allocation_intent_split\",\"settlement_allocation_intent\":\"settlement_allocation_intent\",\"status\":\"canceled\",\"type\":\"credit\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.payments.SettlementAllocationIntentSplit settlementAllocationIntentSplit = + client + .v2() + .payments() + .settlementAllocationIntents() + .splits() + .cancel("settlement_allocation_intent_id_123", "id_123"); + assertNotNull(settlementAllocationIntentSplit); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/payments/settlement_allocation_intents/settlement_allocation_intent_id_123/splits/id_123/cancel", + null, + null); + } + @Test public void testV2ReportingReportGetServices() throws StripeException { stubRequest( @@ -30049,6 +29874,157 @@ public void testV2ReportingReportRunGetServices() throws StripeException { null); } + @Test + public void testV2TaxManualRuleGetServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/tax/manual_rules", + null, + null, + new TypeToken< + com.stripe.model.v2.StripeCollection< + com.stripe.model.v2.tax.ManualRule>>() {}.getType(), + "{\"data\":[{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"object\":\"v2.tax.manual_rule\",\"products\":[{\"type\":\"licensed_item\"}],\"scheduled_tax_rates\":[{\"rates\":[{\"display_name\":\"display_name\",\"percentage\":\"percentage\"}]}],\"status\":\"active\",\"livemode\":true}],\"next_page_url\":null,\"previous_page_url\":null}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.tax.ManualRuleListParams params = + com.stripe.param.v2.tax.ManualRuleListParams.builder().build(); + + com.stripe.model.v2.StripeCollection stripeCollection = + client.v2().tax().manualRules().list(params); + assertNotNull(stripeCollection); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/tax/manual_rules", + params.toMap(), + null); + } + + @Test + public void testV2TaxManualRulePostServices() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules", + null, + null, + com.stripe.model.v2.tax.ManualRule.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"object\":\"v2.tax.manual_rule\",\"products\":[{\"type\":\"licensed_item\"}],\"scheduled_tax_rates\":[{\"rates\":[{\"display_name\":\"display_name\",\"percentage\":\"percentage\"}]}],\"status\":\"active\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.tax.ManualRuleCreateParams params = + com.stripe.param.v2.tax.ManualRuleCreateParams.builder() + .addScheduledTaxRate( + com.stripe.param.v2.tax.ManualRuleCreateParams.ScheduledTaxRate.builder() + .addRate( + com.stripe.param.v2.tax.ManualRuleCreateParams.ScheduledTaxRate.Rate + .builder() + .setCountry("country") + .setDescription("description") + .setDisplayName("display_name") + .setJurisdiction("jurisdiction") + .setPercentage("percentage") + .setState("state") + .build()) + .setStartsAt(Instant.parse("1970-01-25T15:13:01.215Z")) + .build()) + .build(); + + com.stripe.model.v2.tax.ManualRule manualRule = client.v2().tax().manualRules().create(params); + assertNotNull(manualRule); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules", + params.toMap(), + null); + } + + @Test + public void testV2TaxManualRuleGet2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.GET, + "/v2/tax/manual_rules/id_123", + null, + null, + com.stripe.model.v2.tax.ManualRule.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"object\":\"v2.tax.manual_rule\",\"products\":[{\"type\":\"licensed_item\"}],\"scheduled_tax_rates\":[{\"rates\":[{\"display_name\":\"display_name\",\"percentage\":\"percentage\"}]}],\"status\":\"active\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.tax.ManualRule manualRule = + client.v2().tax().manualRules().retrieve("id_123"); + assertNotNull(manualRule); + verifyRequest( + BaseAddress.API, ApiResource.RequestMethod.GET, "/v2/tax/manual_rules/id_123", null, null); + } + + @Test + public void testV2TaxManualRulePost2Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules/id_123", + null, + null, + com.stripe.model.v2.tax.ManualRule.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"object\":\"v2.tax.manual_rule\",\"products\":[{\"type\":\"licensed_item\"}],\"scheduled_tax_rates\":[{\"rates\":[{\"display_name\":\"display_name\",\"percentage\":\"percentage\"}]}],\"status\":\"active\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.tax.ManualRuleUpdateParams params = + com.stripe.param.v2.tax.ManualRuleUpdateParams.builder() + .addScheduledTaxRate( + com.stripe.param.v2.tax.ManualRuleUpdateParams.ScheduledTaxRate.builder() + .addRate( + com.stripe.param.v2.tax.ManualRuleUpdateParams.ScheduledTaxRate.Rate + .builder() + .setCountry("country") + .setDescription("description") + .setDisplayName("display_name") + .setJurisdiction("jurisdiction") + .setPercentage("percentage") + .setState("state") + .build()) + .setStartsAt(Instant.parse("1970-01-25T15:13:01.215Z")) + .build()) + .build(); + + com.stripe.model.v2.tax.ManualRule manualRule = + client.v2().tax().manualRules().update("id_123", params); + assertNotNull(manualRule); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules/id_123", + params.toMap(), + null); + } + + @Test + public void testV2TaxManualRulePost3Services() throws StripeException { + stubRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules/id_123/deactivate", + null, + null, + com.stripe.model.v2.tax.ManualRule.class, + "{\"created\":\"1970-01-12T21:42:34.472Z\",\"id\":\"obj_123\",\"object\":\"v2.tax.manual_rule\",\"products\":[{\"type\":\"licensed_item\"}],\"scheduled_tax_rates\":[{\"rates\":[{\"display_name\":\"display_name\",\"percentage\":\"percentage\"}]}],\"status\":\"active\",\"livemode\":true}"); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.model.v2.tax.ManualRule manualRule = + client.v2().tax().manualRules().deactivate("id_123"); + assertNotNull(manualRule); + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/tax/manual_rules/id_123/deactivate", + null, + null); + } + @Test public void testV2TestHelpersFinancialAddressPostServices() throws StripeException { stubRequest( @@ -30225,6 +30201,35 @@ public void testBlockedByStripeErrorServices() throws StripeException { null); } + @Test + public void testControlledByAlternateResourceErrorServices() throws StripeException { + stubRequestReturnError( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/money_management/outbound_setup_intents", + null, + null, + "{\"error\":{\"type\":\"controlled_by_alternate_resource\",\"code\":\"payout_method_cannot_be_archived\"}}", + 400); + StripeClient client = new StripeClient(networkSpy); + + com.stripe.param.v2.moneymanagement.OutboundSetupIntentCreateParams params = + com.stripe.param.v2.moneymanagement.OutboundSetupIntentCreateParams.builder().build(); + + try { + client.v2().moneyManagement().outboundSetupIntents().create(params); + } catch (ControlledByAlternateResourceException e) { + + } + ; + verifyRequest( + BaseAddress.API, + ApiResource.RequestMethod.POST, + "/v2/money_management/outbound_setup_intents", + params.toMap(), + null); + } + @Test public void testControlledByDashboardErrorServices() throws StripeException { stubRequestReturnError( @@ -30514,27 +30519,45 @@ public void testQuotaExceededErrorServices() throws StripeException { public void testRateLimitErrorServices() throws StripeException { stubRequestReturnError( BaseAddress.API, - ApiResource.RequestMethod.GET, - "/v2/core/accounts/id_123", + ApiResource.RequestMethod.POST, + "/v2/reporting/report_runs", null, null, - "{\"error\":{\"type\":\"rate_limit\",\"code\":\"account_rate_limit_exceeded\"}}", + "{\"error\":{\"type\":\"rate_limit\",\"code\":\"report_run_rate_limit_exceeded\"}}", 400); StripeClient client = new StripeClient(networkSpy); - com.stripe.param.v2.core.AccountRetrieveParams params = - com.stripe.param.v2.core.AccountRetrieveParams.builder().build(); + com.stripe.param.v2.reporting.ReportRunCreateParams params = + com.stripe.param.v2.reporting.ReportRunCreateParams.builder() + .setReport("report") + .putReportParameter("int_key", new BigDecimal(123)) + .putReportParameter("string_key", "value") + .putReportParameter("boolean_key", true) + .putReportParameter( + "object_key", + new HashMap() { + { + put("object_int_key", new BigDecimal(123)); + put("object_string_key", "value"); + put("object_boolean_key", true); + } + }) + .putReportParameter( + "array_key", + new ArrayList<>( + Arrays.asList(new BigDecimal(1), new BigDecimal(2), new BigDecimal(3)))) + .build(); try { - client.v2().core().accounts().retrieve("id_123", params); + client.v2().reporting().reportRuns().create(params); } catch (RateLimitException e) { } ; verifyRequest( BaseAddress.API, - ApiResource.RequestMethod.GET, - "/v2/core/accounts/id_123", + ApiResource.RequestMethod.POST, + "/v2/reporting/report_runs", params.toMap(), null); }