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 for a customer to a subscription plan.
BETA -
Search subscriptions
POST /v2/subscriptions/search - Searches for subscriptions.
BETA -
Retrieve subscription
GET /v2/subscriptions/{subscription_id} - Retrieves a subscription.
BETA -
Update subscription
PUT /v2/subscriptions/{subscription_id} - Updates a subscription.
BETA -
Cancel subscription
POST /v2/subscriptions/{subscription_id}/cancel - Sets the canceled_date field to the end of the active billing period.
BETA -
List subscription events
GET /v2/subscriptions/{subscription_id}/events - Lists all events for a specific subscription.
BETA -
Resume subscription
POST /v2/subscriptions/{subscription_id}/resume - Resumes a deactivated subscription.
BETA