public class SubscriptionsApi extends Object
| Constructor and Description |
|---|
SubscriptionsApi() |
SubscriptionsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ActivateSubscriptionResponse |
activateSubscription(String id)
Activate a Subscription
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
okhttp3.Call |
activateSubscriptionAsync(String id,
ApiCallback<ActivateSubscriptionResponse> callback)
Activate a Subscription (asynchronously)
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
okhttp3.Call |
activateSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for activateSubscription
|
ApiResponse<ActivateSubscriptionResponse> |
activateSubscriptionWithHttpInfo(String id)
Activate a Subscription
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
CancelSubscriptionResponse |
cancelSubscription(String id)
Cancel a Subscription
Cancel a Subscription
|
okhttp3.Call |
cancelSubscriptionAsync(String id,
ApiCallback<CancelSubscriptionResponse> callback)
Cancel a Subscription (asynchronously)
Cancel a Subscription
|
okhttp3.Call |
cancelSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for cancelSubscription
|
ApiResponse<CancelSubscriptionResponse> |
cancelSubscriptionWithHttpInfo(String id)
Cancel a Subscription
Cancel a Subscription
|
CreateSubscriptionResponse |
createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Create a Subscription
Create a Recurring Billing Subscription
|
okhttp3.Call |
createSubscriptionAsync(CreateSubscriptionRequest createSubscriptionRequest,
ApiCallback<CreateSubscriptionResponse> callback)
Create a Subscription (asynchronously)
Create a Recurring Billing Subscription
|
okhttp3.Call |
createSubscriptionCall(CreateSubscriptionRequest createSubscriptionRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createSubscription
|
ApiResponse<CreateSubscriptionResponse> |
createSubscriptionWithHttpInfo(CreateSubscriptionRequest createSubscriptionRequest)
Create a Subscription
Create a Recurring Billing Subscription
|
GetAllSubscriptionsResponse |
getAllSubscriptions(Integer offset,
Integer limit,
String code,
String status)
Get a List of Subscriptions
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
okhttp3.Call |
getAllSubscriptionsAsync(Integer offset,
Integer limit,
String code,
String status,
ApiCallback<GetAllSubscriptionsResponse> callback)
Get a List of Subscriptions (asynchronously)
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
okhttp3.Call |
getAllSubscriptionsCall(Integer offset,
Integer limit,
String code,
String status,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAllSubscriptions
|
ApiResponse<GetAllSubscriptionsResponse> |
getAllSubscriptionsWithHttpInfo(Integer offset,
Integer limit,
String code,
String status)
Get a List of Subscriptions
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
ApiClient |
getApiClient() |
GetSubscriptionResponse |
getSubscription(String id)
Get a Subscription
Get a Subscription by Subscription Id
|
okhttp3.Call |
getSubscriptionAsync(String id,
ApiCallback<GetSubscriptionResponse> callback)
Get a Subscription (asynchronously)
Get a Subscription by Subscription Id
|
okhttp3.Call |
getSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSubscription
|
GetSubscriptionCodeResponse |
getSubscriptionCode()
Get a Subscription Code
Get a Unique Subscription Code
|
okhttp3.Call |
getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback)
Get a Subscription Code (asynchronously)
Get a Unique Subscription Code
|
okhttp3.Call |
getSubscriptionCodeCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSubscriptionCode
|
ApiResponse<GetSubscriptionCodeResponse> |
getSubscriptionCodeWithHttpInfo()
Get a Subscription Code
Get a Unique Subscription Code
|
ApiResponse<GetSubscriptionResponse> |
getSubscriptionWithHttpInfo(String id)
Get a Subscription
Get a Subscription by Subscription Id
|
void |
setApiClient(ApiClient apiClient) |
SuspendSubscriptionResponse |
suspendSubscription(String id)
Suspend a Subscription
Suspend a Subscription
|
okhttp3.Call |
suspendSubscriptionAsync(String id,
ApiCallback<SuspendSubscriptionResponse> callback)
Suspend a Subscription (asynchronously)
Suspend a Subscription
|
okhttp3.Call |
suspendSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for suspendSubscription
|
ApiResponse<SuspendSubscriptionResponse> |
suspendSubscriptionWithHttpInfo(String id)
Suspend a Subscription
Suspend a Subscription
|
UpdateSubscriptionResponse |
updateSubscription(String id,
UpdateSubscription updateSubscription)
Update a Subscription
Update a Subscription by Subscription Id
|
okhttp3.Call |
updateSubscriptionAsync(String id,
UpdateSubscription updateSubscription,
ApiCallback<UpdateSubscriptionResponse> callback)
Update a Subscription (asynchronously)
Update a Subscription by Subscription Id
|
okhttp3.Call |
updateSubscriptionCall(String id,
UpdateSubscription updateSubscription,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateSubscription
|
ApiResponse<UpdateSubscriptionResponse> |
updateSubscriptionWithHttpInfo(String id,
UpdateSubscription updateSubscription)
Update a Subscription
Update a Subscription by Subscription Id
|
public SubscriptionsApi()
public SubscriptionsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call activateSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Subscription Id (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic ActivateSubscriptionResponse activateSubscription(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<ActivateSubscriptionResponse> activateSubscriptionWithHttpInfo(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call activateSubscriptionAsync(String id, ApiCallback<ActivateSubscriptionResponse> callback) throws ApiException
id - Subscription Id (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call cancelSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Subscription Id (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic CancelSubscriptionResponse cancelSubscription(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CancelSubscriptionResponse> cancelSubscriptionWithHttpInfo(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call cancelSubscriptionAsync(String id, ApiCallback<CancelSubscriptionResponse> callback) throws ApiException
id - Subscription Id (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call createSubscriptionCall(CreateSubscriptionRequest createSubscriptionRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
createSubscriptionRequest - (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest) throws ApiException
createSubscriptionRequest - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CreateSubscriptionResponse> createSubscriptionWithHttpInfo(CreateSubscriptionRequest createSubscriptionRequest) throws ApiException
createSubscriptionRequest - (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call createSubscriptionAsync(CreateSubscriptionRequest createSubscriptionRequest, ApiCallback<CreateSubscriptionResponse> callback) throws ApiException
createSubscriptionRequest - (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getAllSubscriptionsCall(Integer offset, Integer limit, String code, String status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
offset - Page offset number. (optional)limit - Number of items to be returned. Default - `20`, Max - `100` (optional)code - Filter by Subscription Code (optional)status - Filter by Subscription Status (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetAllSubscriptionsResponse getAllSubscriptions(Integer offset, Integer limit, String code, String status) throws ApiException
offset - Page offset number. (optional)limit - Number of items to be returned. Default - `20`, Max - `100` (optional)code - Filter by Subscription Code (optional)status - Filter by Subscription Status (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetAllSubscriptionsResponse> getAllSubscriptionsWithHttpInfo(Integer offset, Integer limit, String code, String status) throws ApiException
offset - Page offset number. (optional)limit - Number of items to be returned. Default - `20`, Max - `100` (optional)code - Filter by Subscription Code (optional)status - Filter by Subscription Status (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getAllSubscriptionsAsync(Integer offset, Integer limit, String code, String status, ApiCallback<GetAllSubscriptionsResponse> callback) throws ApiException
offset - Page offset number. (optional)limit - Number of items to be returned. Default - `20`, Max - `100` (optional)code - Filter by Subscription Code (optional)status - Filter by Subscription Status (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Subscription Id (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetSubscriptionResponse getSubscription(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetSubscriptionResponse> getSubscriptionWithHttpInfo(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getSubscriptionAsync(String id, ApiCallback<GetSubscriptionResponse> callback) throws ApiException
id - Subscription Id (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getSubscriptionCodeCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic GetSubscriptionCodeResponse getSubscriptionCode() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<GetSubscriptionCodeResponse> getSubscriptionCodeWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call suspendSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Subscription Id (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic SuspendSubscriptionResponse suspendSubscription(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SuspendSubscriptionResponse> suspendSubscriptionWithHttpInfo(String id) throws ApiException
id - Subscription Id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call suspendSubscriptionAsync(String id, ApiCallback<SuspendSubscriptionResponse> callback) throws ApiException
id - Subscription Id (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call updateSubscriptionCall(String id, UpdateSubscription updateSubscription, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Subscription Id (required)updateSubscription - Update Subscription (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic UpdateSubscriptionResponse updateSubscription(String id, UpdateSubscription updateSubscription) throws ApiException
id - Subscription Id (required)updateSubscription - Update Subscription (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<UpdateSubscriptionResponse> updateSubscriptionWithHttpInfo(String id, UpdateSubscription updateSubscription) throws ApiException
id - Subscription Id (required)updateSubscription - Update Subscription (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call updateSubscriptionAsync(String id, UpdateSubscription updateSubscription, ApiCallback<UpdateSubscriptionResponse> callback) throws ApiException
id - Subscription Id (required)updateSubscription - Update Subscription (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2025. All rights reserved.