com.chargebee.models.QuotedSubscription 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.sql.Timestamp;
import java.util.*;
public class QuotedSubscription extends Resource {
public enum ChangeOption {
END_OF_TERM,
SPECIFIC_DATE,
IMMEDIATELY,
_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 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 static class Addon extends Resource {
public Addon(JSONObject jsonObj) {
super(jsonObj);
}
public String id() {
return reqString("id");
}
public Integer quantity() {
return optInteger("quantity");
}
public Long unitPrice() {
return optLong("unit_price");
}
public Long amount() {
return optLong("amount");
}
public Timestamp trialEnd() {
return optTimestamp("trial_end");
}
public Integer remainingBillingCycles() {
return optInteger("remaining_billing_cycles");
}
public String quantityInDecimal() {
return optString("quantity_in_decimal");
}
public String unitPriceInDecimal() {
return optString("unit_price_in_decimal");
}
public String amountInDecimal() {
return optString("amount_in_decimal");
}
public ProrationType prorationType() {
return optEnum("proration_type", ProrationType.class);
}
}
public static class EventBasedAddon extends Resource {
public enum OnEvent {
SUBSCRIPTION_CREATION,SUBSCRIPTION_TRIAL_START,PLAN_ACTIVATION,SUBSCRIPTION_ACTIVATION,CONTRACT_TERMINATION,
_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 Long unitPrice() {
return reqLong("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 String quantityInDecimal() {
return optString("quantity_in_decimal");
}
public String unitPriceInDecimal() {
return optString("unit_price_in_decimal");
}
}
public static class Coupon extends Resource {
public Coupon(JSONObject jsonObj) {
super(jsonObj);
}
public String couponId() {
return reqString("coupon_id");
}
}
public static class SubscriptionItem extends Resource {
public enum ItemType {
PLAN,ADDON,CHARGE,
_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 ChargeOnOption {
IMMEDIATELY,ON_EVENT,
_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 SubscriptionItem(JSONObject jsonObj) {
super(jsonObj);
}
public String itemPriceId() {
return reqString("item_price_id");
}
public ItemType itemType() {
return reqEnum("item_type", ItemType.class);
}
public Integer quantity() {
return optInteger("quantity");
}
public String quantityInDecimal() {
return optString("quantity_in_decimal");
}
@Deprecated
public String meteredQuantity() {
return optString("metered_quantity");
}
@Deprecated
public Timestamp lastCalculatedAt() {
return optTimestamp("last_calculated_at");
}
public Long unitPrice() {
return optLong("unit_price");
}
public String unitPriceInDecimal() {
return optString("unit_price_in_decimal");
}
public Long amount() {
return optLong("amount");
}
public String amountInDecimal() {
return optString("amount_in_decimal");
}
public Integer freeQuantity() {
return optInteger("free_quantity");
}
public String freeQuantityInDecimal() {
return optString("free_quantity_in_decimal");
}
public Timestamp trialEnd() {
return optTimestamp("trial_end");
}
public Integer billingCycles() {
return optInteger("billing_cycles");
}
public Integer servicePeriodDays() {
return optInteger("service_period_days");
}
public ChargeOnEvent chargeOnEvent() {
return optEnum("charge_on_event", ChargeOnEvent.class);
}
public Boolean chargeOnce() {
return optBoolean("charge_once");
}
public ChargeOnOption chargeOnOption() {
return optEnum("charge_on_option", ChargeOnOption.class);
}
public ProrationType prorationType() {
return optEnum("proration_type", ProrationType.class);
}
}
public static class ItemTier extends Resource {
public ItemTier(JSONObject jsonObj) {
super(jsonObj);
}
public String itemPriceId() {
return reqString("item_price_id");
}
public Integer startingUnit() {
return reqInteger("starting_unit");
}
public Integer endingUnit() {
return optInteger("ending_unit");
}
public Long price() {
return reqLong("price");
}
public String startingUnitInDecimal() {
return optString("starting_unit_in_decimal");
}
public String endingUnitInDecimal() {
return optString("ending_unit_in_decimal");
}
public String priceInDecimal() {
return optString("price_in_decimal");
}
public Integer index() {
return reqInteger("index");
}
}
public static class QuotedContractTerm extends Resource {
public enum ActionAtTermEnd {
RENEW,EVERGREEN,CANCEL,RENEW_ONCE,
_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 QuotedContractTerm(JSONObject jsonObj) {
super(jsonObj);
}
public Timestamp contractStart() {
return reqTimestamp("contract_start");
}
public Timestamp contractEnd() {
return reqTimestamp("contract_end");
}
public Integer billingCycle() {
return reqInteger("billing_cycle");
}
public ActionAtTermEnd actionAtTermEnd() {
return reqEnum("action_at_term_end", ActionAtTermEnd.class);
}
public Long totalContractValue() {
return reqLong("total_contract_value");
}
public Integer cancellationCutoffPeriod() {
return optInteger("cancellation_cutoff_period");
}
}
//Constructors
//============
public QuotedSubscription(String jsonStr) {
super(jsonStr);
}
public QuotedSubscription(JSONObject jsonObj) {
super(jsonObj);
}
// Fields
//=======
public String id() {
return reqString("id");
}
public String planId() {
return reqString("plan_id");
}
public Integer planQuantity() {
return reqInteger("plan_quantity");
}
public Long planUnitPrice() {
return optLong("plan_unit_price");
}
public Long setupFee() {
return optLong("setup_fee");
}
public Integer billingPeriod() {
return optInteger("billing_period");
}
public BillingPeriodUnit billingPeriodUnit() {
return optEnum("billing_period_unit", BillingPeriodUnit.class);
}
public Timestamp startDate() {
return optTimestamp("start_date");
}
public Timestamp trialEnd() {
return optTimestamp("trial_end");
}
public Integer remainingBillingCycles() {
return optInteger("remaining_billing_cycles");
}
public String poNumber() {
return optString("po_number");
}
public AutoCollection autoCollection() {
return optEnum("auto_collection", AutoCollection.class);
}
public String planQuantityInDecimal() {
return optString("plan_quantity_in_decimal");
}
public String planUnitPriceInDecimal() {
return optString("plan_unit_price_in_decimal");
}
public Timestamp changesScheduledAt() {
return optTimestamp("changes_scheduled_at");
}
public ChangeOption changeOption() {
return optEnum("change_option", ChangeOption.class);
}
public Integer contractTermBillingCycleOnRenewal() {
return optInteger("contract_term_billing_cycle_on_renewal");
}
public List addons() {
return optList("addons", QuotedSubscription.Addon.class);
}
public List eventBasedAddons() {
return optList("event_based_addons", QuotedSubscription.EventBasedAddon.class);
}
public List coupons() {
return optList("coupons", QuotedSubscription.Coupon.class);
}
public List subscriptionItems() {
return optList("subscription_items", QuotedSubscription.SubscriptionItem.class);
}
public List itemTiers() {
return optList("item_tiers", QuotedSubscription.ItemTier.class);
}
public QuotedSubscription.QuotedContractTerm quotedContractTerm() {
return optSubResource("quoted_contract_term", QuotedSubscription.QuotedContractTerm.class);
}
// Operations
//===========
}