com.chargebee.models.Subscription Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of chargebee-java Show documentation
Show all versions of chargebee-java Show documentation
Java client library for ChargeBee API
package com.chargebee.models;
import com.chargebee.*;
import com.chargebee.internal.*;
import com.chargebee.filters.*;
import com.chargebee.filters.enums.SortOrder;
import com.chargebee.internal.HttpUtil.Method;
import com.chargebee.models.enums.*;
import org.json.*;
import java.io.*;
import java.math.BigDecimal;
import java.sql.Timestamp;
import java.util.*;
public class Subscription extends Resource {
public enum BillingPeriodUnit {
DAY,
WEEK,
MONTH,
YEAR,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public enum Status {
FUTURE,
IN_TRIAL,
ACTIVE,
NON_RENEWING,
PAUSED,
CANCELLED,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public enum CancelReason {
NOT_PAID,
NO_CARD,
FRAUD_REVIEW_FAILED,
NON_COMPLIANT_EU_CUSTOMER,
TAX_CALCULATION_FAILED,
CURRENCY_INCOMPATIBLE_WITH_GATEWAY,
NON_COMPLIANT_CUSTOMER,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public static class Addon extends Resource {
public Addon(JSONObject jsonObj) {
super(jsonObj);
}
public String id() {
return reqString("id");
}
public Integer quantity() {
return optInteger("quantity");
}
public Integer unitPrice() {
return optInteger("unit_price");
}
public Integer amount() {
return optInteger("amount");
}
public Timestamp trialEnd() {
return optTimestamp("trial_end");
}
public Integer remainingBillingCycles() {
return optInteger("remaining_billing_cycles");
}
}
public static class EventBasedAddon extends Resource {
public enum OnEvent {
SUBSCRIPTION_CREATION,SUBSCRIPTION_TRIAL_START,PLAN_ACTIVATION,SUBSCRIPTION_ACTIVATION,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public EventBasedAddon(JSONObject jsonObj) {
super(jsonObj);
}
public String id() {
return reqString("id");
}
public Integer quantity() {
return reqInteger("quantity");
}
public Integer unitPrice() {
return reqInteger("unit_price");
}
@Deprecated
public Integer servicePeriodInDays() {
return optInteger("service_period_in_days");
}
public OnEvent onEvent() {
return reqEnum("on_event", OnEvent.class);
}
public Boolean chargeOnce() {
return reqBoolean("charge_once");
}
}
public static class ChargedEventBasedAddon extends Resource {
public ChargedEventBasedAddon(JSONObject jsonObj) {
super(jsonObj);
}
public String id() {
return reqString("id");
}
public Timestamp lastChargedAt() {
return reqTimestamp("last_charged_at");
}
}
public static class Coupon extends Resource {
public Coupon(JSONObject jsonObj) {
super(jsonObj);
}
public String couponId() {
return reqString("coupon_id");
}
public Timestamp applyTill() {
return optTimestamp("apply_till");
}
public Integer appliedCount() {
return reqInteger("applied_count");
}
public String couponCode() {
return optString("coupon_code");
}
}
public static class ShippingAddress extends Resource {
public ShippingAddress(JSONObject jsonObj) {
super(jsonObj);
}
public String firstName() {
return optString("first_name");
}
public String lastName() {
return optString("last_name");
}
public String email() {
return optString("email");
}
public String company() {
return optString("company");
}
public String phone() {
return optString("phone");
}
public String line1() {
return optString("line1");
}
public String line2() {
return optString("line2");
}
public String line3() {
return optString("line3");
}
public String city() {
return optString("city");
}
public String stateCode() {
return optString("state_code");
}
public String state() {
return optString("state");
}
public String country() {
return optString("country");
}
public String zip() {
return optString("zip");
}
public ValidationStatus validationStatus() {
return optEnum("validation_status", ValidationStatus.class);
}
}
public static class ReferralInfo extends Resource {
public enum RewardStatus {
PENDING,PAID,INVALID,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public ReferralInfo(JSONObject jsonObj) {
super(jsonObj);
}
public String referralCode() {
return optString("referral_code");
}
public String couponCode() {
return optString("coupon_code");
}
public String referrerId() {
return optString("referrer_id");
}
public String externalReferenceId() {
return optString("external_reference_id");
}
public RewardStatus rewardStatus() {
return optEnum("reward_status", RewardStatus.class);
}
public ReferralSystem referralSystem() {
return optEnum("referral_system", ReferralSystem.class);
}
public String accountId() {
return reqString("account_id");
}
public String campaignId() {
return reqString("campaign_id");
}
public String externalCampaignId() {
return optString("external_campaign_id");
}
public FriendOfferType friendOfferType() {
return optEnum("friend_offer_type", FriendOfferType.class);
}
public ReferrerRewardType referrerRewardType() {
return optEnum("referrer_reward_type", ReferrerRewardType.class);
}
public NotifyReferralSystem notifyReferralSystem() {
return optEnum("notify_referral_system", NotifyReferralSystem.class);
}
public String destinationUrl() {
return optString("destination_url");
}
public Boolean postPurchaseWidgetEnabled() {
return reqBoolean("post_purchase_widget_enabled");
}
}
//Constructors
//============
public Subscription(String jsonStr) {
super(jsonStr);
}
public Subscription(JSONObject jsonObj) {
super(jsonObj);
}
// Fields
//=======
public String id() {
return reqString("id");
}
public String customerId() {
return reqString("customer_id");
}
public String currencyCode() {
return reqString("currency_code");
}
public String planId() {
return reqString("plan_id");
}
public Integer planQuantity() {
return reqInteger("plan_quantity");
}
public Integer planUnitPrice() {
return optInteger("plan_unit_price");
}
public Integer setupFee() {
return optInteger("setup_fee");
}
public Integer planAmount() {
return optInteger("plan_amount");
}
public Integer billingPeriod() {
return optInteger("billing_period");
}
public BillingPeriodUnit billingPeriodUnit() {
return optEnum("billing_period_unit", BillingPeriodUnit.class);
}
public Integer planFreeQuantity() {
return optInteger("plan_free_quantity");
}
public Status status() {
return reqEnum("status", Status.class);
}
public Timestamp startDate() {
return optTimestamp("start_date");
}
public Timestamp trialStart() {
return optTimestamp("trial_start");
}
public Timestamp trialEnd() {
return optTimestamp("trial_end");
}
public Timestamp currentTermStart() {
return optTimestamp("current_term_start");
}
public Timestamp currentTermEnd() {
return optTimestamp("current_term_end");
}
public Timestamp nextBillingAt() {
return optTimestamp("next_billing_at");
}
public Integer remainingBillingCycles() {
return optInteger("remaining_billing_cycles");
}
public String poNumber() {
return optString("po_number");
}
public Timestamp createdAt() {
return optTimestamp("created_at");
}
public Timestamp startedAt() {
return optTimestamp("started_at");
}
public Timestamp activatedAt() {
return optTimestamp("activated_at");
}
public String giftId() {
return optString("gift_id");
}
public Boolean overrideRelationship() {
return optBoolean("override_relationship");
}
public Timestamp pauseDate() {
return optTimestamp("pause_date");
}
public Timestamp resumeDate() {
return optTimestamp("resume_date");
}
public Timestamp cancelledAt() {
return optTimestamp("cancelled_at");
}
public CancelReason cancelReason() {
return optEnum("cancel_reason", CancelReason.class);
}
public String affiliateToken() {
return optString("affiliate_token");
}
public String createdFromIp() {
return optString("created_from_ip");
}
public Long resourceVersion() {
return optLong("resource_version");
}
public Timestamp updatedAt() {
return optTimestamp("updated_at");
}
public Boolean hasScheduledChanges() {
return reqBoolean("has_scheduled_changes");
}
public String paymentSourceId() {
return optString("payment_source_id");
}
public AutoCollection autoCollection() {
return optEnum("auto_collection", AutoCollection.class);
}
public Integer dueInvoicesCount() {
return optInteger("due_invoices_count");
}
public Timestamp dueSince() {
return optTimestamp("due_since");
}
public Integer totalDues() {
return optInteger("total_dues");
}
public Integer mrr() {
return optInteger("mrr");
}
public BigDecimal exchangeRate() {
return optBigDecimal("exchange_rate");
}
public String baseCurrencyCode() {
return optString("base_currency_code");
}
public List addons() {
return optList("addons", Subscription.Addon.class);
}
public List eventBasedAddons() {
return optList("event_based_addons", Subscription.EventBasedAddon.class);
}
public List chargedEventBasedAddons() {
return optList("charged_event_based_addons", Subscription.ChargedEventBasedAddon.class);
}
@Deprecated
public String coupon() {
return optString("coupon");
}
public List coupons() {
return optList("coupons", Subscription.Coupon.class);
}
public Subscription.ShippingAddress shippingAddress() {
return optSubResource("shipping_address", Subscription.ShippingAddress.class);
}
public Subscription.ReferralInfo referralInfo() {
return optSubResource("referral_info", Subscription.ReferralInfo.class);
}
public String invoiceNotes() {
return optString("invoice_notes");
}
public JSONObject metaData() {
return optJSONObject("meta_data");
}
public Boolean deleted() {
return reqBoolean("deleted");
}
// Operations
//===========
public static CreateRequest create() {
String uri = uri("subscriptions");
return new CreateRequest(Method.POST, uri);
}
public static CreateForCustomerRequest createForCustomer(String id) {
String uri = uri("customers", nullCheck(id), "subscriptions");
return new CreateForCustomerRequest(Method.POST, uri);
}
public static SubscriptionListRequest list() {
String uri = uri("subscriptions");
return new SubscriptionListRequest(uri);
}
@Deprecated
public static ListRequest subscriptionsForCustomer(String id) {
String uri = uri("customers", nullCheck(id), "subscriptions");
return new ListRequest(uri);
}
public static Request retrieve(String id) {
String uri = uri("subscriptions", nullCheck(id));
return new Request(Method.GET, uri);
}
public static Request retrieveWithScheduledChanges(String id) {
String uri = uri("subscriptions", nullCheck(id), "retrieve_with_scheduled_changes");
return new Request(Method.GET, uri);
}
public static Request removeScheduledChanges(String id) {
String uri = uri("subscriptions", nullCheck(id), "remove_scheduled_changes");
return new Request(Method.POST, uri);
}
public static RemoveScheduledCancellationRequest removeScheduledCancellation(String id) {
String uri = uri("subscriptions", nullCheck(id), "remove_scheduled_cancellation");
return new RemoveScheduledCancellationRequest(Method.POST, uri);
}
public static RemoveCouponsRequest removeCoupons(String id) {
String uri = uri("subscriptions", nullCheck(id), "remove_coupons");
return new RemoveCouponsRequest(Method.POST, uri);
}
public static UpdateRequest update(String id) {
String uri = uri("subscriptions", nullCheck(id));
return new UpdateRequest(Method.POST, uri);
}
public static ChangeTermEndRequest changeTermEnd(String id) {
String uri = uri("subscriptions", nullCheck(id), "change_term_end");
return new ChangeTermEndRequest(Method.POST, uri);
}
public static CancelRequest cancel(String id) {
String uri = uri("subscriptions", nullCheck(id), "cancel");
return new CancelRequest(Method.POST, uri);
}
public static ReactivateRequest reactivate(String id) {
String uri = uri("subscriptions", nullCheck(id), "reactivate");
return new ReactivateRequest(Method.POST, uri);
}
public static AddChargeAtTermEndRequest addChargeAtTermEnd(String id) {
String uri = uri("subscriptions", nullCheck(id), "add_charge_at_term_end");
return new AddChargeAtTermEndRequest(Method.POST, uri);
}
public static ChargeAddonAtTermEndRequest chargeAddonAtTermEnd(String id) {
String uri = uri("subscriptions", nullCheck(id), "charge_addon_at_term_end");
return new ChargeAddonAtTermEndRequest(Method.POST, uri);
}
public static ChargeFutureRenewalsRequest chargeFutureRenewals(String id) {
String uri = uri("subscriptions", nullCheck(id), "charge_future_renewals");
return new ChargeFutureRenewalsRequest(Method.POST, uri);
}
public static ImportSubscriptionRequest importSubscription() {
String uri = uri("subscriptions", "import_subscription");
return new ImportSubscriptionRequest(Method.POST, uri);
}
public static ImportForCustomerRequest importForCustomer(String id) {
String uri = uri("customers", nullCheck(id), "import_subscription");
return new ImportForCustomerRequest(Method.POST, uri);
}
public static OverrideBillingProfileRequest overrideBillingProfile(String id) {
String uri = uri("subscriptions", nullCheck(id), "override_billing_profile");
return new OverrideBillingProfileRequest(Method.POST, uri);
}
public static Request delete(String id) {
String uri = uri("subscriptions", nullCheck(id), "delete");
return new Request(Method.POST, uri);
}
public static PauseRequest pause(String id) {
String uri = uri("subscriptions", nullCheck(id), "pause");
return new PauseRequest(Method.POST, uri);
}
public static ResumeRequest resume(String id) {
String uri = uri("subscriptions", nullCheck(id), "resume");
return new ResumeRequest(Method.POST, uri);
}
public static Request removeScheduledPause(String id) {
String uri = uri("subscriptions", nullCheck(id), "remove_scheduled_pause");
return new Request(Method.POST, uri);
}
public static Request removeScheduledResumption(String id) {
String uri = uri("subscriptions", nullCheck(id), "remove_scheduled_resumption");
return new Request(Method.POST, uri);
}
// Operation Request Classes
//==========================
public static class CreateRequest extends Request {
private CreateRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public CreateRequest id(String id) {
params.addOpt("id", id);
return this;
}
public CreateRequest planId(String planId) {
params.add("plan_id", planId);
return this;
}
public CreateRequest planQuantity(Integer planQuantity) {
params.addOpt("plan_quantity", planQuantity);
return this;
}
public CreateRequest planUnitPrice(Integer planUnitPrice) {
params.addOpt("plan_unit_price", planUnitPrice);
return this;
}
public CreateRequest setupFee(Integer setupFee) {
params.addOpt("setup_fee", setupFee);
return this;
}
public CreateRequest startDate(Timestamp startDate) {
params.addOpt("start_date", startDate);
return this;
}
public CreateRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public CreateRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
@Deprecated
public CreateRequest coupon(String coupon) {
params.addOpt("coupon", coupon);
return this;
}
public CreateRequest autoCollection(com.chargebee.models.enums.AutoCollection autoCollection) {
params.addOpt("auto_collection", autoCollection);
return this;
}
public CreateRequest termsToCharge(Integer termsToCharge) {
params.addOpt("terms_to_charge", termsToCharge);
return this;
}
public CreateRequest billingAlignmentMode(com.chargebee.models.enums.BillingAlignmentMode billingAlignmentMode) {
params.addOpt("billing_alignment_mode", billingAlignmentMode);
return this;
}
public CreateRequest mandatoryAddonsToRemove(List mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
public CreateRequest mandatoryAddonsToRemove(String... mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
public CreateRequest poNumber(String poNumber) {
params.addOpt("po_number", poNumber);
return this;
}
public CreateRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public CreateRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public CreateRequest tokenId(String tokenId) {
params.addOpt("token_id", tokenId);
return this;
}
public CreateRequest affiliateToken(String affiliateToken) {
params.addOpt("affiliate_token", affiliateToken);
return this;
}
@Deprecated
public CreateRequest createdFromIp(String createdFromIp) {
params.addOpt("created_from_ip", createdFromIp);
return this;
}
public CreateRequest invoiceNotes(String invoiceNotes) {
params.addOpt("invoice_notes", invoiceNotes);
return this;
}
public CreateRequest metaData(JSONObject metaData) {
params.addOpt("meta_data", metaData);
return this;
}
public CreateRequest invoiceImmediately(Boolean invoiceImmediately) {
params.addOpt("invoice_immediately", invoiceImmediately);
return this;
}
public CreateRequest clientProfileId(String clientProfileId) {
params.addOpt("client_profile_id", clientProfileId);
return this;
}
public CreateRequest customerId(String customerId) {
params.addOpt("customer[id]", customerId);
return this;
}
public CreateRequest customerEmail(String customerEmail) {
params.addOpt("customer[email]", customerEmail);
return this;
}
public CreateRequest customerFirstName(String customerFirstName) {
params.addOpt("customer[first_name]", customerFirstName);
return this;
}
public CreateRequest customerLastName(String customerLastName) {
params.addOpt("customer[last_name]", customerLastName);
return this;
}
public CreateRequest customerCompany(String customerCompany) {
params.addOpt("customer[company]", customerCompany);
return this;
}
public CreateRequest customerTaxability(com.chargebee.models.enums.Taxability customerTaxability) {
params.addOpt("customer[taxability]", customerTaxability);
return this;
}
public CreateRequest customerLocale(String customerLocale) {
params.addOpt("customer[locale]", customerLocale);
return this;
}
public CreateRequest customerEntityCode(com.chargebee.models.enums.EntityCode customerEntityCode) {
params.addOpt("customer[entity_code]", customerEntityCode);
return this;
}
public CreateRequest customerExemptNumber(String customerExemptNumber) {
params.addOpt("customer[exempt_number]", customerExemptNumber);
return this;
}
public CreateRequest customerNetTermDays(Integer customerNetTermDays) {
params.addOpt("customer[net_term_days]", customerNetTermDays);
return this;
}
public CreateRequest customerPhone(String customerPhone) {
params.addOpt("customer[phone]", customerPhone);
return this;
}
public CreateRequest customerAutoCollection(com.chargebee.models.enums.AutoCollection customerAutoCollection) {
params.addOpt("customer[auto_collection]", customerAutoCollection);
return this;
}
public CreateRequest customerAllowDirectDebit(Boolean customerAllowDirectDebit) {
params.addOpt("customer[allow_direct_debit]", customerAllowDirectDebit);
return this;
}
public CreateRequest customerConsolidatedInvoicing(Boolean customerConsolidatedInvoicing) {
params.addOpt("customer[consolidated_invoicing]", customerConsolidatedInvoicing);
return this;
}
@Deprecated
public CreateRequest cardGateway(com.chargebee.models.enums.Gateway cardGateway) {
params.addOpt("card[gateway]", cardGateway);
return this;
}
public CreateRequest cardGatewayAccountId(String cardGatewayAccountId) {
params.addOpt("card[gateway_account_id]", cardGatewayAccountId);
return this;
}
@Deprecated
public CreateRequest cardTmpToken(String cardTmpToken) {
params.addOpt("card[tmp_token]", cardTmpToken);
return this;
}
public CreateRequest bankAccountGatewayAccountId(String bankAccountGatewayAccountId) {
params.addOpt("bank_account[gateway_account_id]", bankAccountGatewayAccountId);
return this;
}
public CreateRequest bankAccountIban(String bankAccountIban) {
params.addOpt("bank_account[iban]", bankAccountIban);
return this;
}
public CreateRequest bankAccountFirstName(String bankAccountFirstName) {
params.addOpt("bank_account[first_name]", bankAccountFirstName);
return this;
}
public CreateRequest bankAccountLastName(String bankAccountLastName) {
params.addOpt("bank_account[last_name]", bankAccountLastName);
return this;
}
public CreateRequest bankAccountCompany(String bankAccountCompany) {
params.addOpt("bank_account[company]", bankAccountCompany);
return this;
}
public CreateRequest bankAccountEmail(String bankAccountEmail) {
params.addOpt("bank_account[email]", bankAccountEmail);
return this;
}
public CreateRequest bankAccountBankName(String bankAccountBankName) {
params.addOpt("bank_account[bank_name]", bankAccountBankName);
return this;
}
public CreateRequest bankAccountAccountNumber(String bankAccountAccountNumber) {
params.addOpt("bank_account[account_number]", bankAccountAccountNumber);
return this;
}
public CreateRequest bankAccountRoutingNumber(String bankAccountRoutingNumber) {
params.addOpt("bank_account[routing_number]", bankAccountRoutingNumber);
return this;
}
public CreateRequest bankAccountBankCode(String bankAccountBankCode) {
params.addOpt("bank_account[bank_code]", bankAccountBankCode);
return this;
}
public CreateRequest bankAccountAccountType(com.chargebee.models.enums.AccountType bankAccountAccountType) {
params.addOpt("bank_account[account_type]", bankAccountAccountType);
return this;
}
public CreateRequest bankAccountAccountHolderType(com.chargebee.models.enums.AccountHolderType bankAccountAccountHolderType) {
params.addOpt("bank_account[account_holder_type]", bankAccountAccountHolderType);
return this;
}
public CreateRequest bankAccountEcheckType(com.chargebee.models.enums.EcheckType bankAccountEcheckType) {
params.addOpt("bank_account[echeck_type]", bankAccountEcheckType);
return this;
}
public CreateRequest bankAccountIssuingCountry(String bankAccountIssuingCountry) {
params.addOpt("bank_account[issuing_country]", bankAccountIssuingCountry);
return this;
}
public CreateRequest bankAccountSwedishIdentityNumber(String bankAccountSwedishIdentityNumber) {
params.addOpt("bank_account[swedish_identity_number]", bankAccountSwedishIdentityNumber);
return this;
}
public CreateRequest paymentMethodType(com.chargebee.models.enums.Type paymentMethodType) {
params.addOpt("payment_method[type]", paymentMethodType);
return this;
}
@Deprecated
public CreateRequest paymentMethodGateway(com.chargebee.models.enums.Gateway paymentMethodGateway) {
params.addOpt("payment_method[gateway]", paymentMethodGateway);
return this;
}
public CreateRequest paymentMethodGatewayAccountId(String paymentMethodGatewayAccountId) {
params.addOpt("payment_method[gateway_account_id]", paymentMethodGatewayAccountId);
return this;
}
public CreateRequest paymentMethodReferenceId(String paymentMethodReferenceId) {
params.addOpt("payment_method[reference_id]", paymentMethodReferenceId);
return this;
}
public CreateRequest paymentMethodTmpToken(String paymentMethodTmpToken) {
params.addOpt("payment_method[tmp_token]", paymentMethodTmpToken);
return this;
}
public CreateRequest paymentMethodIssuingCountry(String paymentMethodIssuingCountry) {
params.addOpt("payment_method[issuing_country]", paymentMethodIssuingCountry);
return this;
}
public CreateRequest cardFirstName(String cardFirstName) {
params.addOpt("card[first_name]", cardFirstName);
return this;
}
public CreateRequest cardLastName(String cardLastName) {
params.addOpt("card[last_name]", cardLastName);
return this;
}
public CreateRequest cardNumber(String cardNumber) {
params.addOpt("card[number]", cardNumber);
return this;
}
public CreateRequest cardExpiryMonth(Integer cardExpiryMonth) {
params.addOpt("card[expiry_month]", cardExpiryMonth);
return this;
}
public CreateRequest cardExpiryYear(Integer cardExpiryYear) {
params.addOpt("card[expiry_year]", cardExpiryYear);
return this;
}
public CreateRequest cardCvv(String cardCvv) {
params.addOpt("card[cvv]", cardCvv);
return this;
}
public CreateRequest cardBillingAddr1(String cardBillingAddr1) {
params.addOpt("card[billing_addr1]", cardBillingAddr1);
return this;
}
public CreateRequest cardBillingAddr2(String cardBillingAddr2) {
params.addOpt("card[billing_addr2]", cardBillingAddr2);
return this;
}
public CreateRequest cardBillingCity(String cardBillingCity) {
params.addOpt("card[billing_city]", cardBillingCity);
return this;
}
public CreateRequest cardBillingStateCode(String cardBillingStateCode) {
params.addOpt("card[billing_state_code]", cardBillingStateCode);
return this;
}
public CreateRequest cardBillingState(String cardBillingState) {
params.addOpt("card[billing_state]", cardBillingState);
return this;
}
public CreateRequest cardBillingZip(String cardBillingZip) {
params.addOpt("card[billing_zip]", cardBillingZip);
return this;
}
public CreateRequest cardBillingCountry(String cardBillingCountry) {
params.addOpt("card[billing_country]", cardBillingCountry);
return this;
}
@Deprecated
public CreateRequest cardIpAddress(String cardIpAddress) {
params.addOpt("card[ip_address]", cardIpAddress);
return this;
}
public CreateRequest paymentIntentId(String paymentIntentId) {
params.addOpt("payment_intent[id]", paymentIntentId);
return this;
}
public CreateRequest paymentIntentGatewayAccountId(String paymentIntentGatewayAccountId) {
params.addOpt("payment_intent[gateway_account_id]", paymentIntentGatewayAccountId);
return this;
}
public CreateRequest paymentIntentGwToken(String paymentIntentGwToken) {
params.addOpt("payment_intent[gw_token]", paymentIntentGwToken);
return this;
}
public CreateRequest paymentIntentReferenceId(String paymentIntentReferenceId) {
params.addOpt("payment_intent[reference_id]", paymentIntentReferenceId);
return this;
}
@Deprecated
public CreateRequest paymentIntentGwPaymentMethodId(String paymentIntentGwPaymentMethodId) {
params.addOpt("payment_intent[gw_payment_method_id]", paymentIntentGwPaymentMethodId);
return this;
}
public CreateRequest billingAddressFirstName(String billingAddressFirstName) {
params.addOpt("billing_address[first_name]", billingAddressFirstName);
return this;
}
public CreateRequest billingAddressLastName(String billingAddressLastName) {
params.addOpt("billing_address[last_name]", billingAddressLastName);
return this;
}
public CreateRequest billingAddressEmail(String billingAddressEmail) {
params.addOpt("billing_address[email]", billingAddressEmail);
return this;
}
public CreateRequest billingAddressCompany(String billingAddressCompany) {
params.addOpt("billing_address[company]", billingAddressCompany);
return this;
}
public CreateRequest billingAddressPhone(String billingAddressPhone) {
params.addOpt("billing_address[phone]", billingAddressPhone);
return this;
}
public CreateRequest billingAddressLine1(String billingAddressLine1) {
params.addOpt("billing_address[line1]", billingAddressLine1);
return this;
}
public CreateRequest billingAddressLine2(String billingAddressLine2) {
params.addOpt("billing_address[line2]", billingAddressLine2);
return this;
}
public CreateRequest billingAddressLine3(String billingAddressLine3) {
params.addOpt("billing_address[line3]", billingAddressLine3);
return this;
}
public CreateRequest billingAddressCity(String billingAddressCity) {
params.addOpt("billing_address[city]", billingAddressCity);
return this;
}
public CreateRequest billingAddressStateCode(String billingAddressStateCode) {
params.addOpt("billing_address[state_code]", billingAddressStateCode);
return this;
}
public CreateRequest billingAddressState(String billingAddressState) {
params.addOpt("billing_address[state]", billingAddressState);
return this;
}
public CreateRequest billingAddressZip(String billingAddressZip) {
params.addOpt("billing_address[zip]", billingAddressZip);
return this;
}
public CreateRequest billingAddressCountry(String billingAddressCountry) {
params.addOpt("billing_address[country]", billingAddressCountry);
return this;
}
public CreateRequest billingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus billingAddressValidationStatus) {
params.addOpt("billing_address[validation_status]", billingAddressValidationStatus);
return this;
}
public CreateRequest shippingAddressFirstName(String shippingAddressFirstName) {
params.addOpt("shipping_address[first_name]", shippingAddressFirstName);
return this;
}
public CreateRequest shippingAddressLastName(String shippingAddressLastName) {
params.addOpt("shipping_address[last_name]", shippingAddressLastName);
return this;
}
public CreateRequest shippingAddressEmail(String shippingAddressEmail) {
params.addOpt("shipping_address[email]", shippingAddressEmail);
return this;
}
public CreateRequest shippingAddressCompany(String shippingAddressCompany) {
params.addOpt("shipping_address[company]", shippingAddressCompany);
return this;
}
public CreateRequest shippingAddressPhone(String shippingAddressPhone) {
params.addOpt("shipping_address[phone]", shippingAddressPhone);
return this;
}
public CreateRequest shippingAddressLine1(String shippingAddressLine1) {
params.addOpt("shipping_address[line1]", shippingAddressLine1);
return this;
}
public CreateRequest shippingAddressLine2(String shippingAddressLine2) {
params.addOpt("shipping_address[line2]", shippingAddressLine2);
return this;
}
public CreateRequest shippingAddressLine3(String shippingAddressLine3) {
params.addOpt("shipping_address[line3]", shippingAddressLine3);
return this;
}
public CreateRequest shippingAddressCity(String shippingAddressCity) {
params.addOpt("shipping_address[city]", shippingAddressCity);
return this;
}
public CreateRequest shippingAddressStateCode(String shippingAddressStateCode) {
params.addOpt("shipping_address[state_code]", shippingAddressStateCode);
return this;
}
public CreateRequest shippingAddressState(String shippingAddressState) {
params.addOpt("shipping_address[state]", shippingAddressState);
return this;
}
public CreateRequest shippingAddressZip(String shippingAddressZip) {
params.addOpt("shipping_address[zip]", shippingAddressZip);
return this;
}
public CreateRequest shippingAddressCountry(String shippingAddressCountry) {
params.addOpt("shipping_address[country]", shippingAddressCountry);
return this;
}
public CreateRequest shippingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus shippingAddressValidationStatus) {
params.addOpt("shipping_address[validation_status]", shippingAddressValidationStatus);
return this;
}
public CreateRequest customerVatNumber(String customerVatNumber) {
params.addOpt("customer[vat_number]", customerVatNumber);
return this;
}
public CreateRequest customerRegisteredForGst(Boolean customerRegisteredForGst) {
params.addOpt("customer[registered_for_gst]", customerRegisteredForGst);
return this;
}
public CreateRequest customerExemptionDetails(JSONArray customerExemptionDetails) {
params.addOpt("customer[exemption_details]", customerExemptionDetails);
return this;
}
public CreateRequest customerCustomerType(com.chargebee.models.enums.CustomerType customerCustomerType) {
params.addOpt("customer[customer_type]", customerCustomerType);
return this;
}
public CreateRequest addonId(int index, String addonId) {
params.addOpt("addons[id][" + index + "]", addonId);
return this;
}
public CreateRequest addonQuantity(int index, Integer addonQuantity) {
params.addOpt("addons[quantity][" + index + "]", addonQuantity);
return this;
}
public CreateRequest addonUnitPrice(int index, Integer addonUnitPrice) {
params.addOpt("addons[unit_price][" + index + "]", addonUnitPrice);
return this;
}
public CreateRequest addonBillingCycles(int index, Integer addonBillingCycles) {
params.addOpt("addons[billing_cycles][" + index + "]", addonBillingCycles);
return this;
}
public CreateRequest eventBasedAddonId(int index, String eventBasedAddonId) {
params.addOpt("event_based_addons[id][" + index + "]", eventBasedAddonId);
return this;
}
public CreateRequest eventBasedAddonQuantity(int index, Integer eventBasedAddonQuantity) {
params.addOpt("event_based_addons[quantity][" + index + "]", eventBasedAddonQuantity);
return this;
}
public CreateRequest eventBasedAddonUnitPrice(int index, Integer eventBasedAddonUnitPrice) {
params.addOpt("event_based_addons[unit_price][" + index + "]", eventBasedAddonUnitPrice);
return this;
}
public CreateRequest eventBasedAddonServicePeriodInDays(int index, Integer eventBasedAddonServicePeriodInDays) {
params.addOpt("event_based_addons[service_period_in_days][" + index + "]", eventBasedAddonServicePeriodInDays);
return this;
}
public CreateRequest eventBasedAddonOnEvent(int index, com.chargebee.models.enums.OnEvent eventBasedAddonOnEvent) {
params.addOpt("event_based_addons[on_event][" + index + "]", eventBasedAddonOnEvent);
return this;
}
public CreateRequest eventBasedAddonChargeOnce(int index, Boolean eventBasedAddonChargeOnce) {
params.addOpt("event_based_addons[charge_once][" + index + "]", eventBasedAddonChargeOnce);
return this;
}
public CreateRequest eventBasedAddonChargeOn(int index, com.chargebee.models.enums.ChargeOn eventBasedAddonChargeOn) {
params.addOpt("event_based_addons[charge_on][" + index + "]", eventBasedAddonChargeOn);
return this;
}
public CreateRequest addonTrialEnd(int index, Timestamp addonTrialEnd) {
params.addOpt("addons[trial_end][" + index + "]", addonTrialEnd);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class CreateForCustomerRequest extends Request {
private CreateForCustomerRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public CreateForCustomerRequest id(String id) {
params.addOpt("id", id);
return this;
}
public CreateForCustomerRequest planId(String planId) {
params.add("plan_id", planId);
return this;
}
public CreateForCustomerRequest planQuantity(Integer planQuantity) {
params.addOpt("plan_quantity", planQuantity);
return this;
}
public CreateForCustomerRequest planUnitPrice(Integer planUnitPrice) {
params.addOpt("plan_unit_price", planUnitPrice);
return this;
}
public CreateForCustomerRequest setupFee(Integer setupFee) {
params.addOpt("setup_fee", setupFee);
return this;
}
public CreateForCustomerRequest startDate(Timestamp startDate) {
params.addOpt("start_date", startDate);
return this;
}
public CreateForCustomerRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public CreateForCustomerRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
@Deprecated
public CreateForCustomerRequest coupon(String coupon) {
params.addOpt("coupon", coupon);
return this;
}
public CreateForCustomerRequest autoCollection(com.chargebee.models.enums.AutoCollection autoCollection) {
params.addOpt("auto_collection", autoCollection);
return this;
}
public CreateForCustomerRequest termsToCharge(Integer termsToCharge) {
params.addOpt("terms_to_charge", termsToCharge);
return this;
}
public CreateForCustomerRequest billingAlignmentMode(com.chargebee.models.enums.BillingAlignmentMode billingAlignmentMode) {
params.addOpt("billing_alignment_mode", billingAlignmentMode);
return this;
}
public CreateForCustomerRequest mandatoryAddonsToRemove(List mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
public CreateForCustomerRequest mandatoryAddonsToRemove(String... mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
public CreateForCustomerRequest poNumber(String poNumber) {
params.addOpt("po_number", poNumber);
return this;
}
public CreateForCustomerRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public CreateForCustomerRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public CreateForCustomerRequest paymentSourceId(String paymentSourceId) {
params.addOpt("payment_source_id", paymentSourceId);
return this;
}
public CreateForCustomerRequest overrideRelationship(Boolean overrideRelationship) {
params.addOpt("override_relationship", overrideRelationship);
return this;
}
public CreateForCustomerRequest invoiceNotes(String invoiceNotes) {
params.addOpt("invoice_notes", invoiceNotes);
return this;
}
public CreateForCustomerRequest metaData(JSONObject metaData) {
params.addOpt("meta_data", metaData);
return this;
}
public CreateForCustomerRequest invoiceImmediately(Boolean invoiceImmediately) {
params.addOpt("invoice_immediately", invoiceImmediately);
return this;
}
public CreateForCustomerRequest shippingAddressFirstName(String shippingAddressFirstName) {
params.addOpt("shipping_address[first_name]", shippingAddressFirstName);
return this;
}
public CreateForCustomerRequest shippingAddressLastName(String shippingAddressLastName) {
params.addOpt("shipping_address[last_name]", shippingAddressLastName);
return this;
}
public CreateForCustomerRequest shippingAddressEmail(String shippingAddressEmail) {
params.addOpt("shipping_address[email]", shippingAddressEmail);
return this;
}
public CreateForCustomerRequest shippingAddressCompany(String shippingAddressCompany) {
params.addOpt("shipping_address[company]", shippingAddressCompany);
return this;
}
public CreateForCustomerRequest shippingAddressPhone(String shippingAddressPhone) {
params.addOpt("shipping_address[phone]", shippingAddressPhone);
return this;
}
public CreateForCustomerRequest shippingAddressLine1(String shippingAddressLine1) {
params.addOpt("shipping_address[line1]", shippingAddressLine1);
return this;
}
public CreateForCustomerRequest shippingAddressLine2(String shippingAddressLine2) {
params.addOpt("shipping_address[line2]", shippingAddressLine2);
return this;
}
public CreateForCustomerRequest shippingAddressLine3(String shippingAddressLine3) {
params.addOpt("shipping_address[line3]", shippingAddressLine3);
return this;
}
public CreateForCustomerRequest shippingAddressCity(String shippingAddressCity) {
params.addOpt("shipping_address[city]", shippingAddressCity);
return this;
}
public CreateForCustomerRequest shippingAddressStateCode(String shippingAddressStateCode) {
params.addOpt("shipping_address[state_code]", shippingAddressStateCode);
return this;
}
public CreateForCustomerRequest shippingAddressState(String shippingAddressState) {
params.addOpt("shipping_address[state]", shippingAddressState);
return this;
}
public CreateForCustomerRequest shippingAddressZip(String shippingAddressZip) {
params.addOpt("shipping_address[zip]", shippingAddressZip);
return this;
}
public CreateForCustomerRequest shippingAddressCountry(String shippingAddressCountry) {
params.addOpt("shipping_address[country]", shippingAddressCountry);
return this;
}
public CreateForCustomerRequest shippingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus shippingAddressValidationStatus) {
params.addOpt("shipping_address[validation_status]", shippingAddressValidationStatus);
return this;
}
public CreateForCustomerRequest paymentIntentId(String paymentIntentId) {
params.addOpt("payment_intent[id]", paymentIntentId);
return this;
}
public CreateForCustomerRequest paymentIntentGatewayAccountId(String paymentIntentGatewayAccountId) {
params.addOpt("payment_intent[gateway_account_id]", paymentIntentGatewayAccountId);
return this;
}
public CreateForCustomerRequest paymentIntentGwToken(String paymentIntentGwToken) {
params.addOpt("payment_intent[gw_token]", paymentIntentGwToken);
return this;
}
public CreateForCustomerRequest paymentIntentReferenceId(String paymentIntentReferenceId) {
params.addOpt("payment_intent[reference_id]", paymentIntentReferenceId);
return this;
}
@Deprecated
public CreateForCustomerRequest paymentIntentGwPaymentMethodId(String paymentIntentGwPaymentMethodId) {
params.addOpt("payment_intent[gw_payment_method_id]", paymentIntentGwPaymentMethodId);
return this;
}
public CreateForCustomerRequest addonId(int index, String addonId) {
params.addOpt("addons[id][" + index + "]", addonId);
return this;
}
public CreateForCustomerRequest addonQuantity(int index, Integer addonQuantity) {
params.addOpt("addons[quantity][" + index + "]", addonQuantity);
return this;
}
public CreateForCustomerRequest addonUnitPrice(int index, Integer addonUnitPrice) {
params.addOpt("addons[unit_price][" + index + "]", addonUnitPrice);
return this;
}
public CreateForCustomerRequest addonBillingCycles(int index, Integer addonBillingCycles) {
params.addOpt("addons[billing_cycles][" + index + "]", addonBillingCycles);
return this;
}
public CreateForCustomerRequest eventBasedAddonId(int index, String eventBasedAddonId) {
params.addOpt("event_based_addons[id][" + index + "]", eventBasedAddonId);
return this;
}
public CreateForCustomerRequest eventBasedAddonQuantity(int index, Integer eventBasedAddonQuantity) {
params.addOpt("event_based_addons[quantity][" + index + "]", eventBasedAddonQuantity);
return this;
}
public CreateForCustomerRequest eventBasedAddonUnitPrice(int index, Integer eventBasedAddonUnitPrice) {
params.addOpt("event_based_addons[unit_price][" + index + "]", eventBasedAddonUnitPrice);
return this;
}
public CreateForCustomerRequest eventBasedAddonServicePeriodInDays(int index, Integer eventBasedAddonServicePeriodInDays) {
params.addOpt("event_based_addons[service_period_in_days][" + index + "]", eventBasedAddonServicePeriodInDays);
return this;
}
public CreateForCustomerRequest eventBasedAddonOnEvent(int index, com.chargebee.models.enums.OnEvent eventBasedAddonOnEvent) {
params.addOpt("event_based_addons[on_event][" + index + "]", eventBasedAddonOnEvent);
return this;
}
public CreateForCustomerRequest eventBasedAddonChargeOnce(int index, Boolean eventBasedAddonChargeOnce) {
params.addOpt("event_based_addons[charge_once][" + index + "]", eventBasedAddonChargeOnce);
return this;
}
public CreateForCustomerRequest eventBasedAddonChargeOn(int index, com.chargebee.models.enums.ChargeOn eventBasedAddonChargeOn) {
params.addOpt("event_based_addons[charge_on][" + index + "]", eventBasedAddonChargeOn);
return this;
}
public CreateForCustomerRequest addonTrialEnd(int index, Timestamp addonTrialEnd) {
params.addOpt("addons[trial_end][" + index + "]", addonTrialEnd);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class SubscriptionListRequest extends ListRequest {
private SubscriptionListRequest(String uri) {
super(uri);
}
public SubscriptionListRequest includeDeleted(Boolean includeDeleted) {
params.addOpt("include_deleted", includeDeleted);
return this;
}
public StringFilter id() {
return new StringFilter("id",this).supportsMultiOperators(true);
}
public StringFilter customerId() {
return new StringFilter("customer_id",this).supportsMultiOperators(true);
}
public StringFilter planId() {
return new StringFilter("plan_id",this).supportsMultiOperators(true);
}
public EnumFilter status() {
return new EnumFilter("status",this);
}
public EnumFilter cancelReason() {
return new EnumFilter("cancel_reason",this).supportsPresenceOperator(true);
}
public NumberFilter remainingBillingCycles() {
return new NumberFilter("remaining_billing_cycles",this).supportsPresenceOperator(true);
}
public TimestampFilter createdAt() {
return new TimestampFilter("created_at",this);
}
public TimestampFilter activatedAt() {
return new TimestampFilter("activated_at",this).supportsPresenceOperator(true);
}
public TimestampFilter nextBillingAt() {
return new TimestampFilter("next_billing_at",this);
}
public TimestampFilter cancelledAt() {
return new TimestampFilter("cancelled_at",this);
}
public BooleanFilter hasScheduledChanges() {
return new BooleanFilter("has_scheduled_changes",this);
}
public TimestampFilter updatedAt() {
return new TimestampFilter("updated_at",this);
}
public BooleanFilter overrideRelationship() {
return new BooleanFilter("override_relationship",this);
}
public SubscriptionListRequest sortByCreatedAt(SortOrder order) {
params.addOpt("sort_by["+order.name().toLowerCase()+"]","created_at");
return this;
}
public SubscriptionListRequest sortByUpdatedAt(SortOrder order) {
params.addOpt("sort_by["+order.name().toLowerCase()+"]","updated_at");
return this;
}
@Override
public Params params() {
return params;
}
}
public static class RemoveScheduledCancellationRequest extends Request {
private RemoveScheduledCancellationRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public RemoveScheduledCancellationRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class RemoveCouponsRequest extends Request {
private RemoveCouponsRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public RemoveCouponsRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public RemoveCouponsRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class UpdateRequest extends Request {
private UpdateRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public UpdateRequest planId(String planId) {
params.addOpt("plan_id", planId);
return this;
}
public UpdateRequest planQuantity(Integer planQuantity) {
params.addOpt("plan_quantity", planQuantity);
return this;
}
public UpdateRequest planUnitPrice(Integer planUnitPrice) {
params.addOpt("plan_unit_price", planUnitPrice);
return this;
}
public UpdateRequest setupFee(Integer setupFee) {
params.addOpt("setup_fee", setupFee);
return this;
}
public UpdateRequest startDate(Timestamp startDate) {
params.addOpt("start_date", startDate);
return this;
}
public UpdateRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public UpdateRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
public UpdateRequest replaceAddonList(Boolean replaceAddonList) {
params.addOpt("replace_addon_list", replaceAddonList);
return this;
}
public UpdateRequest mandatoryAddonsToRemove(List mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
public UpdateRequest mandatoryAddonsToRemove(String... mandatoryAddonsToRemove) {
params.addOpt("mandatory_addons_to_remove", mandatoryAddonsToRemove);
return this;
}
@Deprecated
public UpdateRequest coupon(String coupon) {
params.addOpt("coupon", coupon);
return this;
}
public UpdateRequest termsToCharge(Integer termsToCharge) {
params.addOpt("terms_to_charge", termsToCharge);
return this;
}
public UpdateRequest reactivateFrom(Timestamp reactivateFrom) {
params.addOpt("reactivate_from", reactivateFrom);
return this;
}
public UpdateRequest billingAlignmentMode(com.chargebee.models.enums.BillingAlignmentMode billingAlignmentMode) {
params.addOpt("billing_alignment_mode", billingAlignmentMode);
return this;
}
public UpdateRequest poNumber(String poNumber) {
params.addOpt("po_number", poNumber);
return this;
}
public UpdateRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public UpdateRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public UpdateRequest replaceCouponList(Boolean replaceCouponList) {
params.addOpt("replace_coupon_list", replaceCouponList);
return this;
}
public UpdateRequest prorate(Boolean prorate) {
params.addOpt("prorate", prorate);
return this;
}
public UpdateRequest endOfTerm(Boolean endOfTerm) {
params.addOpt("end_of_term", endOfTerm);
return this;
}
public UpdateRequest forceTermReset(Boolean forceTermReset) {
params.addOpt("force_term_reset", forceTermReset);
return this;
}
public UpdateRequest reactivate(Boolean reactivate) {
params.addOpt("reactivate", reactivate);
return this;
}
public UpdateRequest tokenId(String tokenId) {
params.addOpt("token_id", tokenId);
return this;
}
public UpdateRequest invoiceNotes(String invoiceNotes) {
params.addOpt("invoice_notes", invoiceNotes);
return this;
}
public UpdateRequest metaData(JSONObject metaData) {
params.addOpt("meta_data", metaData);
return this;
}
public UpdateRequest invoiceImmediately(Boolean invoiceImmediately) {
params.addOpt("invoice_immediately", invoiceImmediately);
return this;
}
public UpdateRequest overrideRelationship(Boolean overrideRelationship) {
params.addOpt("override_relationship", overrideRelationship);
return this;
}
@Deprecated
public UpdateRequest cardGateway(com.chargebee.models.enums.Gateway cardGateway) {
params.addOpt("card[gateway]", cardGateway);
return this;
}
public UpdateRequest cardGatewayAccountId(String cardGatewayAccountId) {
params.addOpt("card[gateway_account_id]", cardGatewayAccountId);
return this;
}
@Deprecated
public UpdateRequest cardTmpToken(String cardTmpToken) {
params.addOpt("card[tmp_token]", cardTmpToken);
return this;
}
public UpdateRequest paymentMethodType(com.chargebee.models.enums.Type paymentMethodType) {
params.addOpt("payment_method[type]", paymentMethodType);
return this;
}
@Deprecated
public UpdateRequest paymentMethodGateway(com.chargebee.models.enums.Gateway paymentMethodGateway) {
params.addOpt("payment_method[gateway]", paymentMethodGateway);
return this;
}
public UpdateRequest paymentMethodGatewayAccountId(String paymentMethodGatewayAccountId) {
params.addOpt("payment_method[gateway_account_id]", paymentMethodGatewayAccountId);
return this;
}
public UpdateRequest paymentMethodReferenceId(String paymentMethodReferenceId) {
params.addOpt("payment_method[reference_id]", paymentMethodReferenceId);
return this;
}
public UpdateRequest paymentMethodTmpToken(String paymentMethodTmpToken) {
params.addOpt("payment_method[tmp_token]", paymentMethodTmpToken);
return this;
}
public UpdateRequest paymentMethodIssuingCountry(String paymentMethodIssuingCountry) {
params.addOpt("payment_method[issuing_country]", paymentMethodIssuingCountry);
return this;
}
public UpdateRequest cardFirstName(String cardFirstName) {
params.addOpt("card[first_name]", cardFirstName);
return this;
}
public UpdateRequest cardLastName(String cardLastName) {
params.addOpt("card[last_name]", cardLastName);
return this;
}
public UpdateRequest cardNumber(String cardNumber) {
params.addOpt("card[number]", cardNumber);
return this;
}
public UpdateRequest cardExpiryMonth(Integer cardExpiryMonth) {
params.addOpt("card[expiry_month]", cardExpiryMonth);
return this;
}
public UpdateRequest cardExpiryYear(Integer cardExpiryYear) {
params.addOpt("card[expiry_year]", cardExpiryYear);
return this;
}
public UpdateRequest cardCvv(String cardCvv) {
params.addOpt("card[cvv]", cardCvv);
return this;
}
public UpdateRequest cardBillingAddr1(String cardBillingAddr1) {
params.addOpt("card[billing_addr1]", cardBillingAddr1);
return this;
}
public UpdateRequest cardBillingAddr2(String cardBillingAddr2) {
params.addOpt("card[billing_addr2]", cardBillingAddr2);
return this;
}
public UpdateRequest cardBillingCity(String cardBillingCity) {
params.addOpt("card[billing_city]", cardBillingCity);
return this;
}
public UpdateRequest cardBillingStateCode(String cardBillingStateCode) {
params.addOpt("card[billing_state_code]", cardBillingStateCode);
return this;
}
public UpdateRequest cardBillingState(String cardBillingState) {
params.addOpt("card[billing_state]", cardBillingState);
return this;
}
public UpdateRequest cardBillingZip(String cardBillingZip) {
params.addOpt("card[billing_zip]", cardBillingZip);
return this;
}
public UpdateRequest cardBillingCountry(String cardBillingCountry) {
params.addOpt("card[billing_country]", cardBillingCountry);
return this;
}
@Deprecated
public UpdateRequest cardIpAddress(String cardIpAddress) {
params.addOpt("card[ip_address]", cardIpAddress);
return this;
}
public UpdateRequest paymentIntentId(String paymentIntentId) {
params.addOpt("payment_intent[id]", paymentIntentId);
return this;
}
public UpdateRequest paymentIntentGatewayAccountId(String paymentIntentGatewayAccountId) {
params.addOpt("payment_intent[gateway_account_id]", paymentIntentGatewayAccountId);
return this;
}
public UpdateRequest paymentIntentGwToken(String paymentIntentGwToken) {
params.addOpt("payment_intent[gw_token]", paymentIntentGwToken);
return this;
}
public UpdateRequest paymentIntentReferenceId(String paymentIntentReferenceId) {
params.addOpt("payment_intent[reference_id]", paymentIntentReferenceId);
return this;
}
@Deprecated
public UpdateRequest paymentIntentGwPaymentMethodId(String paymentIntentGwPaymentMethodId) {
params.addOpt("payment_intent[gw_payment_method_id]", paymentIntentGwPaymentMethodId);
return this;
}
public UpdateRequest billingAddressFirstName(String billingAddressFirstName) {
params.addOpt("billing_address[first_name]", billingAddressFirstName);
return this;
}
public UpdateRequest billingAddressLastName(String billingAddressLastName) {
params.addOpt("billing_address[last_name]", billingAddressLastName);
return this;
}
public UpdateRequest billingAddressEmail(String billingAddressEmail) {
params.addOpt("billing_address[email]", billingAddressEmail);
return this;
}
public UpdateRequest billingAddressCompany(String billingAddressCompany) {
params.addOpt("billing_address[company]", billingAddressCompany);
return this;
}
public UpdateRequest billingAddressPhone(String billingAddressPhone) {
params.addOpt("billing_address[phone]", billingAddressPhone);
return this;
}
public UpdateRequest billingAddressLine1(String billingAddressLine1) {
params.addOpt("billing_address[line1]", billingAddressLine1);
return this;
}
public UpdateRequest billingAddressLine2(String billingAddressLine2) {
params.addOpt("billing_address[line2]", billingAddressLine2);
return this;
}
public UpdateRequest billingAddressLine3(String billingAddressLine3) {
params.addOpt("billing_address[line3]", billingAddressLine3);
return this;
}
public UpdateRequest billingAddressCity(String billingAddressCity) {
params.addOpt("billing_address[city]", billingAddressCity);
return this;
}
public UpdateRequest billingAddressStateCode(String billingAddressStateCode) {
params.addOpt("billing_address[state_code]", billingAddressStateCode);
return this;
}
public UpdateRequest billingAddressState(String billingAddressState) {
params.addOpt("billing_address[state]", billingAddressState);
return this;
}
public UpdateRequest billingAddressZip(String billingAddressZip) {
params.addOpt("billing_address[zip]", billingAddressZip);
return this;
}
public UpdateRequest billingAddressCountry(String billingAddressCountry) {
params.addOpt("billing_address[country]", billingAddressCountry);
return this;
}
public UpdateRequest billingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus billingAddressValidationStatus) {
params.addOpt("billing_address[validation_status]", billingAddressValidationStatus);
return this;
}
public UpdateRequest shippingAddressFirstName(String shippingAddressFirstName) {
params.addOpt("shipping_address[first_name]", shippingAddressFirstName);
return this;
}
public UpdateRequest shippingAddressLastName(String shippingAddressLastName) {
params.addOpt("shipping_address[last_name]", shippingAddressLastName);
return this;
}
public UpdateRequest shippingAddressEmail(String shippingAddressEmail) {
params.addOpt("shipping_address[email]", shippingAddressEmail);
return this;
}
public UpdateRequest shippingAddressCompany(String shippingAddressCompany) {
params.addOpt("shipping_address[company]", shippingAddressCompany);
return this;
}
public UpdateRequest shippingAddressPhone(String shippingAddressPhone) {
params.addOpt("shipping_address[phone]", shippingAddressPhone);
return this;
}
public UpdateRequest shippingAddressLine1(String shippingAddressLine1) {
params.addOpt("shipping_address[line1]", shippingAddressLine1);
return this;
}
public UpdateRequest shippingAddressLine2(String shippingAddressLine2) {
params.addOpt("shipping_address[line2]", shippingAddressLine2);
return this;
}
public UpdateRequest shippingAddressLine3(String shippingAddressLine3) {
params.addOpt("shipping_address[line3]", shippingAddressLine3);
return this;
}
public UpdateRequest shippingAddressCity(String shippingAddressCity) {
params.addOpt("shipping_address[city]", shippingAddressCity);
return this;
}
public UpdateRequest shippingAddressStateCode(String shippingAddressStateCode) {
params.addOpt("shipping_address[state_code]", shippingAddressStateCode);
return this;
}
public UpdateRequest shippingAddressState(String shippingAddressState) {
params.addOpt("shipping_address[state]", shippingAddressState);
return this;
}
public UpdateRequest shippingAddressZip(String shippingAddressZip) {
params.addOpt("shipping_address[zip]", shippingAddressZip);
return this;
}
public UpdateRequest shippingAddressCountry(String shippingAddressCountry) {
params.addOpt("shipping_address[country]", shippingAddressCountry);
return this;
}
public UpdateRequest shippingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus shippingAddressValidationStatus) {
params.addOpt("shipping_address[validation_status]", shippingAddressValidationStatus);
return this;
}
public UpdateRequest customerVatNumber(String customerVatNumber) {
params.addOpt("customer[vat_number]", customerVatNumber);
return this;
}
public UpdateRequest customerRegisteredForGst(Boolean customerRegisteredForGst) {
params.addOpt("customer[registered_for_gst]", customerRegisteredForGst);
return this;
}
public UpdateRequest addonId(int index, String addonId) {
params.addOpt("addons[id][" + index + "]", addonId);
return this;
}
public UpdateRequest addonQuantity(int index, Integer addonQuantity) {
params.addOpt("addons[quantity][" + index + "]", addonQuantity);
return this;
}
public UpdateRequest addonUnitPrice(int index, Integer addonUnitPrice) {
params.addOpt("addons[unit_price][" + index + "]", addonUnitPrice);
return this;
}
public UpdateRequest addonBillingCycles(int index, Integer addonBillingCycles) {
params.addOpt("addons[billing_cycles][" + index + "]", addonBillingCycles);
return this;
}
public UpdateRequest eventBasedAddonId(int index, String eventBasedAddonId) {
params.addOpt("event_based_addons[id][" + index + "]", eventBasedAddonId);
return this;
}
public UpdateRequest eventBasedAddonQuantity(int index, Integer eventBasedAddonQuantity) {
params.addOpt("event_based_addons[quantity][" + index + "]", eventBasedAddonQuantity);
return this;
}
public UpdateRequest eventBasedAddonUnitPrice(int index, Integer eventBasedAddonUnitPrice) {
params.addOpt("event_based_addons[unit_price][" + index + "]", eventBasedAddonUnitPrice);
return this;
}
public UpdateRequest eventBasedAddonServicePeriodInDays(int index, Integer eventBasedAddonServicePeriodInDays) {
params.addOpt("event_based_addons[service_period_in_days][" + index + "]", eventBasedAddonServicePeriodInDays);
return this;
}
public UpdateRequest eventBasedAddonChargeOn(int index, com.chargebee.models.enums.ChargeOn eventBasedAddonChargeOn) {
params.addOpt("event_based_addons[charge_on][" + index + "]", eventBasedAddonChargeOn);
return this;
}
public UpdateRequest eventBasedAddonOnEvent(int index, com.chargebee.models.enums.OnEvent eventBasedAddonOnEvent) {
params.addOpt("event_based_addons[on_event][" + index + "]", eventBasedAddonOnEvent);
return this;
}
public UpdateRequest eventBasedAddonChargeOnce(int index, Boolean eventBasedAddonChargeOnce) {
params.addOpt("event_based_addons[charge_once][" + index + "]", eventBasedAddonChargeOnce);
return this;
}
public UpdateRequest addonTrialEnd(int index, Timestamp addonTrialEnd) {
params.addOpt("addons[trial_end][" + index + "]", addonTrialEnd);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ChangeTermEndRequest extends Request {
private ChangeTermEndRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ChangeTermEndRequest termEndsAt(Timestamp termEndsAt) {
params.add("term_ends_at", termEndsAt);
return this;
}
public ChangeTermEndRequest prorate(Boolean prorate) {
params.addOpt("prorate", prorate);
return this;
}
public ChangeTermEndRequest invoiceImmediately(Boolean invoiceImmediately) {
params.addOpt("invoice_immediately", invoiceImmediately);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class CancelRequest extends Request {
private CancelRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public CancelRequest endOfTerm(Boolean endOfTerm) {
params.addOpt("end_of_term", endOfTerm);
return this;
}
public CancelRequest creditOptionForCurrentTermCharges(com.chargebee.models.enums.CreditOptionForCurrentTermCharges creditOptionForCurrentTermCharges) {
params.addOpt("credit_option_for_current_term_charges", creditOptionForCurrentTermCharges);
return this;
}
public CancelRequest unbilledChargesOption(com.chargebee.models.enums.UnbilledChargesOption unbilledChargesOption) {
params.addOpt("unbilled_charges_option", unbilledChargesOption);
return this;
}
public CancelRequest accountReceivablesHandling(com.chargebee.models.enums.AccountReceivablesHandling accountReceivablesHandling) {
params.addOpt("account_receivables_handling", accountReceivablesHandling);
return this;
}
public CancelRequest refundableCreditsHandling(com.chargebee.models.enums.RefundableCreditsHandling refundableCreditsHandling) {
params.addOpt("refundable_credits_handling", refundableCreditsHandling);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ReactivateRequest extends Request {
private ReactivateRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ReactivateRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public ReactivateRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
@Deprecated
public ReactivateRequest trialPeriodDays(Integer trialPeriodDays) {
params.addOpt("trial_period_days", trialPeriodDays);
return this;
}
public ReactivateRequest reactivateFrom(Timestamp reactivateFrom) {
params.addOpt("reactivate_from", reactivateFrom);
return this;
}
public ReactivateRequest invoiceImmediately(Boolean invoiceImmediately) {
params.addOpt("invoice_immediately", invoiceImmediately);
return this;
}
public ReactivateRequest billingAlignmentMode(com.chargebee.models.enums.BillingAlignmentMode billingAlignmentMode) {
params.addOpt("billing_alignment_mode", billingAlignmentMode);
return this;
}
public ReactivateRequest termsToCharge(Integer termsToCharge) {
params.addOpt("terms_to_charge", termsToCharge);
return this;
}
public ReactivateRequest paymentIntentId(String paymentIntentId) {
params.addOpt("payment_intent[id]", paymentIntentId);
return this;
}
public ReactivateRequest paymentIntentGatewayAccountId(String paymentIntentGatewayAccountId) {
params.addOpt("payment_intent[gateway_account_id]", paymentIntentGatewayAccountId);
return this;
}
public ReactivateRequest paymentIntentGwToken(String paymentIntentGwToken) {
params.addOpt("payment_intent[gw_token]", paymentIntentGwToken);
return this;
}
public ReactivateRequest paymentIntentReferenceId(String paymentIntentReferenceId) {
params.addOpt("payment_intent[reference_id]", paymentIntentReferenceId);
return this;
}
@Deprecated
public ReactivateRequest paymentIntentGwPaymentMethodId(String paymentIntentGwPaymentMethodId) {
params.addOpt("payment_intent[gw_payment_method_id]", paymentIntentGwPaymentMethodId);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class AddChargeAtTermEndRequest extends Request {
private AddChargeAtTermEndRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public AddChargeAtTermEndRequest amount(Integer amount) {
params.add("amount", amount);
return this;
}
public AddChargeAtTermEndRequest description(String description) {
params.add("description", description);
return this;
}
public AddChargeAtTermEndRequest avalaraSaleType(com.chargebee.models.enums.AvalaraSaleType avalaraSaleType) {
params.addOpt("avalara_sale_type", avalaraSaleType);
return this;
}
public AddChargeAtTermEndRequest avalaraTransactionType(Integer avalaraTransactionType) {
params.addOpt("avalara_transaction_type", avalaraTransactionType);
return this;
}
public AddChargeAtTermEndRequest avalaraServiceType(Integer avalaraServiceType) {
params.addOpt("avalara_service_type", avalaraServiceType);
return this;
}
public AddChargeAtTermEndRequest dateFrom(Timestamp dateFrom) {
params.addOpt("date_from", dateFrom);
return this;
}
public AddChargeAtTermEndRequest dateTo(Timestamp dateTo) {
params.addOpt("date_to", dateTo);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ChargeAddonAtTermEndRequest extends Request {
private ChargeAddonAtTermEndRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ChargeAddonAtTermEndRequest addonId(String addonId) {
params.add("addon_id", addonId);
return this;
}
public ChargeAddonAtTermEndRequest addonQuantity(Integer addonQuantity) {
params.addOpt("addon_quantity", addonQuantity);
return this;
}
public ChargeAddonAtTermEndRequest addonUnitPrice(Integer addonUnitPrice) {
params.addOpt("addon_unit_price", addonUnitPrice);
return this;
}
public ChargeAddonAtTermEndRequest dateFrom(Timestamp dateFrom) {
params.addOpt("date_from", dateFrom);
return this;
}
public ChargeAddonAtTermEndRequest dateTo(Timestamp dateTo) {
params.addOpt("date_to", dateTo);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ChargeFutureRenewalsRequest extends Request {
private ChargeFutureRenewalsRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ChargeFutureRenewalsRequest termsToCharge(Integer termsToCharge) {
params.addOpt("terms_to_charge", termsToCharge);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ImportSubscriptionRequest extends Request {
private ImportSubscriptionRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ImportSubscriptionRequest id(String id) {
params.addOpt("id", id);
return this;
}
public ImportSubscriptionRequest clientProfileId(String clientProfileId) {
params.addOpt("client_profile_id", clientProfileId);
return this;
}
public ImportSubscriptionRequest planId(String planId) {
params.add("plan_id", planId);
return this;
}
public ImportSubscriptionRequest planQuantity(Integer planQuantity) {
params.addOpt("plan_quantity", planQuantity);
return this;
}
public ImportSubscriptionRequest planUnitPrice(Integer planUnitPrice) {
params.addOpt("plan_unit_price", planUnitPrice);
return this;
}
public ImportSubscriptionRequest setupFee(Integer setupFee) {
params.addOpt("setup_fee", setupFee);
return this;
}
public ImportSubscriptionRequest startDate(Timestamp startDate) {
params.addOpt("start_date", startDate);
return this;
}
public ImportSubscriptionRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public ImportSubscriptionRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
public ImportSubscriptionRequest autoCollection(com.chargebee.models.enums.AutoCollection autoCollection) {
params.addOpt("auto_collection", autoCollection);
return this;
}
public ImportSubscriptionRequest poNumber(String poNumber) {
params.addOpt("po_number", poNumber);
return this;
}
public ImportSubscriptionRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public ImportSubscriptionRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public ImportSubscriptionRequest status(Subscription.Status status) {
params.add("status", status);
return this;
}
public ImportSubscriptionRequest currentTermEnd(Timestamp currentTermEnd) {
params.addOpt("current_term_end", currentTermEnd);
return this;
}
public ImportSubscriptionRequest currentTermStart(Timestamp currentTermStart) {
params.addOpt("current_term_start", currentTermStart);
return this;
}
public ImportSubscriptionRequest trialStart(Timestamp trialStart) {
params.addOpt("trial_start", trialStart);
return this;
}
public ImportSubscriptionRequest cancelledAt(Timestamp cancelledAt) {
params.addOpt("cancelled_at", cancelledAt);
return this;
}
public ImportSubscriptionRequest startedAt(Timestamp startedAt) {
params.addOpt("started_at", startedAt);
return this;
}
public ImportSubscriptionRequest pauseDate(Timestamp pauseDate) {
params.addOpt("pause_date", pauseDate);
return this;
}
public ImportSubscriptionRequest resumeDate(Timestamp resumeDate) {
params.addOpt("resume_date", resumeDate);
return this;
}
public ImportSubscriptionRequest createCurrentTermInvoice(Boolean createCurrentTermInvoice) {
params.addOpt("create_current_term_invoice", createCurrentTermInvoice);
return this;
}
public ImportSubscriptionRequest affiliateToken(String affiliateToken) {
params.addOpt("affiliate_token", affiliateToken);
return this;
}
public ImportSubscriptionRequest invoiceNotes(String invoiceNotes) {
params.addOpt("invoice_notes", invoiceNotes);
return this;
}
public ImportSubscriptionRequest metaData(JSONObject metaData) {
params.addOpt("meta_data", metaData);
return this;
}
public ImportSubscriptionRequest customerId(String customerId) {
params.addOpt("customer[id]", customerId);
return this;
}
public ImportSubscriptionRequest customerEmail(String customerEmail) {
params.addOpt("customer[email]", customerEmail);
return this;
}
public ImportSubscriptionRequest customerFirstName(String customerFirstName) {
params.addOpt("customer[first_name]", customerFirstName);
return this;
}
public ImportSubscriptionRequest customerLastName(String customerLastName) {
params.addOpt("customer[last_name]", customerLastName);
return this;
}
public ImportSubscriptionRequest customerCompany(String customerCompany) {
params.addOpt("customer[company]", customerCompany);
return this;
}
public ImportSubscriptionRequest customerTaxability(com.chargebee.models.enums.Taxability customerTaxability) {
params.addOpt("customer[taxability]", customerTaxability);
return this;
}
public ImportSubscriptionRequest customerLocale(String customerLocale) {
params.addOpt("customer[locale]", customerLocale);
return this;
}
public ImportSubscriptionRequest customerEntityCode(com.chargebee.models.enums.EntityCode customerEntityCode) {
params.addOpt("customer[entity_code]", customerEntityCode);
return this;
}
public ImportSubscriptionRequest customerExemptNumber(String customerExemptNumber) {
params.addOpt("customer[exempt_number]", customerExemptNumber);
return this;
}
public ImportSubscriptionRequest customerNetTermDays(Integer customerNetTermDays) {
params.addOpt("customer[net_term_days]", customerNetTermDays);
return this;
}
public ImportSubscriptionRequest customerPhone(String customerPhone) {
params.addOpt("customer[phone]", customerPhone);
return this;
}
public ImportSubscriptionRequest customerCustomerType(com.chargebee.models.enums.CustomerType customerCustomerType) {
params.addOpt("customer[customer_type]", customerCustomerType);
return this;
}
public ImportSubscriptionRequest customerAutoCollection(com.chargebee.models.enums.AutoCollection customerAutoCollection) {
params.addOpt("customer[auto_collection]", customerAutoCollection);
return this;
}
public ImportSubscriptionRequest customerAllowDirectDebit(Boolean customerAllowDirectDebit) {
params.addOpt("customer[allow_direct_debit]", customerAllowDirectDebit);
return this;
}
@Deprecated
public ImportSubscriptionRequest cardGateway(com.chargebee.models.enums.Gateway cardGateway) {
params.addOpt("card[gateway]", cardGateway);
return this;
}
public ImportSubscriptionRequest cardGatewayAccountId(String cardGatewayAccountId) {
params.addOpt("card[gateway_account_id]", cardGatewayAccountId);
return this;
}
@Deprecated
public ImportSubscriptionRequest cardTmpToken(String cardTmpToken) {
params.addOpt("card[tmp_token]", cardTmpToken);
return this;
}
public ImportSubscriptionRequest paymentMethodType(com.chargebee.models.enums.Type paymentMethodType) {
params.addOpt("payment_method[type]", paymentMethodType);
return this;
}
@Deprecated
public ImportSubscriptionRequest paymentMethodGateway(com.chargebee.models.enums.Gateway paymentMethodGateway) {
params.addOpt("payment_method[gateway]", paymentMethodGateway);
return this;
}
public ImportSubscriptionRequest paymentMethodGatewayAccountId(String paymentMethodGatewayAccountId) {
params.addOpt("payment_method[gateway_account_id]", paymentMethodGatewayAccountId);
return this;
}
public ImportSubscriptionRequest paymentMethodReferenceId(String paymentMethodReferenceId) {
params.addOpt("payment_method[reference_id]", paymentMethodReferenceId);
return this;
}
public ImportSubscriptionRequest paymentMethodIssuingCountry(String paymentMethodIssuingCountry) {
params.addOpt("payment_method[issuing_country]", paymentMethodIssuingCountry);
return this;
}
public ImportSubscriptionRequest cardFirstName(String cardFirstName) {
params.addOpt("card[first_name]", cardFirstName);
return this;
}
public ImportSubscriptionRequest cardLastName(String cardLastName) {
params.addOpt("card[last_name]", cardLastName);
return this;
}
public ImportSubscriptionRequest cardNumber(String cardNumber) {
params.addOpt("card[number]", cardNumber);
return this;
}
public ImportSubscriptionRequest cardExpiryMonth(Integer cardExpiryMonth) {
params.addOpt("card[expiry_month]", cardExpiryMonth);
return this;
}
public ImportSubscriptionRequest cardExpiryYear(Integer cardExpiryYear) {
params.addOpt("card[expiry_year]", cardExpiryYear);
return this;
}
public ImportSubscriptionRequest cardCvv(String cardCvv) {
params.addOpt("card[cvv]", cardCvv);
return this;
}
public ImportSubscriptionRequest cardBillingAddr1(String cardBillingAddr1) {
params.addOpt("card[billing_addr1]", cardBillingAddr1);
return this;
}
public ImportSubscriptionRequest cardBillingAddr2(String cardBillingAddr2) {
params.addOpt("card[billing_addr2]", cardBillingAddr2);
return this;
}
public ImportSubscriptionRequest cardBillingCity(String cardBillingCity) {
params.addOpt("card[billing_city]", cardBillingCity);
return this;
}
public ImportSubscriptionRequest cardBillingStateCode(String cardBillingStateCode) {
params.addOpt("card[billing_state_code]", cardBillingStateCode);
return this;
}
public ImportSubscriptionRequest cardBillingState(String cardBillingState) {
params.addOpt("card[billing_state]", cardBillingState);
return this;
}
public ImportSubscriptionRequest cardBillingZip(String cardBillingZip) {
params.addOpt("card[billing_zip]", cardBillingZip);
return this;
}
public ImportSubscriptionRequest cardBillingCountry(String cardBillingCountry) {
params.addOpt("card[billing_country]", cardBillingCountry);
return this;
}
public ImportSubscriptionRequest billingAddressFirstName(String billingAddressFirstName) {
params.addOpt("billing_address[first_name]", billingAddressFirstName);
return this;
}
public ImportSubscriptionRequest billingAddressLastName(String billingAddressLastName) {
params.addOpt("billing_address[last_name]", billingAddressLastName);
return this;
}
public ImportSubscriptionRequest billingAddressEmail(String billingAddressEmail) {
params.addOpt("billing_address[email]", billingAddressEmail);
return this;
}
public ImportSubscriptionRequest billingAddressCompany(String billingAddressCompany) {
params.addOpt("billing_address[company]", billingAddressCompany);
return this;
}
public ImportSubscriptionRequest billingAddressPhone(String billingAddressPhone) {
params.addOpt("billing_address[phone]", billingAddressPhone);
return this;
}
public ImportSubscriptionRequest billingAddressLine1(String billingAddressLine1) {
params.addOpt("billing_address[line1]", billingAddressLine1);
return this;
}
public ImportSubscriptionRequest billingAddressLine2(String billingAddressLine2) {
params.addOpt("billing_address[line2]", billingAddressLine2);
return this;
}
public ImportSubscriptionRequest billingAddressLine3(String billingAddressLine3) {
params.addOpt("billing_address[line3]", billingAddressLine3);
return this;
}
public ImportSubscriptionRequest billingAddressCity(String billingAddressCity) {
params.addOpt("billing_address[city]", billingAddressCity);
return this;
}
public ImportSubscriptionRequest billingAddressStateCode(String billingAddressStateCode) {
params.addOpt("billing_address[state_code]", billingAddressStateCode);
return this;
}
public ImportSubscriptionRequest billingAddressState(String billingAddressState) {
params.addOpt("billing_address[state]", billingAddressState);
return this;
}
public ImportSubscriptionRequest billingAddressZip(String billingAddressZip) {
params.addOpt("billing_address[zip]", billingAddressZip);
return this;
}
public ImportSubscriptionRequest billingAddressCountry(String billingAddressCountry) {
params.addOpt("billing_address[country]", billingAddressCountry);
return this;
}
public ImportSubscriptionRequest billingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus billingAddressValidationStatus) {
params.addOpt("billing_address[validation_status]", billingAddressValidationStatus);
return this;
}
public ImportSubscriptionRequest shippingAddressFirstName(String shippingAddressFirstName) {
params.addOpt("shipping_address[first_name]", shippingAddressFirstName);
return this;
}
public ImportSubscriptionRequest shippingAddressLastName(String shippingAddressLastName) {
params.addOpt("shipping_address[last_name]", shippingAddressLastName);
return this;
}
public ImportSubscriptionRequest shippingAddressEmail(String shippingAddressEmail) {
params.addOpt("shipping_address[email]", shippingAddressEmail);
return this;
}
public ImportSubscriptionRequest shippingAddressCompany(String shippingAddressCompany) {
params.addOpt("shipping_address[company]", shippingAddressCompany);
return this;
}
public ImportSubscriptionRequest shippingAddressPhone(String shippingAddressPhone) {
params.addOpt("shipping_address[phone]", shippingAddressPhone);
return this;
}
public ImportSubscriptionRequest shippingAddressLine1(String shippingAddressLine1) {
params.addOpt("shipping_address[line1]", shippingAddressLine1);
return this;
}
public ImportSubscriptionRequest shippingAddressLine2(String shippingAddressLine2) {
params.addOpt("shipping_address[line2]", shippingAddressLine2);
return this;
}
public ImportSubscriptionRequest shippingAddressLine3(String shippingAddressLine3) {
params.addOpt("shipping_address[line3]", shippingAddressLine3);
return this;
}
public ImportSubscriptionRequest shippingAddressCity(String shippingAddressCity) {
params.addOpt("shipping_address[city]", shippingAddressCity);
return this;
}
public ImportSubscriptionRequest shippingAddressStateCode(String shippingAddressStateCode) {
params.addOpt("shipping_address[state_code]", shippingAddressStateCode);
return this;
}
public ImportSubscriptionRequest shippingAddressState(String shippingAddressState) {
params.addOpt("shipping_address[state]", shippingAddressState);
return this;
}
public ImportSubscriptionRequest shippingAddressZip(String shippingAddressZip) {
params.addOpt("shipping_address[zip]", shippingAddressZip);
return this;
}
public ImportSubscriptionRequest shippingAddressCountry(String shippingAddressCountry) {
params.addOpt("shipping_address[country]", shippingAddressCountry);
return this;
}
public ImportSubscriptionRequest shippingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus shippingAddressValidationStatus) {
params.addOpt("shipping_address[validation_status]", shippingAddressValidationStatus);
return this;
}
public ImportSubscriptionRequest customerVatNumber(String customerVatNumber) {
params.addOpt("customer[vat_number]", customerVatNumber);
return this;
}
public ImportSubscriptionRequest transactionAmount(Integer transactionAmount) {
params.addOpt("transaction[amount]", transactionAmount);
return this;
}
public ImportSubscriptionRequest transactionPaymentMethod(com.chargebee.models.enums.PaymentMethod transactionPaymentMethod) {
params.addOpt("transaction[payment_method]", transactionPaymentMethod);
return this;
}
public ImportSubscriptionRequest transactionReferenceNumber(String transactionReferenceNumber) {
params.addOpt("transaction[reference_number]", transactionReferenceNumber);
return this;
}
public ImportSubscriptionRequest transactionDate(Timestamp transactionDate) {
params.addOpt("transaction[date]", transactionDate);
return this;
}
public ImportSubscriptionRequest addonId(int index, String addonId) {
params.addOpt("addons[id][" + index + "]", addonId);
return this;
}
public ImportSubscriptionRequest addonQuantity(int index, Integer addonQuantity) {
params.addOpt("addons[quantity][" + index + "]", addonQuantity);
return this;
}
public ImportSubscriptionRequest addonUnitPrice(int index, Integer addonUnitPrice) {
params.addOpt("addons[unit_price][" + index + "]", addonUnitPrice);
return this;
}
public ImportSubscriptionRequest addonBillingCycles(int index, Integer addonBillingCycles) {
params.addOpt("addons[billing_cycles][" + index + "]", addonBillingCycles);
return this;
}
public ImportSubscriptionRequest eventBasedAddonId(int index, String eventBasedAddonId) {
params.addOpt("event_based_addons[id][" + index + "]", eventBasedAddonId);
return this;
}
public ImportSubscriptionRequest eventBasedAddonQuantity(int index, Integer eventBasedAddonQuantity) {
params.addOpt("event_based_addons[quantity][" + index + "]", eventBasedAddonQuantity);
return this;
}
public ImportSubscriptionRequest eventBasedAddonUnitPrice(int index, Integer eventBasedAddonUnitPrice) {
params.addOpt("event_based_addons[unit_price][" + index + "]", eventBasedAddonUnitPrice);
return this;
}
public ImportSubscriptionRequest eventBasedAddonServicePeriodInDays(int index, Integer eventBasedAddonServicePeriodInDays) {
params.addOpt("event_based_addons[service_period_in_days][" + index + "]", eventBasedAddonServicePeriodInDays);
return this;
}
public ImportSubscriptionRequest eventBasedAddonOnEvent(int index, com.chargebee.models.enums.OnEvent eventBasedAddonOnEvent) {
params.addOpt("event_based_addons[on_event][" + index + "]", eventBasedAddonOnEvent);
return this;
}
public ImportSubscriptionRequest eventBasedAddonChargeOnce(int index, Boolean eventBasedAddonChargeOnce) {
params.addOpt("event_based_addons[charge_once][" + index + "]", eventBasedAddonChargeOnce);
return this;
}
public ImportSubscriptionRequest chargedEventBasedAddonId(int index, String chargedEventBasedAddonId) {
params.addOpt("charged_event_based_addons[id][" + index + "]", chargedEventBasedAddonId);
return this;
}
public ImportSubscriptionRequest chargedEventBasedAddonLastChargedAt(int index, Timestamp chargedEventBasedAddonLastChargedAt) {
params.addOpt("charged_event_based_addons[last_charged_at][" + index + "]", chargedEventBasedAddonLastChargedAt);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ImportForCustomerRequest extends Request {
private ImportForCustomerRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ImportForCustomerRequest id(String id) {
params.addOpt("id", id);
return this;
}
public ImportForCustomerRequest planId(String planId) {
params.add("plan_id", planId);
return this;
}
public ImportForCustomerRequest planQuantity(Integer planQuantity) {
params.addOpt("plan_quantity", planQuantity);
return this;
}
public ImportForCustomerRequest planUnitPrice(Integer planUnitPrice) {
params.addOpt("plan_unit_price", planUnitPrice);
return this;
}
public ImportForCustomerRequest setupFee(Integer setupFee) {
params.addOpt("setup_fee", setupFee);
return this;
}
public ImportForCustomerRequest startDate(Timestamp startDate) {
params.addOpt("start_date", startDate);
return this;
}
public ImportForCustomerRequest trialEnd(Timestamp trialEnd) {
params.addOpt("trial_end", trialEnd);
return this;
}
public ImportForCustomerRequest billingCycles(Integer billingCycles) {
params.addOpt("billing_cycles", billingCycles);
return this;
}
public ImportForCustomerRequest autoCollection(com.chargebee.models.enums.AutoCollection autoCollection) {
params.addOpt("auto_collection", autoCollection);
return this;
}
public ImportForCustomerRequest poNumber(String poNumber) {
params.addOpt("po_number", poNumber);
return this;
}
public ImportForCustomerRequest couponIds(List couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public ImportForCustomerRequest couponIds(String... couponIds) {
params.addOpt("coupon_ids", couponIds);
return this;
}
public ImportForCustomerRequest paymentSourceId(String paymentSourceId) {
params.addOpt("payment_source_id", paymentSourceId);
return this;
}
public ImportForCustomerRequest status(Subscription.Status status) {
params.add("status", status);
return this;
}
public ImportForCustomerRequest currentTermEnd(Timestamp currentTermEnd) {
params.addOpt("current_term_end", currentTermEnd);
return this;
}
public ImportForCustomerRequest currentTermStart(Timestamp currentTermStart) {
params.addOpt("current_term_start", currentTermStart);
return this;
}
public ImportForCustomerRequest trialStart(Timestamp trialStart) {
params.addOpt("trial_start", trialStart);
return this;
}
public ImportForCustomerRequest cancelledAt(Timestamp cancelledAt) {
params.addOpt("cancelled_at", cancelledAt);
return this;
}
public ImportForCustomerRequest startedAt(Timestamp startedAt) {
params.addOpt("started_at", startedAt);
return this;
}
public ImportForCustomerRequest pauseDate(Timestamp pauseDate) {
params.addOpt("pause_date", pauseDate);
return this;
}
public ImportForCustomerRequest resumeDate(Timestamp resumeDate) {
params.addOpt("resume_date", resumeDate);
return this;
}
public ImportForCustomerRequest createCurrentTermInvoice(Boolean createCurrentTermInvoice) {
params.addOpt("create_current_term_invoice", createCurrentTermInvoice);
return this;
}
public ImportForCustomerRequest invoiceNotes(String invoiceNotes) {
params.addOpt("invoice_notes", invoiceNotes);
return this;
}
public ImportForCustomerRequest metaData(JSONObject metaData) {
params.addOpt("meta_data", metaData);
return this;
}
public ImportForCustomerRequest transactionAmount(Integer transactionAmount) {
params.addOpt("transaction[amount]", transactionAmount);
return this;
}
public ImportForCustomerRequest transactionPaymentMethod(com.chargebee.models.enums.PaymentMethod transactionPaymentMethod) {
params.addOpt("transaction[payment_method]", transactionPaymentMethod);
return this;
}
public ImportForCustomerRequest transactionReferenceNumber(String transactionReferenceNumber) {
params.addOpt("transaction[reference_number]", transactionReferenceNumber);
return this;
}
public ImportForCustomerRequest transactionDate(Timestamp transactionDate) {
params.addOpt("transaction[date]", transactionDate);
return this;
}
public ImportForCustomerRequest shippingAddressFirstName(String shippingAddressFirstName) {
params.addOpt("shipping_address[first_name]", shippingAddressFirstName);
return this;
}
public ImportForCustomerRequest shippingAddressLastName(String shippingAddressLastName) {
params.addOpt("shipping_address[last_name]", shippingAddressLastName);
return this;
}
public ImportForCustomerRequest shippingAddressEmail(String shippingAddressEmail) {
params.addOpt("shipping_address[email]", shippingAddressEmail);
return this;
}
public ImportForCustomerRequest shippingAddressCompany(String shippingAddressCompany) {
params.addOpt("shipping_address[company]", shippingAddressCompany);
return this;
}
public ImportForCustomerRequest shippingAddressPhone(String shippingAddressPhone) {
params.addOpt("shipping_address[phone]", shippingAddressPhone);
return this;
}
public ImportForCustomerRequest shippingAddressLine1(String shippingAddressLine1) {
params.addOpt("shipping_address[line1]", shippingAddressLine1);
return this;
}
public ImportForCustomerRequest shippingAddressLine2(String shippingAddressLine2) {
params.addOpt("shipping_address[line2]", shippingAddressLine2);
return this;
}
public ImportForCustomerRequest shippingAddressLine3(String shippingAddressLine3) {
params.addOpt("shipping_address[line3]", shippingAddressLine3);
return this;
}
public ImportForCustomerRequest shippingAddressCity(String shippingAddressCity) {
params.addOpt("shipping_address[city]", shippingAddressCity);
return this;
}
public ImportForCustomerRequest shippingAddressStateCode(String shippingAddressStateCode) {
params.addOpt("shipping_address[state_code]", shippingAddressStateCode);
return this;
}
public ImportForCustomerRequest shippingAddressState(String shippingAddressState) {
params.addOpt("shipping_address[state]", shippingAddressState);
return this;
}
public ImportForCustomerRequest shippingAddressZip(String shippingAddressZip) {
params.addOpt("shipping_address[zip]", shippingAddressZip);
return this;
}
public ImportForCustomerRequest shippingAddressCountry(String shippingAddressCountry) {
params.addOpt("shipping_address[country]", shippingAddressCountry);
return this;
}
public ImportForCustomerRequest shippingAddressValidationStatus(com.chargebee.models.enums.ValidationStatus shippingAddressValidationStatus) {
params.addOpt("shipping_address[validation_status]", shippingAddressValidationStatus);
return this;
}
public ImportForCustomerRequest addonId(int index, String addonId) {
params.addOpt("addons[id][" + index + "]", addonId);
return this;
}
public ImportForCustomerRequest addonQuantity(int index, Integer addonQuantity) {
params.addOpt("addons[quantity][" + index + "]", addonQuantity);
return this;
}
public ImportForCustomerRequest addonUnitPrice(int index, Integer addonUnitPrice) {
params.addOpt("addons[unit_price][" + index + "]", addonUnitPrice);
return this;
}
public ImportForCustomerRequest addonBillingCycles(int index, Integer addonBillingCycles) {
params.addOpt("addons[billing_cycles][" + index + "]", addonBillingCycles);
return this;
}
public ImportForCustomerRequest eventBasedAddonId(int index, String eventBasedAddonId) {
params.addOpt("event_based_addons[id][" + index + "]", eventBasedAddonId);
return this;
}
public ImportForCustomerRequest eventBasedAddonQuantity(int index, Integer eventBasedAddonQuantity) {
params.addOpt("event_based_addons[quantity][" + index + "]", eventBasedAddonQuantity);
return this;
}
public ImportForCustomerRequest eventBasedAddonUnitPrice(int index, Integer eventBasedAddonUnitPrice) {
params.addOpt("event_based_addons[unit_price][" + index + "]", eventBasedAddonUnitPrice);
return this;
}
public ImportForCustomerRequest eventBasedAddonServicePeriodInDays(int index, Integer eventBasedAddonServicePeriodInDays) {
params.addOpt("event_based_addons[service_period_in_days][" + index + "]", eventBasedAddonServicePeriodInDays);
return this;
}
public ImportForCustomerRequest eventBasedAddonOnEvent(int index, com.chargebee.models.enums.OnEvent eventBasedAddonOnEvent) {
params.addOpt("event_based_addons[on_event][" + index + "]", eventBasedAddonOnEvent);
return this;
}
public ImportForCustomerRequest eventBasedAddonChargeOnce(int index, Boolean eventBasedAddonChargeOnce) {
params.addOpt("event_based_addons[charge_once][" + index + "]", eventBasedAddonChargeOnce);
return this;
}
public ImportForCustomerRequest chargedEventBasedAddonId(int index, String chargedEventBasedAddonId) {
params.addOpt("charged_event_based_addons[id][" + index + "]", chargedEventBasedAddonId);
return this;
}
public ImportForCustomerRequest chargedEventBasedAddonLastChargedAt(int index, Timestamp chargedEventBasedAddonLastChargedAt) {
params.addOpt("charged_event_based_addons[last_charged_at][" + index + "]", chargedEventBasedAddonLastChargedAt);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class OverrideBillingProfileRequest extends Request {
private OverrideBillingProfileRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public OverrideBillingProfileRequest paymentSourceId(String paymentSourceId) {
params.addOpt("payment_source_id", paymentSourceId);
return this;
}
public OverrideBillingProfileRequest autoCollection(com.chargebee.models.enums.AutoCollection autoCollection) {
params.addOpt("auto_collection", autoCollection);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class PauseRequest extends Request {
private PauseRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public PauseRequest pauseOption(com.chargebee.models.enums.PauseOption pauseOption) {
params.addOpt("pause_option", pauseOption);
return this;
}
public PauseRequest pauseDate(Timestamp pauseDate) {
params.addOpt("pause_date", pauseDate);
return this;
}
public PauseRequest unbilledChargesHandling(com.chargebee.models.enums.UnbilledChargesHandling unbilledChargesHandling) {
params.addOpt("unbilled_charges_handling", unbilledChargesHandling);
return this;
}
public PauseRequest invoiceDunningHandling(com.chargebee.models.enums.InvoiceDunningHandling invoiceDunningHandling) {
params.addOpt("invoice_dunning_handling", invoiceDunningHandling);
return this;
}
public PauseRequest resumeDate(Timestamp resumeDate) {
params.addOpt("resume_date", resumeDate);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class ResumeRequest extends Request {
private ResumeRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public ResumeRequest resumeOption(com.chargebee.models.enums.ResumeOption resumeOption) {
params.addOpt("resume_option", resumeOption);
return this;
}
public ResumeRequest resumeDate(Timestamp resumeDate) {
params.addOpt("resume_date", resumeDate);
return this;
}
public ResumeRequest chargesHandling(com.chargebee.models.enums.ChargesHandling chargesHandling) {
params.addOpt("charges_handling", chargesHandling);
return this;
}
public ResumeRequest unpaidInvoicesHandling(com.chargebee.models.enums.UnpaidInvoicesHandling unpaidInvoicesHandling) {
params.addOpt("unpaid_invoices_handling", unpaidInvoicesHandling);
return this;
}
public ResumeRequest paymentIntentId(String paymentIntentId) {
params.addOpt("payment_intent[id]", paymentIntentId);
return this;
}
public ResumeRequest paymentIntentGatewayAccountId(String paymentIntentGatewayAccountId) {
params.addOpt("payment_intent[gateway_account_id]", paymentIntentGatewayAccountId);
return this;
}
public ResumeRequest paymentIntentGwToken(String paymentIntentGwToken) {
params.addOpt("payment_intent[gw_token]", paymentIntentGwToken);
return this;
}
public ResumeRequest paymentIntentReferenceId(String paymentIntentReferenceId) {
params.addOpt("payment_intent[reference_id]", paymentIntentReferenceId);
return this;
}
@Deprecated
public ResumeRequest paymentIntentGwPaymentMethodId(String paymentIntentGwPaymentMethodId) {
params.addOpt("payment_intent[gw_payment_method_id]", paymentIntentGwPaymentMethodId);
return this;
}
@Override
public Params params() {
return params;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy