com.squareup.square.api

Interface SubscriptionsApi

All Known Implementing Classes:

DefaultSubscriptionsApi

public interface SubscriptionsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CancelSubscriptionResponse	cancelSubscription(String subscriptionId) Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date` field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.
CompletableFuture<CancelSubscriptionResponse>	cancelSubscriptionAsync(String subscriptionId) Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date` field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.
CreateSubscriptionResponse	createSubscription(CreateSubscriptionRequest body) Creates a subscription to a subscription plan by a customer.
CompletableFuture<CreateSubscriptionResponse>	createSubscriptionAsync(CreateSubscriptionRequest body) Creates a subscription to a subscription plan by a customer.
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 for a specific subscription.
CompletableFuture<ListSubscriptionEventsResponse>	listSubscriptionEventsAsync(String subscriptionId, String cursor, Integer limit) Lists all 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 subscription.
CompletableFuture<RetrieveSubscriptionResponse>	retrieveSubscriptionAsync(String subscriptionId, String include) Retrieves a 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 in an existing subscription.
CompletableFuture<SwapPlanResponse>	swapPlanAsync(String subscriptionId, SwapPlanRequest body) Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.
UpdateSubscriptionResponse	updateSubscription(String subscriptionId, UpdateSubscriptionRequest body) Updates a subscription.
CompletableFuture<UpdateSubscriptionResponse>	updateSubscriptionAsync(String subscriptionId, UpdateSubscriptionRequest body) Updates a subscription.

Method Detail

createSubscription

CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest body)
                                       throws ApiException,
                                              IOException

Creates a subscription to a subscription plan by a customer. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills 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.

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

CompletableFuture<CreateSubscriptionResponse> createSubscriptionAsync(CreateSubscriptionRequest body)

Creates a subscription to a subscription plan by a customer. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills 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.

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

searchSubscriptions

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. For more information, see [Retrieve subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions).

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

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. For more information, see [Retrieve subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions).

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

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

Retrieves a subscription.

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

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

Retrieves a subscription.

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

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

Updates a subscription. You can set, modify, and clear the `subscription` field values.

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

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

Updates a subscription. You can set, modify, and clear the `subscription` field values.

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

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

Deletes a scheduled action for a subscription.

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

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

Deletes a scheduled action for a subscription.

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

cancelSubscription

CancelSubscriptionResponse cancelSubscription(String subscriptionId)
                                       throws ApiException,
                                              IOException

Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date` field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.

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

CompletableFuture<CancelSubscriptionResponse> cancelSubscriptionAsync(String subscriptionId)

Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date` field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.

Parameters:

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

Returns:

Returns the CancelSubscriptionResponse response from the API call

listSubscriptionEvents

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

Lists all events for a specific subscription.

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/working-with-apis/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

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

Lists all events for a specific subscription.

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/working-with-apis/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

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

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

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

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

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

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

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

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

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

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

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

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

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

Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.

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

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

Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.

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