Api

Class PlansApi

java.lang.Object

Api.PlansApi

public class PlansApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PlansApi()
PlansApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ActivateDeactivatePlanResponse	activatePlan(String id)	Activate a Plan Activate a Plan
okhttp3.Call	activatePlanAsync(String id, ApiCallback<ActivateDeactivatePlanResponse> callback)	Activate a Plan (asynchronously) Activate a Plan
okhttp3.Call	activatePlanCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for activatePlan
ApiResponse<ActivateDeactivatePlanResponse>	activatePlanWithHttpInfo(String id)	Activate a Plan Activate a Plan
CreatePlanResponse	createPlan(CreatePlanRequest createPlanRequest)	Create a Plan The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
okhttp3.Call	createPlanAsync(CreatePlanRequest createPlanRequest, ApiCallback<CreatePlanResponse> callback)	Create a Plan (asynchronously) The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
okhttp3.Call	createPlanCall(CreatePlanRequest createPlanRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createPlan
ApiResponse<CreatePlanResponse>	createPlanWithHttpInfo(CreatePlanRequest createPlanRequest)	Create a Plan The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
ActivateDeactivatePlanResponse	deactivatePlan(String id)	Deactivate a Plan Deactivate a Plan
okhttp3.Call	deactivatePlanAsync(String id, ApiCallback<ActivateDeactivatePlanResponse> callback)	Deactivate a Plan (asynchronously) Deactivate a Plan
okhttp3.Call	deactivatePlanCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deactivatePlan
ApiResponse<ActivateDeactivatePlanResponse>	deactivatePlanWithHttpInfo(String id)	Deactivate a Plan Deactivate a Plan
DeletePlanResponse	deletePlan(String id)	Delete a Plan Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan
okhttp3.Call	deletePlanAsync(String id, ApiCallback<DeletePlanResponse> callback)	Delete a Plan (asynchronously) Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan
okhttp3.Call	deletePlanCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deletePlan
ApiResponse<DeletePlanResponse>	deletePlanWithHttpInfo(String id)	Delete a Plan Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan
ApiClient	getApiClient()
GetPlanResponse	getPlan(String id)	Get a Plan Retrieve a Plan details by Plan Id.
okhttp3.Call	getPlanAsync(String id, ApiCallback<GetPlanResponse> callback)	Get a Plan (asynchronously) Retrieve a Plan details by Plan Id.
okhttp3.Call	getPlanCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getPlan
GetPlanCodeResponse	getPlanCode()	Get a Plan Code Get a Unique Plan Code
okhttp3.Call	getPlanCodeAsync(ApiCallback<GetPlanCodeResponse> callback)	Get a Plan Code (asynchronously) Get a Unique Plan Code
okhttp3.Call	getPlanCodeCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getPlanCode
ApiResponse<GetPlanCodeResponse>	getPlanCodeWithHttpInfo()	Get a Plan Code Get a Unique Plan Code
GetAllPlansResponse	getPlans(Integer offset, Integer limit, String code, String status, String name)	Get a List of Plans Retrieve Plans by Plan Code & Plan Status.
okhttp3.Call	getPlansAsync(Integer offset, Integer limit, String code, String status, String name, ApiCallback<GetAllPlansResponse> callback)	Get a List of Plans (asynchronously) Retrieve Plans by Plan Code & Plan Status.
okhttp3.Call	getPlansCall(Integer offset, Integer limit, String code, String status, String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getPlans
ApiResponse<GetAllPlansResponse>	getPlansWithHttpInfo(Integer offset, Integer limit, String code, String status, String name)	Get a List of Plans Retrieve Plans by Plan Code & Plan Status.
ApiResponse<GetPlanResponse>	getPlanWithHttpInfo(String id)	Get a Plan Retrieve a Plan details by Plan Id.
void	setApiClient(ApiClient apiClient)
UpdatePlanResponse	updatePlan(String id, UpdatePlanRequest updatePlanRequest)	Update a Plan Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`
okhttp3.Call	updatePlanAsync(String id, UpdatePlanRequest updatePlanRequest, ApiCallback<UpdatePlanResponse> callback)	Update a Plan (asynchronously) Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`
okhttp3.Call	updatePlanCall(String id, UpdatePlanRequest updatePlanRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for updatePlan
ApiResponse<UpdatePlanResponse>	updatePlanWithHttpInfo(String id, UpdatePlanRequest updatePlanRequest)	Update a Plan Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`

Methods inherited from class java.lang.Object

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

Constructor Detail

PlansApi

public PlansApi()

PlansApi

public PlansApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activatePlanCall

public okhttp3.Call activatePlanCall(String id,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Build call for activatePlan

Parameters:

id - Plan Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

activatePlan

public ActivateDeactivatePlanResponse activatePlan(String id)
                                            throws ApiException,
                                                   com.cybersource.authsdk.core.ConfigException

Activate a Plan Activate a Plan

Parameters:

id - Plan Id (required)

Returns:

ActivateDeactivatePlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

activatePlanWithHttpInfo

public ApiResponse<ActivateDeactivatePlanResponse> activatePlanWithHttpInfo(String id)
                                                                     throws ApiException,
                                                                            com.cybersource.authsdk.core.ConfigException

Activate a Plan Activate a Plan

Parameters:

id - Plan Id (required)

Returns:

ApiResponse<ActivateDeactivatePlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

activatePlanAsync

public okhttp3.Call activatePlanAsync(String id,
                                      ApiCallback<ActivateDeactivatePlanResponse> callback)
                               throws ApiException,
                                      com.cybersource.authsdk.core.ConfigException

Activate a Plan (asynchronously) Activate a Plan

Parameters:

id - Plan Id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createPlanCall

public okhttp3.Call createPlanCall(CreatePlanRequest createPlanRequest,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException,
                                   com.cybersource.authsdk.core.ConfigException

Build call for createPlan

Parameters:

createPlanRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createPlan

public CreatePlanResponse createPlan(CreatePlanRequest createPlanRequest)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Create a Plan The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules. It securely stores your customer's payment information and personal data within secure Visa data centers, reducing storage risks and PCI DSS scope through the use of *Token Management* (*TMS*). The three key elements of *Cybersource* Recurring Billing are: - **Token**: stores customer billing, shipping, and payment details. - **Plan**: stores the billing schedule. - **Subscription**: combines the token and plan, and defines the subscription start date, name, and description. The APIs in this section demonstrate the management of the Plans and Subscriptions. For Tokens please refer to [Token Management](#token-management) The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

createPlanRequest - (required)

Returns:

CreatePlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createPlanWithHttpInfo

public ApiResponse<CreatePlanResponse> createPlanWithHttpInfo(CreatePlanRequest createPlanRequest)
                                                       throws ApiException,
                                                              com.cybersource.authsdk.core.ConfigException

Create a Plan The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules. It securely stores your customer's payment information and personal data within secure Visa data centers, reducing storage risks and PCI DSS scope through the use of *Token Management* (*TMS*). The three key elements of *Cybersource* Recurring Billing are: - **Token**: stores customer billing, shipping, and payment details. - **Plan**: stores the billing schedule. - **Subscription**: combines the token and plan, and defines the subscription start date, name, and description. The APIs in this section demonstrate the management of the Plans and Subscriptions. For Tokens please refer to [Token Management](#token-management) The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

createPlanRequest - (required)

Returns:

ApiResponse<CreatePlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createPlanAsync

public okhttp3.Call createPlanAsync(CreatePlanRequest createPlanRequest,
                                    ApiCallback<CreatePlanResponse> callback)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Create a Plan (asynchronously) The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules. It securely stores your customer's payment information and personal data within secure Visa data centers, reducing storage risks and PCI DSS scope through the use of *Token Management* (*TMS*). The three key elements of *Cybersource* Recurring Billing are: - **Token**: stores customer billing, shipping, and payment details. - **Plan**: stores the billing schedule. - **Subscription**: combines the token and plan, and defines the subscription start date, name, and description. The APIs in this section demonstrate the management of the Plans and Subscriptions. For Tokens please refer to [Token Management](#token-management) The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

createPlanRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deactivatePlanCall

public okhttp3.Call deactivatePlanCall(String id,
                                       ProgressResponseBody.ProgressListener progressListener,
                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                throws ApiException,
                                       com.cybersource.authsdk.core.ConfigException

Build call for deactivatePlan

Parameters:

id - Plan Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deactivatePlan

public ActivateDeactivatePlanResponse deactivatePlan(String id)
                                              throws ApiException,
                                                     com.cybersource.authsdk.core.ConfigException

Deactivate a Plan Deactivate a Plan

Parameters:

id - Plan Id (required)

Returns:

ActivateDeactivatePlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deactivatePlanWithHttpInfo

public ApiResponse<ActivateDeactivatePlanResponse> deactivatePlanWithHttpInfo(String id)
                                                                       throws ApiException,
                                                                              com.cybersource.authsdk.core.ConfigException

Deactivate a Plan Deactivate a Plan

Parameters:

id - Plan Id (required)

Returns:

ApiResponse<ActivateDeactivatePlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deactivatePlanAsync

public okhttp3.Call deactivatePlanAsync(String id,
                                        ApiCallback<ActivateDeactivatePlanResponse> callback)
                                 throws ApiException,
                                        com.cybersource.authsdk.core.ConfigException

Deactivate a Plan (asynchronously) Deactivate a Plan

Parameters:

id - Plan Id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deletePlanCall

public okhttp3.Call deletePlanCall(String id,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException,
                                   com.cybersource.authsdk.core.ConfigException

Build call for deletePlan

Parameters:

id - Plan Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deletePlan

public DeletePlanResponse deletePlan(String id)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Delete a Plan Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan

Parameters:

id - Plan Id (required)

Returns:

DeletePlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deletePlanWithHttpInfo

public ApiResponse<DeletePlanResponse> deletePlanWithHttpInfo(String id)
                                                       throws ApiException,
                                                              com.cybersource.authsdk.core.ConfigException

Delete a Plan Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan

Parameters:

id - Plan Id (required)

Returns:

ApiResponse<DeletePlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

deletePlanAsync

public okhttp3.Call deletePlanAsync(String id,
                                    ApiCallback<DeletePlanResponse> callback)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Delete a Plan (asynchronously) Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan

Parameters:

id - Plan Id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanCall

public okhttp3.Call getPlanCall(String id,
                                ProgressResponseBody.ProgressListener progressListener,
                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                         throws ApiException,
                                com.cybersource.authsdk.core.ConfigException

Build call for getPlan

Parameters:

id - Plan Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlan

public GetPlanResponse getPlan(String id)
                        throws ApiException,
                               com.cybersource.authsdk.core.ConfigException

Get a Plan Retrieve a Plan details by Plan Id.

Parameters:

id - Plan Id (required)

Returns:

GetPlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanWithHttpInfo

public ApiResponse<GetPlanResponse> getPlanWithHttpInfo(String id)
                                                 throws ApiException,
                                                        com.cybersource.authsdk.core.ConfigException

Get a Plan Retrieve a Plan details by Plan Id.

Parameters:

id - Plan Id (required)

Returns:

ApiResponse<GetPlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanAsync

public okhttp3.Call getPlanAsync(String id,
                                 ApiCallback<GetPlanResponse> callback)
                          throws ApiException,
                                 com.cybersource.authsdk.core.ConfigException

Get a Plan (asynchronously) Retrieve a Plan details by Plan Id.

Parameters:

id - Plan Id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanCodeCall

public okhttp3.Call getPlanCodeCall(ProgressResponseBody.ProgressListener progressListener,
                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Build call for getPlanCode

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanCode

public GetPlanCodeResponse getPlanCode()
                                throws ApiException,
                                       com.cybersource.authsdk.core.ConfigException

Get a Plan Code Get a Unique Plan Code

Returns:

GetPlanCodeResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanCodeWithHttpInfo

public ApiResponse<GetPlanCodeResponse> getPlanCodeWithHttpInfo()
                                                         throws ApiException,
                                                                com.cybersource.authsdk.core.ConfigException

Get a Plan Code Get a Unique Plan Code

Returns:

ApiResponse<GetPlanCodeResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlanCodeAsync

public okhttp3.Call getPlanCodeAsync(ApiCallback<GetPlanCodeResponse> callback)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Get a Plan Code (asynchronously) Get a Unique Plan Code

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlansCall

public okhttp3.Call getPlansCall(Integer offset,
                                 Integer limit,
                                 String code,
                                 String status,
                                 String name,
                                 ProgressResponseBody.ProgressListener progressListener,
                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                          throws ApiException,
                                 com.cybersource.authsdk.core.ConfigException

Build call for getPlans

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Plan Code (optional)

status - Filter by Plan Status (optional)

name - Filter by Plan Name. (First sub string or full string) **[Not Recommended]** (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlans

public GetAllPlansResponse getPlans(Integer offset,
                                    Integer limit,
                                    String code,
                                    String status,
                                    String name)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Get a List of Plans Retrieve Plans by Plan Code & Plan Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Plan Code (optional)

status - Filter by Plan Status (optional)

name - Filter by Plan Name. (First sub string or full string) **[Not Recommended]** (optional)

Returns:

GetAllPlansResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlansWithHttpInfo

public ApiResponse<GetAllPlansResponse> getPlansWithHttpInfo(Integer offset,
                                                             Integer limit,
                                                             String code,
                                                             String status,
                                                             String name)
                                                      throws ApiException,
                                                             com.cybersource.authsdk.core.ConfigException

Get a List of Plans Retrieve Plans by Plan Code & Plan Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Plan Code (optional)

status - Filter by Plan Status (optional)

name - Filter by Plan Name. (First sub string or full string) **[Not Recommended]** (optional)

Returns:

ApiResponse<GetAllPlansResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getPlansAsync

public okhttp3.Call getPlansAsync(Integer offset,
                                  Integer limit,
                                  String code,
                                  String status,
                                  String name,
                                  ApiCallback<GetAllPlansResponse> callback)
                           throws ApiException,
                                  com.cybersource.authsdk.core.ConfigException

Get a List of Plans (asynchronously) Retrieve Plans by Plan Code & Plan Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Plan Code (optional)

status - Filter by Plan Status (optional)

name - Filter by Plan Name. (First sub string or full string) **[Not Recommended]** (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

updatePlanCall

public okhttp3.Call updatePlanCall(String id,
                                   UpdatePlanRequest updatePlanRequest,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException,
                                   com.cybersource.authsdk.core.ConfigException

Build call for updatePlan

Parameters:

id - Plan Id (required)

updatePlanRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

updatePlan

public UpdatePlanResponse updatePlan(String id,
                                     UpdatePlanRequest updatePlanRequest)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Update a Plan Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`

Parameters:

id - Plan Id (required)

updatePlanRequest - (required)

Returns:

UpdatePlanResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

updatePlanWithHttpInfo

public ApiResponse<UpdatePlanResponse> updatePlanWithHttpInfo(String id,
                                                              UpdatePlanRequest updatePlanRequest)
                                                       throws ApiException,
                                                              com.cybersource.authsdk.core.ConfigException

Update a Plan Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`

Parameters:

id - Plan Id (required)

updatePlanRequest - (required)

Returns:

ApiResponse<UpdatePlanResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

updatePlanAsync

public okhttp3.Call updatePlanAsync(String id,
                                    UpdatePlanRequest updatePlanRequest,
                                    ApiCallback<UpdatePlanResponse> callback)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Update a Plan (asynchronously) Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`

Parameters:

id - Plan Id (required)

updatePlanRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient