Class PlanUpdateParams


public class PlanUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static PlanUpdateParams.Builder builder()
    • getActive

      public Boolean getActive()
      Whether the plan is currently available for new subscriptions.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getMetadata

      public Object getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getNickname

      public Object getNickname()
      A brief description of the plan, hidden from customers.
    • getProduct

      public Object getProduct()
      The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
    • getTrialPeriodDays

      public Long getTrialPeriodDays()
      Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.