Package com.chargebee.v4.models.subscription.params

Class SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder

java.lang.Object

com.chargebee.v4.models.subscription.params.SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder

Enclosing class:

SubscriptionCreateForCustomerParams

public static final class SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	addons(List<SubscriptionCreateForCustomerParams.AddonsParams> value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	autoCollection(SubscriptionCreateForCustomerParams.AutoCollection value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	billingAlignmentMode(SubscriptionCreateForCustomerParams.BillingAlignmentMode value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	billingCycles(Integer value)
SubscriptionCreateForCustomerParams	build()
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	contractTerm(SubscriptionCreateForCustomerParams.ContractTermParams value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	contractTermBillingCycleOnRenewal(Integer value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	coupon(String value)	Deprecated.
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	couponIds(List<String> value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	coupons(List<SubscriptionCreateForCustomerParams.CouponsParams> value)	Deprecated.
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	customField(String fieldName, String value)	Add a custom field to the request.
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	customFields(Map<String,String> customFields)	Add multiple custom fields to the request.
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	eventBasedAddons(List<SubscriptionCreateForCustomerParams.EventBasedAddonsParams> value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	freePeriod(Integer value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	freePeriodUnit(SubscriptionCreateForCustomerParams.FreePeriodUnit value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	id(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	invoiceDate(Timestamp value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	invoiceImmediately(Boolean value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	invoiceNotes(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	mandatoryAddonsToRemove(List<String> value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	metaData(Map<String,Object> value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	offlinePaymentMethod(SubscriptionCreateForCustomerParams.OfflinePaymentMethod value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	overrideRelationship(Boolean value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	paymentInitiator(SubscriptionCreateForCustomerParams.PaymentInitiator value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	paymentIntent(SubscriptionCreateForCustomerParams.PaymentIntentParams value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	paymentSourceId(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	planId(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	planQuantity(Integer value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	planQuantityInDecimal(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	planUnitPrice(Long value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	planUnitPriceInDecimal(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	poNumber(String value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	replacePrimaryPaymentSource(Boolean value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	setupFee(Long value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	shippingAddress(SubscriptionCreateForCustomerParams.ShippingAddressParams value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	startDate(Timestamp value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	statementDescriptor(SubscriptionCreateForCustomerParams.StatementDescriptorParams value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	termsToCharge(Integer value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	trialEnd(Timestamp value)
SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder	trialEndAction(SubscriptionCreateForCustomerParams.TrialEndAction value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

id

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder id(String value)

planId

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder planId(String value)

planQuantity

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder planQuantity(Integer value)

planQuantityInDecimal

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder planQuantityInDecimal(String value)

planUnitPrice

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder planUnitPrice(Long value)

planUnitPriceInDecimal

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder planUnitPriceInDecimal(String value)

setupFee

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder setupFee(Long value)

trialEnd

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder trialEnd(Timestamp value)

billingCycles

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder billingCycles(Integer value)

mandatoryAddonsToRemove

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder mandatoryAddonsToRemove(List<String> value)

startDate

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder startDate(Timestamp value)

coupon

@Deprecated
public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder coupon(String value)

Deprecated.

autoCollection

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder autoCollection(SubscriptionCreateForCustomerParams.AutoCollection value)

termsToCharge

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder termsToCharge(Integer value)

billingAlignmentMode

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder billingAlignmentMode(SubscriptionCreateForCustomerParams.BillingAlignmentMode value)

offlinePaymentMethod

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder offlinePaymentMethod(SubscriptionCreateForCustomerParams.OfflinePaymentMethod value)

poNumber

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder poNumber(String value)

couponIds

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder couponIds(List<String> value)

paymentSourceId

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder paymentSourceId(String value)

overrideRelationship

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder overrideRelationship(Boolean value)

invoiceNotes

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder invoiceNotes(String value)

invoiceDate

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder invoiceDate(Timestamp value)

metaData

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder metaData(Map<String,Object> value)

invoiceImmediately

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder invoiceImmediately(Boolean value)

replacePrimaryPaymentSource

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder replacePrimaryPaymentSource(Boolean value)

freePeriod

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder freePeriod(Integer value)

freePeriodUnit

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder freePeriodUnit(SubscriptionCreateForCustomerParams.FreePeriodUnit value)

contractTermBillingCycleOnRenewal

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder contractTermBillingCycleOnRenewal(Integer value)

trialEndAction

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder trialEndAction(SubscriptionCreateForCustomerParams.TrialEndAction value)

paymentInitiator

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder paymentInitiator(SubscriptionCreateForCustomerParams.PaymentInitiator value)

shippingAddress

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder shippingAddress(SubscriptionCreateForCustomerParams.ShippingAddressParams value)

statementDescriptor

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder statementDescriptor(SubscriptionCreateForCustomerParams.StatementDescriptorParams value)

paymentIntent

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder paymentIntent(SubscriptionCreateForCustomerParams.PaymentIntentParams value)

contractTerm

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder contractTerm(SubscriptionCreateForCustomerParams.ContractTermParams value)

addons

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder addons(List<SubscriptionCreateForCustomerParams.AddonsParams> value)

eventBasedAddons

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder eventBasedAddons(List<SubscriptionCreateForCustomerParams.EventBasedAddonsParams> value)

coupons

@Deprecated
public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder coupons(List<SubscriptionCreateForCustomerParams.CouponsParams> value)

Deprecated.

customField

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder customField(String fieldName,
 String value)

Add a custom field to the request. Custom fields must start with "cf_".

Parameters:

fieldName - the name of the custom field (e.g., "cf_custom_field_name")

value - the value of the custom field

Returns:

this builder

Throws:

IllegalArgumentException - if fieldName doesn't start with "cf_"

customFields

public SubscriptionCreateForCustomerParams.SubscriptionCreateForCustomerBuilder customFields(Map<String,String> customFields)

Add multiple custom fields to the request. All field names must start with "cf_".

Parameters:

customFields - map of custom field names to values

Returns:

this builder

Throws:

IllegalArgumentException - if any field name doesn't start with "cf_"

build

public SubscriptionCreateForCustomerParams build()