How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Square

Square Subscriptions API

The Subscriptions API from Square — 11 operation(s) for subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Square Subscriptions API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 12 operations across 11 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

12 operations 11 paths 39 schemas 1 DELETE2 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
Contact
Square Developer Platform
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Square Subscriptions API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 12
POST
/v2/subscriptions
Square Create Subscription
CreateSubscription body → 200
POST
/v2/subscriptions/bulk-swap-plan
Square Bulk Swap Plan
BulkSwapPlan body → 200
POST
/v2/subscriptions/search
Square Search Subscriptions
SearchSubscriptions body → 200
GET
/v2/subscriptions/{subscription_id}
Square Retrieve Subscription
RetrieveSubscription 2 params → 200
PUT
/v2/subscriptions/{subscription_id}
Square Update Subscription
UpdateSubscription 1 param body → 200
DELETE
/v2/subscriptions/{subscription_id}/actions/{action_id}
Square Delete Subscription Action
DeleteSubscriptionAction 2 params → 200
POST
/v2/subscriptions/{subscription_id}/billing-anchor
Square Change Billing Anchor Date
ChangeBillingAnchorDate 1 param body → 200
POST
/v2/subscriptions/{subscription_id}/cancel
Square Cancel Subscription
CancelSubscription 1 param → 200
GET
/v2/subscriptions/{subscription_id}/events
Square List Subscription Events
ListSubscriptionEvents 3 params → 200
POST
/v2/subscriptions/{subscription_id}/pause
Square Pause Subscription
PauseSubscription 1 param body → 200
POST
/v2/subscriptions/{subscription_id}/resume
Square Resume Subscription
ResumeSubscription 1 param body → 200
POST
/v2/subscriptions/{subscription_id}/swap-plan
Square Swap Plan
SwapPlan 1 param body → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Subscription (19 properties), CreateSubscriptionRequest (13 properties), SubscriptionEvent (7 properties), SubscriptionAction (6 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
SubscriptionEvent
object
Describes changes to a subscription and the subscription status.
7 properties 4 required
SearchSubscriptionsFilter
object
Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by the [SearchSubscriptions](api-endpoint:Subscriptions-…
3 properties
RetrieveSubscriptionResponse
object
Defines output parameters in a response from the [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint.
2 properties
BulkSwapPlanRequest
object
Defines input parameters in a call to the [BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint.
3 properties 3 required
Phase
object
Represents a phase, which can override subscription phases as defined by planid
4 properties
SearchSubscriptionsResponse
object
Defines output parameters in a response from the [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.
3 properties
SubscriptionStatus
string
Supported subscription statuses.
UpdateSubscriptionResponse
object
Defines output parameters in a response from the [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.
2 properties
SwapPlanRequest
object
Defines input parameters in a call to the [SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint.
2 properties
ChangeTiming
string
Supported timings when a pending change, as an action, takes place to a subscription.
SearchSubscriptionsRequest
object
Defines input parameters in a request to the [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.
4 properties
PhaseInput
object
Represents the arguments used to construct a new phase.
2 properties 1 required
SubscriptionActionType
string
Supported types of an action as a pending change to a subscription.
ResumeSubscriptionResponse
object
Defines output parameters in a response from the [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint.
3 properties
Subscription
object
Represents a subscription purchased by a customer. For more information, see [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manag…
19 properties
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
BulkSwapPlanResponse
object
Defines output parameters in a response of the [BulkSwapPlan](api-endpoint:Subscriptions-BulkSwapPlan) endpoint.
2 properties
SubscriptionEventSubscriptionEventType
string
Supported types of an event occurred to a subscription.
CancelSubscriptionResponse
object
Defines output parameters in a response from the [CancelSubscription](api-endpoint:Subscriptions-CancelSubscription) endpoint.
3 properties
SubscriptionEventInfo
object
Provides information about the subscription event.
2 properties
SubscriptionAction
object
Represents an action as a pending change to a subscription.
6 properties
UpdateSubscriptionRequest
object
Defines input parameters in a request to the [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.
1 property
SubscriptionEventInfoCode
string
Supported info codes of a subscription event.
SwapPlanResponse
object
Defines output parameters in a response of the [SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint.
3 properties
ChangeBillingAnchorDateRequest
object
Defines input parameters in a request to the [ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint.
2 properties
PauseSubscriptionRequest
object
Defines input parameters in a request to the [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.
5 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
SubscriptionSource
object
The origination details of the subscription.
1 property
CreateSubscriptionResponse
object
Defines output parameters in a response from the [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.
2 properties
DeleteSubscriptionActionResponse
object
Defines output parameters in a response of the [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction) endpoint.
2 properties
ChangeBillingAnchorDateResponse
object
Defines output parameters in a request to the [ChangeBillingAnchorDate](api-endpoint:Subscriptions-ChangeBillingAnchorDate) endpoint.
3 properties
SearchSubscriptionsQuery
object
Represents a query, consisting of specified query expressions, used to search for subscriptions.
1 property
CreateSubscriptionRequest
object
Defines input parameters in a request to the [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.
13 properties 2 required
ResumeSubscriptionRequest
object
Defines input parameters in a request to the [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint.
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
PauseSubscriptionResponse
object
Defines output parameters in a response from the [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.
3 properties
ListSubscriptionEventsResponse
object
Defines output parameters in a response from the [ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents).
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-subscriptions-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
AE Profile APIs.io
Square Channels API
AE Profile APIs.io
Square Transfer Orders API
AE Profile APIs.io
Square ApplePay API
AE Profile APIs.io
Square BankAccounts API
AE Profile APIs.io
Square BookingCustomAttributes API
AE Profile APIs.io
Square Bookings API
AE Profile APIs.io
Square Cards API
AE Profile APIs.io
Square CashDrawers API
AE Profile APIs.io
Square Catalog API
AE Profile APIs.io
Square Checkout API
AE Profile APIs.io
Square CustomerCustomAttributes API
AE Profile APIs.io
#Subscription
← Back to S APIs
API Details
ID
square:square-subscriptions-api
Server
https://connect.squareup.com
Docs
https://developer.squareup.com/docs/payments-overview
Provider
Square
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=square-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/square-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Square Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.