- Enclosing class:
Nested Class SummaryModifier and TypeClassDescription
static enumThis is used to determine the number of billing cycles to prebill.
Method SummaryModifier and TypeMethodDescription
builder()Configures when the subscription schedule generates prorations for phase transitions.When specified as
reset, the subscription will always start a new billing period when the quote is accepted.When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.Configures how the subscription schedule behaves when it ends.Map of extra parameters for custom features not available in this client library.The id of a subscription schedule the quote will update.The id of a subscription that the quote will update.If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted.Determines how to handle prorations.Integer representing the number of trial period days before the customer is charged for the first time.
builderpublic static QuoteCreateParams.SubscriptionData.Builder builder()
getBillingBehaviorpublic QuoteCreateParams.SubscriptionData.BillingBehavior getBillingBehavior()Configures when the subscription schedule generates prorations for phase transitions. Possible values are
prorate_up_frontwith the default being
prorate_on_next_phasewill apply phase changes and generate prorations at transition time.
prorate_up_frontwill bill for all phases within the current billing cycle up front.
getBillingCycleAnchorpublic ApiRequestParams.EnumParam getBillingCycleAnchor()When specified as
reset, the subscription will always start a new billing period when the quote is accepted.
getEffectiveDatepublic 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_endcan be provided to update a subscription at the end of its current period. The
effective_dateis ignored if it is in the past when the quote is accepted.
getEndBehaviorpublic QuoteCreateParams.SubscriptionData.EndBehavior getEndBehavior()Configures how the subscription schedule behaves when it ends. Possible values are
cancelwith the default being
releasewill end the subscription schedule and keep the underlying subscription running.
cancelwill end the subscription schedule and cancel the underlying subscription.
getExtraParamsMap of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's
@SerializedNamevalue. 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.
getFromSchedulepublic 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.
getFromSubscriptionpublic 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.
getPrebillingpublic Object getPrebilling()If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with
getProrationBehaviorpublic QuoteCreateParams.SubscriptionData.ProrationBehavior getProrationBehavior()Determines how to handle prorations. When creating a subscription, valid values are
When updating a subscription, valid values are
create_prorationswill 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
Prorations can be disabled by passing
getTrialPeriodDayspublic Object getTrialPeriodDays()Integer representing the number of trial period days before the customer is charged for the first time.