Package com.chargebee.v4.services

Class SubscriptionService

java.lang.Object

com.chargebee.v4.services.BaseService<SubscriptionService>

com.chargebee.v4.services.SubscriptionService

public final class SubscriptionService
extends BaseService<SubscriptionService>

Field Summary

Fields inherited from class com.chargebee.v4.services.BaseService

client, options

Constructor Summary

Constructors

Constructor	Description
SubscriptionService(ChargebeeClient client)

Method Summary

Modifier and Type	Method	Description
SubscriptionAddChargeAtTermEndResponse	addChargeAtTermEnd(String subscriptionId, SubscriptionAddChargeAtTermEndParams params)
SubscriptionCancelResponse	cancel(String subscriptionId)
SubscriptionCancelResponse	cancel(String subscriptionId, SubscriptionCancelParams params)
SubscriptionCancelForItemsResponse	cancelForItems(String subscriptionId)
SubscriptionCancelForItemsResponse	cancelForItems(String subscriptionId, SubscriptionCancelForItemsParams params)
SubscriptionChangeTermEndResponse	changeTermEnd(String subscriptionId, SubscriptionChangeTermEndParams params)
SubscriptionChargeAddonAtTermEndResponse	chargeAddonAtTermEnd(String subscriptionId, SubscriptionChargeAddonAtTermEndParams params)
SubscriptionChargeFutureRenewalsResponse	chargeFutureRenewals(String subscriptionId)
SubscriptionChargeFutureRenewalsResponse	chargeFutureRenewals(String subscriptionId, SubscriptionChargeFutureRenewalsParams params)
ContractTermsForSubscriptionResponse	contractTermsForSubscription(String subscriptionId)
ContractTermsForSubscriptionResponse	contractTermsForSubscription(String subscriptionId, ContractTermsForSubscriptionParams params)
SubscriptionCreateResponse	create(SubscriptionCreateParams params)
SubscriptionCreateForCustomerResponse	createForCustomer(String customerId, SubscriptionCreateForCustomerParams params)
SubscriptionCreateWithItemsResponse	createWithItems(String customerId)
SubscriptionCreateWithItemsResponse	createWithItems(String customerId, SubscriptionCreateWithItemsParams params)
SubscriptionDeleteResponse	delete(String subscriptionId)
SubscriptionEditAdvanceInvoiceScheduleResponse	editAdvanceInvoiceSchedule(String subscriptionId)
SubscriptionEditAdvanceInvoiceScheduleResponse	editAdvanceInvoiceSchedule(String subscriptionId, SubscriptionEditAdvanceInvoiceScheduleParams params)
SubscriptionImportContractTermResponse	importContractTerm(String subscriptionId)
SubscriptionImportContractTermResponse	importContractTerm(String subscriptionId, SubscriptionImportContractTermParams params)
SubscriptionImportForCustomerResponse	importForCustomer(String customerId, SubscriptionImportForCustomerParams params)
SubscriptionImportForItemsResponse	importForItems(String customerId, SubscriptionImportForItemsParams params)
ImportSubscriptionResponse	importSubscription(ImportSubscriptionParams params)
SubscriptionImportUnbilledChargesResponse	importUnbilledCharges(String subscriptionId)
SubscriptionImportUnbilledChargesResponse	importUnbilledCharges(String subscriptionId, SubscriptionImportUnbilledChargesParams params)
SubscriptionListResponse	list()
SubscriptionListResponse	list(SubscriptionListParams params)
SubscriptionListDiscountsResponse	listDiscounts(String subscriptionId)
SubscriptionListDiscountsResponse	listDiscounts(String subscriptionId, SubscriptionListDiscountsParams params)
SubscriptionMoveResponse	move(String subscriptionId, SubscriptionMoveParams params)
SubscriptionOverrideBillingProfileResponse	overrideBillingProfile(String subscriptionId)
SubscriptionOverrideBillingProfileResponse	overrideBillingProfile(String subscriptionId, SubscriptionOverrideBillingProfileParams params)
SubscriptionPauseResponse	pause(String subscriptionId)
SubscriptionPauseResponse	pause(String subscriptionId, SubscriptionPauseParams params)
SubscriptionReactivateResponse	reactivate(String subscriptionId)
SubscriptionReactivateResponse	reactivate(String subscriptionId, SubscriptionReactivateParams params)
SubscriptionRegenerateInvoiceResponse	regenerateInvoice(String subscriptionId)
SubscriptionRegenerateInvoiceResponse	regenerateInvoice(String subscriptionId, SubscriptionRegenerateInvoiceParams params)
SubscriptionRemoveAdvanceInvoiceScheduleResponse	removeAdvanceInvoiceSchedule(String subscriptionId)
SubscriptionRemoveAdvanceInvoiceScheduleResponse	removeAdvanceInvoiceSchedule(String subscriptionId, SubscriptionRemoveAdvanceInvoiceScheduleParams params)
SubscriptionRemoveCouponsResponse	removeCoupons(String subscriptionId)
SubscriptionRemoveCouponsResponse	removeCoupons(String subscriptionId, SubscriptionRemoveCouponsParams params)
SubscriptionRemoveScheduledCancellationResponse	removeScheduledCancellation(String subscriptionId)
SubscriptionRemoveScheduledCancellationResponse	removeScheduledCancellation(String subscriptionId, SubscriptionRemoveScheduledCancellationParams params)
SubscriptionRemoveScheduledChangesResponse	removeScheduledChanges(String subscriptionId)
SubscriptionRemoveScheduledPauseResponse	removeScheduledPause(String subscriptionId)
SubscriptionRemoveScheduledResumptionResponse	removeScheduledResumption(String subscriptionId)
SubscriptionResumeResponse	resume(String subscriptionId)
SubscriptionResumeResponse	resume(String subscriptionId, SubscriptionResumeParams params)
SubscriptionRetrieveResponse	retrieve(String subscriptionId)
SubscriptionRetrieveAdvanceInvoiceScheduleResponse	retrieveAdvanceInvoiceSchedule(String subscriptionId)
SubscriptionRetrieveWithScheduledChangesResponse	retrieveWithScheduledChanges(String subscriptionId)
SubscriptionsForCustomerResponse	subscriptionsForCustomer(String customerId)
SubscriptionsForCustomerResponse	subscriptionsForCustomer(String customerId, SubscriptionsForCustomerParams params)
SubscriptionUpdateResponse	update(String subscriptionId)
SubscriptionUpdateResponse	update(String subscriptionId, SubscriptionUpdateParams params)
SubscriptionUpdateForItemsResponse	updateForItems(String subscriptionId)
SubscriptionUpdateForItemsResponse	updateForItems(String subscriptionId, SubscriptionUpdateForItemsParams params)
SubscriptionService	withOptions(RequestOptions options)	Apply per-request options for this service instance.

Methods inherited from class com.chargebee.v4.services.BaseService

buildPathWithParams, clientForBuilders, clientWithOptions, get, getAsync, getMergedHeaders, getWithSubDomain, header, headers, options, parseResponse, post, postAsync, postJson, postJsonAsync, postJsonWithSubDomain, postWithSubDomain

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionService

public SubscriptionService(ChargebeeClient client)

Method Details

withOptions

public SubscriptionService withOptions(RequestOptions options)

Apply per-request options for this service instance. Users can chain .withOptions or .options to set headers and other options.

Overrides:

withOptions in class BaseService<SubscriptionService>

removeAdvanceInvoiceSchedule

public SubscriptionRemoveAdvanceInvoiceScheduleResponse removeAdvanceInvoiceSchedule(String subscriptionId,
 SubscriptionRemoveAdvanceInvoiceScheduleParams params)
                                                                              throws ChargebeeException

Throws:

ChargebeeException

removeAdvanceInvoiceSchedule

public SubscriptionRemoveAdvanceInvoiceScheduleResponse removeAdvanceInvoiceSchedule(String subscriptionId)
                                                                              throws ChargebeeException

Throws:

ChargebeeException

updateForItems

public SubscriptionUpdateForItemsResponse updateForItems(String subscriptionId,
 SubscriptionUpdateForItemsParams params)
                                                  throws ChargebeeException

Throws:

ChargebeeException

updateForItems

public SubscriptionUpdateForItemsResponse updateForItems(String subscriptionId)
                                                  throws ChargebeeException

Throws:

ChargebeeException

removeCoupons

public SubscriptionRemoveCouponsResponse removeCoupons(String subscriptionId,
 SubscriptionRemoveCouponsParams params)
                                                throws ChargebeeException

Throws:

ChargebeeException

removeCoupons

public SubscriptionRemoveCouponsResponse removeCoupons(String subscriptionId)
                                                throws ChargebeeException

Throws:

ChargebeeException

resume

public SubscriptionResumeResponse resume(String subscriptionId,
 SubscriptionResumeParams params)
                                  throws ChargebeeException

Throws:

ChargebeeException

resume

public SubscriptionResumeResponse resume(String subscriptionId)
                                  throws ChargebeeException

Throws:

ChargebeeException

cancelForItems

public SubscriptionCancelForItemsResponse cancelForItems(String subscriptionId,
 SubscriptionCancelForItemsParams params)
                                                  throws ChargebeeException

Throws:

ChargebeeException

cancelForItems

public SubscriptionCancelForItemsResponse cancelForItems(String subscriptionId)
                                                  throws ChargebeeException

Throws:

ChargebeeException

regenerateInvoice

public SubscriptionRegenerateInvoiceResponse regenerateInvoice(String subscriptionId,
 SubscriptionRegenerateInvoiceParams params)
                                                        throws ChargebeeException

Throws:

ChargebeeException

regenerateInvoice

public SubscriptionRegenerateInvoiceResponse regenerateInvoice(String subscriptionId)
                                                        throws ChargebeeException

Throws:

ChargebeeException

list

public SubscriptionListResponse list(SubscriptionListParams params)
                              throws ChargebeeException

Throws:

ChargebeeException

list

public SubscriptionListResponse list()
                              throws ChargebeeException

Throws:

ChargebeeException

create

public SubscriptionCreateResponse create(SubscriptionCreateParams params)
                                  throws ChargebeeException

Throws:

ChargebeeException

move

public SubscriptionMoveResponse move(String subscriptionId,
 SubscriptionMoveParams params)
                              throws ChargebeeException

Throws:

ChargebeeException

subscriptionsForCustomer

public SubscriptionsForCustomerResponse subscriptionsForCustomer(String customerId,
 SubscriptionsForCustomerParams params)
                                                          throws ChargebeeException

Throws:

ChargebeeException

subscriptionsForCustomer

public SubscriptionsForCustomerResponse subscriptionsForCustomer(String customerId)
                                                          throws ChargebeeException

Throws:

ChargebeeException

createForCustomer

public SubscriptionCreateForCustomerResponse createForCustomer(String customerId,
 SubscriptionCreateForCustomerParams params)
                                                        throws ChargebeeException

Throws:

ChargebeeException

importForItems

public SubscriptionImportForItemsResponse importForItems(String customerId,
 SubscriptionImportForItemsParams params)
                                                  throws ChargebeeException

Throws:

ChargebeeException

retrieveAdvanceInvoiceSchedule

public SubscriptionRetrieveAdvanceInvoiceScheduleResponse retrieveAdvanceInvoiceSchedule(String subscriptionId)
                                                                                  throws ChargebeeException

Throws:

ChargebeeException

removeScheduledCancellation

public SubscriptionRemoveScheduledCancellationResponse removeScheduledCancellation(String subscriptionId,
 SubscriptionRemoveScheduledCancellationParams params)
                                                                            throws ChargebeeException

Throws:

ChargebeeException

removeScheduledCancellation

public SubscriptionRemoveScheduledCancellationResponse removeScheduledCancellation(String subscriptionId)
                                                                            throws ChargebeeException

Throws:

ChargebeeException

retrieveWithScheduledChanges

public SubscriptionRetrieveWithScheduledChangesResponse retrieveWithScheduledChanges(String subscriptionId)
                                                                              throws ChargebeeException

Throws:

ChargebeeException

reactivate

public SubscriptionReactivateResponse reactivate(String subscriptionId,
 SubscriptionReactivateParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

reactivate

public SubscriptionReactivateResponse reactivate(String subscriptionId)
                                          throws ChargebeeException

Throws:

ChargebeeException

chargeFutureRenewals

public SubscriptionChargeFutureRenewalsResponse chargeFutureRenewals(String subscriptionId,
 SubscriptionChargeFutureRenewalsParams params)
                                                              throws ChargebeeException

Throws:

ChargebeeException

chargeFutureRenewals

public SubscriptionChargeFutureRenewalsResponse chargeFutureRenewals(String subscriptionId)
                                                              throws ChargebeeException

Throws:

ChargebeeException

addChargeAtTermEnd

public SubscriptionAddChargeAtTermEndResponse addChargeAtTermEnd(String subscriptionId,
 SubscriptionAddChargeAtTermEndParams params)
                                                          throws ChargebeeException

Throws:

ChargebeeException

removeScheduledChanges

public SubscriptionRemoveScheduledChangesResponse removeScheduledChanges(String subscriptionId)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

changeTermEnd

public SubscriptionChangeTermEndResponse changeTermEnd(String subscriptionId,
 SubscriptionChangeTermEndParams params)
                                                throws ChargebeeException

Throws:

ChargebeeException

delete

public SubscriptionDeleteResponse delete(String subscriptionId)
                                  throws ChargebeeException

Throws:

ChargebeeException

createWithItems

public SubscriptionCreateWithItemsResponse createWithItems(String customerId,
 SubscriptionCreateWithItemsParams params)
                                                    throws ChargebeeException

Throws:

ChargebeeException

createWithItems

public SubscriptionCreateWithItemsResponse createWithItems(String customerId)
                                                    throws ChargebeeException

Throws:

ChargebeeException

importUnbilledCharges

public SubscriptionImportUnbilledChargesResponse importUnbilledCharges(String subscriptionId,
 SubscriptionImportUnbilledChargesParams params)
                                                                throws ChargebeeException

Throws:

ChargebeeException

importUnbilledCharges

public SubscriptionImportUnbilledChargesResponse importUnbilledCharges(String subscriptionId)
                                                                throws ChargebeeException

Throws:

ChargebeeException

removeScheduledResumption

public SubscriptionRemoveScheduledResumptionResponse removeScheduledResumption(String subscriptionId)
                                                                        throws ChargebeeException

Throws:

ChargebeeException

retrieve

public SubscriptionRetrieveResponse retrieve(String subscriptionId)
                                      throws ChargebeeException

Throws:

ChargebeeException

update

public SubscriptionUpdateResponse update(String subscriptionId,
 SubscriptionUpdateParams params)
                                  throws ChargebeeException

Throws:

ChargebeeException

update

public SubscriptionUpdateResponse update(String subscriptionId)
                                  throws ChargebeeException

Throws:

ChargebeeException

importContractTerm

public SubscriptionImportContractTermResponse importContractTerm(String subscriptionId,
 SubscriptionImportContractTermParams params)
                                                          throws ChargebeeException

Throws:

ChargebeeException

importContractTerm

public SubscriptionImportContractTermResponse importContractTerm(String subscriptionId)
                                                          throws ChargebeeException

Throws:

ChargebeeException

overrideBillingProfile

public SubscriptionOverrideBillingProfileResponse overrideBillingProfile(String subscriptionId,
 SubscriptionOverrideBillingProfileParams params)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

overrideBillingProfile

public SubscriptionOverrideBillingProfileResponse overrideBillingProfile(String subscriptionId)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

removeScheduledPause

public SubscriptionRemoveScheduledPauseResponse removeScheduledPause(String subscriptionId)
                                                              throws ChargebeeException

Throws:

ChargebeeException

editAdvanceInvoiceSchedule

public SubscriptionEditAdvanceInvoiceScheduleResponse editAdvanceInvoiceSchedule(String subscriptionId,
 SubscriptionEditAdvanceInvoiceScheduleParams params)
                                                                          throws ChargebeeException

Throws:

ChargebeeException

editAdvanceInvoiceSchedule

public SubscriptionEditAdvanceInvoiceScheduleResponse editAdvanceInvoiceSchedule(String subscriptionId)
                                                                          throws ChargebeeException

Throws:

ChargebeeException

listDiscounts

public SubscriptionListDiscountsResponse listDiscounts(String subscriptionId,
 SubscriptionListDiscountsParams params)
                                                throws ChargebeeException

Throws:

ChargebeeException

listDiscounts

public SubscriptionListDiscountsResponse listDiscounts(String subscriptionId)
                                                throws ChargebeeException

Throws:

ChargebeeException

contractTermsForSubscription

public ContractTermsForSubscriptionResponse contractTermsForSubscription(String subscriptionId,
 ContractTermsForSubscriptionParams params)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

contractTermsForSubscription

public ContractTermsForSubscriptionResponse contractTermsForSubscription(String subscriptionId)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

pause

public SubscriptionPauseResponse pause(String subscriptionId,
 SubscriptionPauseParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

pause

public SubscriptionPauseResponse pause(String subscriptionId)
                                throws ChargebeeException

Throws:

ChargebeeException

importForCustomer

public SubscriptionImportForCustomerResponse importForCustomer(String customerId,
 SubscriptionImportForCustomerParams params)
                                                        throws ChargebeeException

Throws:

ChargebeeException

importSubscription

public ImportSubscriptionResponse importSubscription(ImportSubscriptionParams params)
                                              throws ChargebeeException

Throws:

ChargebeeException

cancel

public SubscriptionCancelResponse cancel(String subscriptionId,
 SubscriptionCancelParams params)
                                  throws ChargebeeException

Throws:

ChargebeeException

cancel

public SubscriptionCancelResponse cancel(String subscriptionId)
                                  throws ChargebeeException

Throws:

ChargebeeException

chargeAddonAtTermEnd

public SubscriptionChargeAddonAtTermEndResponse chargeAddonAtTermEnd(String subscriptionId,
 SubscriptionChargeAddonAtTermEndParams params)
                                                              throws ChargebeeException

Throws:

ChargebeeException