com.squareup.square.api

Class DefaultSubscriptionsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultSubscriptionsApi

All Implemented Interfaces:

SubscriptionsApi

public final class DefaultSubscriptionsApi
extends BaseApi
implements SubscriptionsApi

This class lists all the endpoints of the groups.

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

AUTHENTICATION_KEY, GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionsApi(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
BulkSwapPlanResponse	bulkSwapPlan(BulkSwapPlanRequest body) Schedules a plan variation change for all active subscriptions under a given plan variation.
CompletableFuture<BulkSwapPlanResponse>	bulkSwapPlanAsync(BulkSwapPlanRequest body) Schedules a plan variation change for all active subscriptions under a given plan variation.
CancelSubscriptionResponse	cancelSubscription(String subscriptionId) Schedules a `CANCEL` action to cancel an active subscription.
CompletableFuture<CancelSubscriptionResponse>	cancelSubscriptionAsync(String subscriptionId) Schedules a `CANCEL` action to cancel an active subscription.
ChangeBillingAnchorDateResponse	changeBillingAnchorDate(String subscriptionId, ChangeBillingAnchorDateRequest body) Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) for a subscription.
CompletableFuture<ChangeBillingAnchorDateResponse>	changeBillingAnchorDateAsync(String subscriptionId, ChangeBillingAnchorDateRequest body) Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) for a subscription.
CreateSubscriptionResponse	createSubscription(CreateSubscriptionRequest body) Enrolls a customer in a subscription.
CompletableFuture<CreateSubscriptionResponse>	createSubscriptionAsync(CreateSubscriptionRequest body) Enrolls a customer in a subscription.
DeleteSubscriptionActionResponse	deleteSubscriptionAction(String subscriptionId, String actionId) Deletes a scheduled action for a subscription.
CompletableFuture<DeleteSubscriptionActionResponse>	deleteSubscriptionActionAsync(String subscriptionId, String actionId) Deletes a scheduled action for a subscription.
ListSubscriptionEventsResponse	listSubscriptionEvents(String subscriptionId, String cursor, Integer limit) Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.
CompletableFuture<ListSubscriptionEventsResponse>	listSubscriptionEventsAsync(String subscriptionId, String cursor, Integer limit) Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.
PauseSubscriptionResponse	pauseSubscription(String subscriptionId, PauseSubscriptionRequest body) Schedules a `PAUSE` action to pause an active subscription.
CompletableFuture<PauseSubscriptionResponse>	pauseSubscriptionAsync(String subscriptionId, PauseSubscriptionRequest body) Schedules a `PAUSE` action to pause an active subscription.
ResumeSubscriptionResponse	resumeSubscription(String subscriptionId, ResumeSubscriptionRequest body) Schedules a `RESUME` action to resume a paused or a deactivated subscription.
CompletableFuture<ResumeSubscriptionResponse>	resumeSubscriptionAsync(String subscriptionId, ResumeSubscriptionRequest body) Schedules a `RESUME` action to resume a paused or a deactivated subscription.
RetrieveSubscriptionResponse	retrieveSubscription(String subscriptionId, String include) Retrieves a specific subscription.
CompletableFuture<RetrieveSubscriptionResponse>	retrieveSubscriptionAsync(String subscriptionId, String include) Retrieves a specific subscription.
SearchSubscriptionsResponse	searchSubscriptions(SearchSubscriptionsRequest body) Searches for subscriptions.
CompletableFuture<SearchSubscriptionsResponse>	searchSubscriptionsAsync(SearchSubscriptionsRequest body) Searches for subscriptions.
SwapPlanResponse	swapPlan(String subscriptionId, SwapPlanRequest body) Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription.
CompletableFuture<SwapPlanResponse>	swapPlanAsync(String subscriptionId, SwapPlanRequest body) Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription.
UpdateSubscriptionResponse	updateSubscription(String subscriptionId, UpdateSubscriptionRequest body) Updates a subscription by modifying or clearing `subscription` field values.
CompletableFuture<UpdateSubscriptionResponse>	updateSubscriptionAsync(String subscriptionId, UpdateSubscriptionRequest body) Updates a subscription by modifying or clearing `subscription` field values.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSubscriptionsApi

public DefaultSubscriptionsApi(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

createSubscription

public CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest body)
                                              throws ApiException,
                                                     IOException

Enrolls a customer in a subscription. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square sends an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription).

Specified by:

createSubscription in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createSubscriptionAsync

public CompletableFuture<CreateSubscriptionResponse> createSubscriptionAsync(CreateSubscriptionRequest body)

Enrolls a customer in a subscription. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square sends an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription).

Specified by:

createSubscriptionAsync in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateSubscriptionResponse response from the API call

bulkSwapPlan

public BulkSwapPlanResponse bulkSwapPlan(BulkSwapPlanRequest body)
                                  throws ApiException,
                                         IOException

Schedules a plan variation change for all active subscriptions under a given plan variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

Specified by:

bulkSwapPlan in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkSwapPlanResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkSwapPlanAsync

public CompletableFuture<BulkSwapPlanResponse> bulkSwapPlanAsync(BulkSwapPlanRequest body)

Schedules a plan variation change for all active subscriptions under a given plan variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

Specified by:

bulkSwapPlanAsync in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkSwapPlanResponse response from the API call

searchSubscriptions

public SearchSubscriptionsResponse searchSubscriptions(SearchSubscriptionsRequest body)
                                                throws ApiException,
                                                       IOException

Searches for subscriptions. Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched. You can also optionally specify `customer_ids` to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

Specified by:

searchSubscriptions in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchSubscriptionsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchSubscriptionsAsync

public CompletableFuture<SearchSubscriptionsResponse> searchSubscriptionsAsync(SearchSubscriptionsRequest body)

Searches for subscriptions. Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched. You can also optionally specify `customer_ids` to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

Specified by:

searchSubscriptionsAsync in interface SubscriptionsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchSubscriptionsResponse response from the API call

retrieveSubscription

public RetrieveSubscriptionResponse retrieveSubscription(String subscriptionId,
                                                         String include)
                                                  throws ApiException,
                                                         IOException

Retrieves a specific subscription.

Specified by:

retrieveSubscription in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to retrieve.

include - Optional parameter: A query parameter to specify related information to be included in the response. The supported query parameter values are: - `actions`: to include scheduled actions on the targeted subscription.

Returns:

Returns the RetrieveSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveSubscriptionAsync

public CompletableFuture<RetrieveSubscriptionResponse> retrieveSubscriptionAsync(String subscriptionId,
                                                                                 String include)

Retrieves a specific subscription.

Specified by:

retrieveSubscriptionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to retrieve.

include - Optional parameter: A query parameter to specify related information to be included in the response. The supported query parameter values are: - `actions`: to include scheduled actions on the targeted subscription.

Returns:

Returns the RetrieveSubscriptionResponse response from the API call

updateSubscription

public UpdateSubscriptionResponse updateSubscription(String subscriptionId,
                                                     UpdateSubscriptionRequest body)
                                              throws ApiException,
                                                     IOException

Updates a subscription by modifying or clearing `subscription` field values. To clear a field, set its value to `null`.

Specified by:

updateSubscription in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateSubscriptionAsync

public CompletableFuture<UpdateSubscriptionResponse> updateSubscriptionAsync(String subscriptionId,
                                                                             UpdateSubscriptionRequest body)

Updates a subscription by modifying or clearing `subscription` field values. To clear a field, set its value to `null`.

Specified by:

updateSubscriptionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateSubscriptionResponse response from the API call

deleteSubscriptionAction

public DeleteSubscriptionActionResponse deleteSubscriptionAction(String subscriptionId,
                                                                 String actionId)
                                                          throws ApiException,
                                                                 IOException

Deletes a scheduled action for a subscription.

Specified by:

deleteSubscriptionAction in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription the targeted action is to act upon.

actionId - Required parameter: The ID of the targeted action to be deleted.

Returns:

Returns the DeleteSubscriptionActionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteSubscriptionActionAsync

public CompletableFuture<DeleteSubscriptionActionResponse> deleteSubscriptionActionAsync(String subscriptionId,
                                                                                         String actionId)

Deletes a scheduled action for a subscription.

Specified by:

deleteSubscriptionActionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription the targeted action is to act upon.

actionId - Required parameter: The ID of the targeted action to be deleted.

Returns:

Returns the DeleteSubscriptionActionResponse response from the API call

changeBillingAnchorDate

public ChangeBillingAnchorDateResponse changeBillingAnchorDate(String subscriptionId,
                                                               ChangeBillingAnchorDateRequest body)
                                                        throws ApiException,
                                                               IOException

Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) for a subscription.

Specified by:

changeBillingAnchorDate in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to update the billing anchor date.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the ChangeBillingAnchorDateResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

changeBillingAnchorDateAsync

public CompletableFuture<ChangeBillingAnchorDateResponse> changeBillingAnchorDateAsync(String subscriptionId,
                                                                                       ChangeBillingAnchorDateRequest body)

Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) for a subscription.

Specified by:

changeBillingAnchorDateAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to update the billing anchor date.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the ChangeBillingAnchorDateResponse response from the API call

cancelSubscription

public CancelSubscriptionResponse cancelSubscription(String subscriptionId)
                                              throws ApiException,
                                                     IOException

Schedules a `CANCEL` action to cancel an active subscription. This sets the `canceled_date` field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.

Specified by:

cancelSubscription in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to cancel.

Returns:

Returns the CancelSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelSubscriptionAsync

public CompletableFuture<CancelSubscriptionResponse> cancelSubscriptionAsync(String subscriptionId)

Schedules a `CANCEL` action to cancel an active subscription. This sets the `canceled_date` field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.

Specified by:

cancelSubscriptionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to cancel.

Returns:

Returns the CancelSubscriptionResponse response from the API call

listSubscriptionEvents

public ListSubscriptionEventsResponse listSubscriptionEvents(String subscriptionId,
                                                             String cursor,
                                                             Integer limit)
                                                      throws ApiException,
                                                             IOException

Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.

Specified by:

listSubscriptionEvents in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to retrieve the events for.

cursor - Optional parameter: When the total number of resulting subscription events exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

limit - Optional parameter: The upper limit on the number of subscription events to return in a paged response.

Returns:

Returns the ListSubscriptionEventsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listSubscriptionEventsAsync

public CompletableFuture<ListSubscriptionEventsResponse> listSubscriptionEventsAsync(String subscriptionId,
                                                                                     String cursor,
                                                                                     Integer limit)

Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.

Specified by:

listSubscriptionEventsAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to retrieve the events for.

cursor - Optional parameter: When the total number of resulting subscription events exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

limit - Optional parameter: The upper limit on the number of subscription events to return in a paged response.

Returns:

Returns the ListSubscriptionEventsResponse response from the API call

pauseSubscription

public PauseSubscriptionResponse pauseSubscription(String subscriptionId,
                                                   PauseSubscriptionRequest body)
                                            throws ApiException,
                                                   IOException

Schedules a `PAUSE` action to pause an active subscription.

Specified by:

pauseSubscription in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to pause.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the PauseSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

pauseSubscriptionAsync

public CompletableFuture<PauseSubscriptionResponse> pauseSubscriptionAsync(String subscriptionId,
                                                                           PauseSubscriptionRequest body)

Schedules a `PAUSE` action to pause an active subscription.

Specified by:

pauseSubscriptionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to pause.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the PauseSubscriptionResponse response from the API call

resumeSubscription

public ResumeSubscriptionResponse resumeSubscription(String subscriptionId,
                                                     ResumeSubscriptionRequest body)
                                              throws ApiException,
                                                     IOException

Schedules a `RESUME` action to resume a paused or a deactivated subscription.

Specified by:

resumeSubscription in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to resume.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the ResumeSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

resumeSubscriptionAsync

public CompletableFuture<ResumeSubscriptionResponse> resumeSubscriptionAsync(String subscriptionId,
                                                                             ResumeSubscriptionRequest body)

Schedules a `RESUME` action to resume a paused or a deactivated subscription.

Specified by:

resumeSubscriptionAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to resume.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the ResumeSubscriptionResponse response from the API call

swapPlan

public SwapPlanResponse swapPlan(String subscriptionId,
                                 SwapPlanRequest body)
                          throws ApiException,
                                 IOException

Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

Specified by:

swapPlan in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to swap the subscription plan for.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SwapPlanResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

swapPlanAsync

public CompletableFuture<SwapPlanResponse> swapPlanAsync(String subscriptionId,
                                                         SwapPlanRequest body)

Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

Specified by:

swapPlanAsync in interface SubscriptionsApi

Parameters:

subscriptionId - Required parameter: The ID of the subscription to swap the subscription plan for.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SwapPlanResponse response from the API call