Struct square_api_client::api::SubscriptionsApi

pub struct SubscriptionsApi { /* private fields */ }

Create and manage subscriptions.

Implementations

impl SubscriptionsApi

pub fn new(config: Configuration, client: HttpClient) -> Self

Instantiates a new SubscriptionsApi

pub async fn create_subscription(
    &self,
    body: &CreateSubscriptionRequest
) -> Result<CreateSubscriptionResponse, ApiError>

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.

pub async fn search_subscriptions(
    &self,
    body: &SearchSubscriptionsRequest
) -> Result<SearchSubscriptionsResponse, ApiError>

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.

pub async fn retrieve_subscription(
    &self,
    subscription_id: &str,
    params: &RetrieveSubscriptionParameters
) -> Result<RetrieveSubscriptionResponse, ApiError>

Retrieves a subscription.

pub async fn update_subscription(
    &self,
    subscription_id: &str,
    body: &UpdateSubscriptionRequest
) -> Result<UpdateSubscriptionResponse, ApiError>

Updates a subscription.

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

pub async fn delete_subscription_action(
    &self,
    subscription_id: &str,
    action_id: &str
) -> Result<DeleteSubscriptionActionResponse, ApiError>

Deletes a scheduled action for a subscription.

pub async fn cancel_subscription(
    &self,
    subscription_id: &str
) -> Result<CancelSubscriptionResponse, ApiError>

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.

pub async fn list_subscription_events(
    &self,
    subscription_id: &str,
    params: &ListSubscriptionEventsParameters
) -> Result<ListSubscriptionEventsResponse, ApiError>

Lists all events for a specific subscription.

pub async fn pause_subscription(
    &self,
    subscription_id: &str,
    body: &PauseSubscriptionRequest
) -> Result<PauseSubscriptionResponse, ApiError>

Schedules a PAUSE action to pause an active subscription.

pub async fn resume_subscription(
    &self,
    subscription_id: &str,
    body: &ResumeSubscriptionRequest
) -> Result<ResumeSubscriptionResponse, ApiError>

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

pub async fn swap_plan(
    &self,
    subscription_id: &str,
    body: &SwapPlanRequest
) -> Result<SwapPlanResponse, ApiError>

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