Class QuoteCreateParams.SubscriptionData

Enclosing class:

public static class QuoteCreateParams.SubscriptionData extends Object
  • Method Details

    • builder

    • getBillingBehavior

      Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time.prorate_up_front will bill for all phases within the current billing cycle up front.
    • getBillingCycleAnchor

      public ApiRequestParams.EnumParam getBillingCycleAnchor()
      When specified as reset, the subscription will always start a new billing period when the quote is accepted.
    • getEffectiveDate

      public Object getEffectiveDate()
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.
    • 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.
    • 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.
    • getFromSchedule

      public String getFromSchedule()
      The id of a subscription schedule the quote will update. The quote will inherit the state of the subscription schedule, such as phases. Cannot be combined with other parameters.
    • getFromSubscription

      public String getFromSubscription()
      The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
    • getPrebilling

      public Object getPrebilling()
      If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.
    • getProrationBehavior

      Determines how to handle prorations. When creating a subscription, valid values are create_prorations or none.

      When updating a subscription, valid values are create_prorations, none, or always_invoice.

      Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

      Prorations can be disabled by passing none.

    • getTrialPeriodDays

      public Object getTrialPeriodDays()
      Integer representing the number of trial period days before the customer is charged for the first time.