Class SubscriptionScheduleUpdateParams

    • Method Detail

      • getEndBehavior

        public SubscriptionScheduleUpdateParams.EndBehavior getEndBehavior()
        Configures how the subscription schedule behaves when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.
      • getExpand

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

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.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.
      • getPhases

        public java.util.List<SubscriptionScheduleUpdateParams.Phase> getPhases()
        List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted.
      • getProrationBehavior

        public SubscriptionScheduleUpdateParams.ProrationBehavior getProrationBehavior()
        If the update changes the current phase, indicates if the changes should be prorated. Possible values are create_prorations or none, and the default value is create_prorations.