com.recurly.v3.requests.AddOnCreate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation
Show all versions of api-client Show documentation
The official Java client for Recurly's V3 API.
/**
* This file is automatically created by Recurly's OpenAPI generation process and thus any edits you
* make by hand will be lost. If you wish to make a change to this file, please create a Github
* issue explaining the changes you need and we will usher them to the appropriate places.
*/
package com.recurly.v3.requests;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import com.recurly.v3.Constants;
import com.recurly.v3.Request;
import com.recurly.v3.resources.*;
import java.math.BigDecimal;
import java.util.List;
public class AddOnCreate extends Request {
/**
* Accounting code for invoice line items for this add-on. If no value is provided, it defaults to
* add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be
* absent.
*/
@SerializedName("accounting_code")
@Expose
private String accountingCode;
/** Whether the add-on type is fixed, or usage-based. */
@SerializedName("add_on_type")
@Expose
private Constants.AddOnTypeCreate addOnType;
/**
* Used by Avalara for Communications taxes. The transaction type in combination with the service
* type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_service_type` must be absent.
*/
@SerializedName("avalara_service_type")
@Expose
private Integer avalaraServiceType;
/**
* Used by Avalara for Communications taxes. The transaction type in combination with the service
* type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_transaction_type` must be absent.
*/
@SerializedName("avalara_transaction_type")
@Expose
private Integer avalaraTransactionType;
/**
* The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the
* request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
*/
@SerializedName("code")
@Expose
private String code;
/**
* * If `item_code`/`item_id` is part of the request and the item has a default currency then
* `currencies` is optional. If the item does not have a default currency, then `currencies` is
* required. If `item_code`/`item_id` is not present `currencies` is required. If the add-on's
* `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. Must be
* absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
*/
@SerializedName("currencies")
@Expose
private List currencies;
/** Default quantity for the hosted pages. */
@SerializedName("default_quantity")
@Expose
private Integer defaultQuantity;
/** Determines if the quantity field is displayed on the hosted pages for the add-on. */
@SerializedName("display_quantity")
@Expose
private Boolean displayQuantity;
/**
* Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If
* `item_id` and `item_code` are both present, `item_id` will be used.
*/
@SerializedName("item_code")
@Expose
private String itemCode;
/**
* System-generated unique identifier for an item. Available when the `Credit Invoices` feature is
* enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
*/
@SerializedName("item_id")
@Expose
private String itemId;
/**
* System-generated unique identifier for a measured unit to be associated with the add-on. Either
* `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If
* `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
*/
@SerializedName("measured_unit_id")
@Expose
private String measuredUnitId;
/**
* Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or
* `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and
* `measured_unit_name` are both present, `measured_unit_id` will be used.
*/
@SerializedName("measured_unit_name")
@Expose
private String measuredUnitName;
/**
* Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is
* part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name`
* is required.
*/
@SerializedName("name")
@Expose
private String name;
/**
* Whether the add-on is optional for the customer to include in their purchase on the hosted
* payment page. If false, the add-on will be included when a subscription is created through the
* Recurly UI. However, the add-on will not be included when a subscription is created through the
* API.
*/
@SerializedName("optional")
@Expose
private Boolean optional;
/**
* Array of objects which must have at least one set of tiers per currency and the currency code.
* The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier
* without an `ending_amount` value which represents the final tier. This feature is currently in
* development and requires approval and enablement, please contact support.
*/
@SerializedName("percentage_tiers")
@Expose
private List percentageTiers;
/** Plan ID */
@SerializedName("plan_id")
@Expose
private String planId;
/**
* When this add-on is invoiced, the line item will use this revenue schedule. If
* `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the
* request as the value will be set from the item.
*/
@SerializedName("revenue_schedule_type")
@Expose
private Constants.RevenueScheduleType revenueScheduleType;
/**
* Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation
* rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign
* specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`,
* `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must
* be absent.
*/
@SerializedName("tax_code")
@Expose
private String taxCode;
/**
* The pricing model for the add-on. For more information, [click
* here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
* [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to
* configure quantity-based pricing models.
*/
@SerializedName("tier_type")
@Expose
private Constants.TierType tierType;
/**
* If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to
* many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be
* one tier without an `ending_quantity` value which represents the final tier.
*/
@SerializedName("tiers")
@Expose
private List tiers;
/**
* The type of calculation to be employed for an add-on. Cumulative billing will sum all usage
* records created in the current billing cycle. Last-in-period billing will apply only the most
* recent usage record in the billing period. If no value is specified, cumulative billing will be
* used.
*/
@SerializedName("usage_calculation_type")
@Expose
private Constants.UsageCalculationType usageCalculationType;
/**
* The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal
* places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is
* `flat` and `usage_type` is percentage. Must be omitted otherwise.
*/
@SerializedName("usage_percentage")
@Expose
private BigDecimal usagePercentage;
/**
* The time at which usage totals are reset for billing purposes. Allows for `tiered` add-ons to
* accumulate usage over the course of multiple billing periods.
*/
@SerializedName("usage_timeframe")
@Expose
private Constants.UsageTimeframeCreate usageTimeframe;
/**
* Type of usage, required if `add_on_type` is `usage`. See our
* [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview
* of how to configure usage add-ons.
*/
@SerializedName("usage_type")
@Expose
private Constants.UsageTypeCreate usageType;
/**
* Accounting code for invoice line items for this add-on. If no value is provided, it defaults to
* add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be
* absent.
*/
public String getAccountingCode() {
return this.accountingCode;
}
/**
* @param accountingCode Accounting code for invoice line items for this add-on. If no value is
* provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request
* then `accounting_code` must be absent.
*/
public void setAccountingCode(final String accountingCode) {
this.accountingCode = accountingCode;
}
/** Whether the add-on type is fixed, or usage-based. */
public Constants.AddOnTypeCreate getAddOnType() {
return this.addOnType;
}
/** @param addOnType Whether the add-on type is fixed, or usage-based. */
public void setAddOnType(final Constants.AddOnTypeCreate addOnType) {
this.addOnType = addOnType;
}
/**
* Used by Avalara for Communications taxes. The transaction type in combination with the service
* type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_service_type` must be absent.
*/
public Integer getAvalaraServiceType() {
return this.avalaraServiceType;
}
/**
* @param avalaraServiceType Used by Avalara for Communications taxes. The transaction type in
* combination with the service type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_service_type` must be absent.
*/
public void setAvalaraServiceType(final Integer avalaraServiceType) {
this.avalaraServiceType = avalaraServiceType;
}
/**
* Used by Avalara for Communications taxes. The transaction type in combination with the service
* type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_transaction_type` must be absent.
*/
public Integer getAvalaraTransactionType() {
return this.avalaraTransactionType;
}
/**
* @param avalaraTransactionType Used by Avalara for Communications taxes. The transaction type in
* combination with the service type describe how the add-on is taxed. Refer to [the
* documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
* for more available t/s types. If an `Item` is associated to the `AddOn`, then the
* `avalara_transaction_type` must be absent.
*/
public void setAvalaraTransactionType(final Integer avalaraTransactionType) {
this.avalaraTransactionType = avalaraTransactionType;
}
/**
* The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the
* request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
*/
public String getCode() {
return this.code;
}
/**
* @param code The unique identifier for the add-on within its plan. If `item_code`/`item_id` is
* part of the request then `code` must be absent. If `item_code`/`item_id` is not present
* `code` is required.
*/
public void setCode(final String code) {
this.code = code;
}
/**
* * If `item_code`/`item_id` is part of the request and the item has a default currency then
* `currencies` is optional. If the item does not have a default currency, then `currencies` is
* required. If `item_code`/`item_id` is not present `currencies` is required. If the add-on's
* `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. Must be
* absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
*/
public List getCurrencies() {
return this.currencies;
}
/**
* @param currencies * If `item_code`/`item_id` is part of the request and the item has a default
* currency then `currencies` is optional. If the item does not have a default currency, then
* `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required.
* If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must
* be absent. Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
*/
public void setCurrencies(final List currencies) {
this.currencies = currencies;
}
/** Default quantity for the hosted pages. */
public Integer getDefaultQuantity() {
return this.defaultQuantity;
}
/** @param defaultQuantity Default quantity for the hosted pages. */
public void setDefaultQuantity(final Integer defaultQuantity) {
this.defaultQuantity = defaultQuantity;
}
/** Determines if the quantity field is displayed on the hosted pages for the add-on. */
public Boolean getDisplayQuantity() {
return this.displayQuantity;
}
/**
* @param displayQuantity Determines if the quantity field is displayed on the hosted pages for
* the add-on.
*/
public void setDisplayQuantity(final Boolean displayQuantity) {
this.displayQuantity = displayQuantity;
}
/**
* Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If
* `item_id` and `item_code` are both present, `item_id` will be used.
*/
public String getItemCode() {
return this.itemCode;
}
/**
* @param itemCode Unique code to identify an item. Available when the `Credit Invoices` feature
* are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
*/
public void setItemCode(final String itemCode) {
this.itemCode = itemCode;
}
/**
* System-generated unique identifier for an item. Available when the `Credit Invoices` feature is
* enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
*/
public String getItemId() {
return this.itemId;
}
/**
* @param itemId System-generated unique identifier for an item. Available when the `Credit
* Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will
* be used.
*/
public void setItemId(final String itemId) {
this.itemId = itemId;
}
/**
* System-generated unique identifier for a measured unit to be associated with the add-on. Either
* `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If
* `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
*/
public String getMeasuredUnitId() {
return this.measuredUnitId;
}
/**
* @param measuredUnitId System-generated unique identifier for a measured unit to be associated
* with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when
* `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present,
* `measured_unit_id` will be used.
*/
public void setMeasuredUnitId(final String measuredUnitId) {
this.measuredUnitId = measuredUnitId;
}
/**
* Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or
* `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and
* `measured_unit_name` are both present, `measured_unit_id` will be used.
*/
public String getMeasuredUnitName() {
return this.measuredUnitName;
}
/**
* @param measuredUnitName Name of a measured unit to be associated with the add-on. Either
* `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If
* `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be
* used.
*/
public void setMeasuredUnitName(final String measuredUnitName) {
this.measuredUnitName = measuredUnitName;
}
/**
* Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is
* part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name`
* is required.
*/
public String getName() {
return this.name;
}
/**
* @param name Describes your add-on and will appear in subscribers' invoices. If
* `item_code`/`item_id` is part of the request then `name` must be absent. If
* `item_code`/`item_id` is not present `name` is required.
*/
public void setName(final String name) {
this.name = name;
}
/**
* Whether the add-on is optional for the customer to include in their purchase on the hosted
* payment page. If false, the add-on will be included when a subscription is created through the
* Recurly UI. However, the add-on will not be included when a subscription is created through the
* API.
*/
public Boolean getOptional() {
return this.optional;
}
/**
* @param optional Whether the add-on is optional for the customer to include in their purchase on
* the hosted payment page. If false, the add-on will be included when a subscription is
* created through the Recurly UI. However, the add-on will not be included when a
* subscription is created through the API.
*/
public void setOptional(final Boolean optional) {
this.optional = optional;
}
/**
* Array of objects which must have at least one set of tiers per currency and the currency code.
* The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier
* without an `ending_amount` value which represents the final tier. This feature is currently in
* development and requires approval and enablement, please contact support.
*/
public List getPercentageTiers() {
return this.percentageTiers;
}
/**
* @param percentageTiers Array of objects which must have at least one set of tiers per currency
* and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be
* absent. There must be one tier without an `ending_amount` value which represents the final
* tier. This feature is currently in development and requires approval and enablement, please
* contact support.
*/
public void setPercentageTiers(final List percentageTiers) {
this.percentageTiers = percentageTiers;
}
/** Plan ID */
public String getPlanId() {
return this.planId;
}
/** @param planId Plan ID */
public void setPlanId(final String planId) {
this.planId = planId;
}
/**
* When this add-on is invoiced, the line item will use this revenue schedule. If
* `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the
* request as the value will be set from the item.
*/
public Constants.RevenueScheduleType getRevenueScheduleType() {
return this.revenueScheduleType;
}
/**
* @param revenueScheduleType When this add-on is invoiced, the line item will use this revenue
* schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must
* be absent in the request as the value will be set from the item.
*/
public void setRevenueScheduleType(final Constants.RevenueScheduleType revenueScheduleType) {
this.revenueScheduleType = revenueScheduleType;
}
/**
* Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation
* rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign
* specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`,
* `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must
* be absent.
*/
public String getTaxCode() {
return this.taxCode;
}
/**
* @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to
* determine taxation rules. If you have your own AvaTax or Vertex account configured, use
* their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature,
* you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part
* of the request then `tax_code` must be absent.
*/
public void setTaxCode(final String taxCode) {
this.taxCode = taxCode;
}
/**
* The pricing model for the add-on. For more information, [click
* here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
* [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to
* configure quantity-based pricing models.
*/
public Constants.TierType getTierType() {
return this.tierType;
}
/**
* @param tierType The pricing model for the add-on. For more information, [click
* here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
* [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
* to configure quantity-based pricing models.
*/
public void setTierType(final Constants.TierType tierType) {
this.tierType = tierType;
}
/**
* If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to
* many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be
* one tier without an `ending_quantity` value which represents the final tier.
*/
public List getTiers() {
return this.tiers;
}
/**
* @param tiers If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must
* include one to many tiers with `ending_quantity` and `unit_amount` for the desired
* `currencies`. There must be one tier without an `ending_quantity` value which represents
* the final tier.
*/
public void setTiers(final List tiers) {
this.tiers = tiers;
}
/**
* The type of calculation to be employed for an add-on. Cumulative billing will sum all usage
* records created in the current billing cycle. Last-in-period billing will apply only the most
* recent usage record in the billing period. If no value is specified, cumulative billing will be
* used.
*/
public Constants.UsageCalculationType getUsageCalculationType() {
return this.usageCalculationType;
}
/**
* @param usageCalculationType The type of calculation to be employed for an add-on. Cumulative
* billing will sum all usage records created in the current billing cycle. Last-in-period
* billing will apply only the most recent usage record in the billing period. If no value is
* specified, cumulative billing will be used.
*/
public void setUsageCalculationType(final Constants.UsageCalculationType usageCalculationType) {
this.usageCalculationType = usageCalculationType;
}
/**
* The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal
* places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is
* `flat` and `usage_type` is percentage. Must be omitted otherwise.
*/
public BigDecimal getUsagePercentage() {
return this.usagePercentage;
}
/**
* @param usagePercentage The percentage taken of the monetary amount of usage tracked. This can
* be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is
* usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
*/
public void setUsagePercentage(final BigDecimal usagePercentage) {
this.usagePercentage = usagePercentage;
}
/**
* The time at which usage totals are reset for billing purposes. Allows for `tiered` add-ons to
* accumulate usage over the course of multiple billing periods.
*/
public Constants.UsageTimeframeCreate getUsageTimeframe() {
return this.usageTimeframe;
}
/**
* @param usageTimeframe The time at which usage totals are reset for billing purposes. Allows for
* `tiered` add-ons to accumulate usage over the course of multiple billing periods.
*/
public void setUsageTimeframe(final Constants.UsageTimeframeCreate usageTimeframe) {
this.usageTimeframe = usageTimeframe;
}
/**
* Type of usage, required if `add_on_type` is `usage`. See our
* [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview
* of how to configure usage add-ons.
*/
public Constants.UsageTypeCreate getUsageType() {
return this.usageType;
}
/**
* @param usageType Type of usage, required if `add_on_type` is `usage`. See our
* [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an
* overview of how to configure usage add-ons.
*/
public void setUsageType(final Constants.UsageTypeCreate usageType) {
this.usageType = usageType;
}
}