com.recurly.v3.requests.PlanPricing 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
The official Java client for Recurly's V3 API.
There is a newer version: 4.58.0
/**
 * 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.Request;
import com.recurly.v3.resources.*;
import java.math.BigDecimal;

public class PlanPricing extends Request {

  /** 3-letter ISO 4217 currency code. */
  @SerializedName("currency")
  @Expose
  private String currency;

  /**
   * Amount of one-time setup fee automatically charged at the beginning of a subscription billing
   * cycle. For subscription plans with a trial, the setup fee will be charged at the time of
   * signup. Setup fees do not increase with the quantity of a subscription plan.
   */
  @SerializedName("setup_fee")
  @Expose
  private BigDecimal setupFee;

  /** This field is deprecated. Please do not use it. */
  @SerializedName("tax_inclusive")
  @Expose
  private Boolean taxInclusive;

  /** This field should not be sent when the pricing model is 'ramp'. */
  @SerializedName("unit_amount")
  @Expose
  private BigDecimal unitAmount;

  /** 3-letter ISO 4217 currency code. */
  public String getCurrency() {
    return this.currency;
  }

  /** @param currency 3-letter ISO 4217 currency code. */
  public void setCurrency(final String currency) {
    this.currency = currency;
  }

  /**
   * Amount of one-time setup fee automatically charged at the beginning of a subscription billing
   * cycle. For subscription plans with a trial, the setup fee will be charged at the time of
   * signup. Setup fees do not increase with the quantity of a subscription plan.
   */
  public BigDecimal getSetupFee() {
    return this.setupFee;
  }

  /**
   * @param setupFee Amount of one-time setup fee automatically charged at the beginning of a
   *     subscription billing cycle. For subscription plans with a trial, the setup fee will be
   *     charged at the time of signup. Setup fees do not increase with the quantity of a
   *     subscription plan.
   */
  public void setSetupFee(final BigDecimal setupFee) {
    this.setupFee = setupFee;
  }

  /** This field is deprecated. Please do not use it. */
  public Boolean getTaxInclusive() {
    return this.taxInclusive;
  }

  /** @param taxInclusive This field is deprecated. Please do not use it. */
  public void setTaxInclusive(final Boolean taxInclusive) {
    this.taxInclusive = taxInclusive;
  }

  /** This field should not be sent when the pricing model is 'ramp'. */
  public BigDecimal getUnitAmount() {
    return this.unitAmount;
  }

  /** @param unitAmount This field should not be sent when the pricing model is 'ramp'. */
  public void setUnitAmount(final BigDecimal unitAmount) {
    this.unitAmount = unitAmount;
  }
}