Square API
You are viewing an old version of the API
Subscriptions
Square API
Create and manage subscriptions.
Subscriptions enable sellers to generate a reliable cash flow and recurring revenue to grow their businesses. Square offers the Subscriptions API for developers to embed subscription functionality in their applications. You first create a subscription plan using the Catalog API and then use the Subscriptions API to create and manage subscriptions.
Guides: Subscriptions Webhooks
-
Create subscription
POST /v2/subscriptions - Creates a subscription to a subscription plan by a customer.
-
Search subscriptions
POST /v2/subscriptions/search - Searches for subscriptions.
-
Retrieve subscription
GET /v2/subscriptions/{subscription_id} - Retrieves a subscription.
-
Update subscription
PUT /v2/subscriptions/{subscription_id} - Updates a subscription.
-
Delete subscription action
DELETE /v2/subscriptions/{subscription_id}/actions/{action_id} - Deletes a scheduled action for a subscription.
BETA -
Cancel subscription
POST /v2/subscriptions/{subscription_id}/cancel - 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.
-
List subscription events
GET /v2/subscriptions/{subscription_id}/events - Lists all events for a specific subscription.
-
Pause subscription
POST /v2/subscriptions/{subscription_id}/pause - Schedules a PAUSE action to pause an active subscription.
BETA -
Resume subscription
POST /v2/subscriptions/{subscription_id}/resume - Schedules a RESUME action to resume a paused or a deactivated subscription.
-
Swap plan
POST /v2/subscriptions/{subscription_id}/swap-plan - Schedules a SWAP_PLAN action to swap a subscription plan in an existing subscription.
BETA