Square

Square Subscriptions API

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

Documentation GitHub OpenAPI

Business capability

Subscription Lifecycle Management BC-4240

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/subscriptions Enroll a customer in a subscription · Square Create Subscription #

Ask an LLM

“How do I sign a customer up for a subscription plan?”

“What happens if I create a subscription without a card on file?”

Tell an agent

Subscribe customer {customer_id} to plan variation {plan_variation_id} at location {location_id}.

Enroll customer {customer_id} at {location_id} and charge card {card_id}.

POST /v2/subscriptions/bulk-swap-plan Move all subscribers to a new plan variation · Square Bulk Swap Plan #

Ask an LLM

“Can I migrate every active subscriber from one plan variation to another?”

“Is there a bulk way to swap plans for all subscriptions at a location?”

Tell an agent

Swap all subscriptions on {old_plan_variation_id} to {new_plan_variation_id} at location {location_id}.

Bulk move subscribers at {location_id} off plan variation {old_plan_variation_id} onto {new_plan_variation_id}.

POST /v2/subscriptions/search Search subscriptions by customer or location · Square Search Subscriptions #

Ask an LLM

“Which subscriptions does a given customer have?”

“Can I list subscriptions at specific locations, oldest first?”

Tell an agent

Search subscriptions matching {query}.

Find subscriptions for the filters in {query}, up to {limit}.

GET /v2/subscriptions/{subscription_id} Get one subscription · Square Retrieve Subscription #

Ask an LLM

“What is the status and next billing date of a subscription?”

“Can I include scheduled actions when fetching a subscription?”

Tell an agent

Get subscription {subscription_id}.

Show subscription {subscription_id} including {include}.

PUT /v2/subscriptions/{subscription_id} Update subscription fields · Square Update Subscription #

Ask an LLM

“Can I change the tax percentage or price override on an existing subscription?”

“How do I clear a field on a subscription?”

Tell an agent

Update subscription {subscription_id} with {subscription}.

Change the fields on subscription {subscription_id} as given in {subscription}.

DELETE /v2/subscriptions/{subscription_id}/actions/{action_id} Delete a scheduled subscription action · Square Delete Subscription Action #

Ask an LLM

“Can I undo a scheduled pause or cancellation on a subscription?”

“How do I remove a pending action that is queued on a subscription?”

Tell an agent destructive · confirm first

Delete action {action_id} on subscription {subscription_id}.

Remove the scheduled action {action_id} from subscription {subscription_id}.

POST /v2/subscriptions/{subscription_id}/billing-anchor Change a subscription's billing day · Square Change Billing Anchor Date #

Ask an LLM

“Can I move the day of the month a subscriber is billed?”

“When does a billing anchor date change take effect?”

Tell an agent

Change subscription {subscription_id} to bill on day {monthly_billing_anchor_date}.

Set billing anchor for {subscription_id} to {monthly_billing_anchor_date} starting {effective_date}.

POST /v2/subscriptions/{subscription_id}/cancel Cancel a subscription · Square Cancel Subscription #

Ask an LLM

“How do I cancel a customer's subscription at the end of the billing period?”

“Does canceling a subscription stop billing immediately?”

Tell an agent destructive · confirm first

Cancel subscription {subscription_id}.

Schedule cancellation of subscription {subscription_id} at period end.

GET /v2/subscriptions/{subscription_id}/events List events for a subscription · Square List Subscription Events #

Ask an LLM

“What changes have happened to a subscription over time?”

“Can I see when a subscription was paused, resumed or swapped?”

Tell an agent

List events for subscription {subscription_id}.

Show the history of subscription {subscription_id}, {limit} events at a time.

POST /v2/subscriptions/{subscription_id}/pause Pause a subscription · Square Pause Subscription #

Ask an LLM

“Can a subscriber pause for a couple of billing cycles?”

“How do I pause a subscription and set when it resumes?”

Tell an agent

Pause subscription {subscription_id} starting {pause_effective_date}.

Pause subscription {subscription_id} for {pause_cycle_duration} cycles because {pause_reason}.

POST /v2/subscriptions/{subscription_id}/resume Resume a paused subscription · Square Resume Subscription #

Ask an LLM

“How do I restart a paused or deactivated subscription?”

“Can I choose whether a resume happens now or at the next billing date?”

Tell an agent

Resume subscription {subscription_id}.

Resume subscription {subscription_id} on {resume_effective_date}.

POST /v2/subscriptions/{subscription_id}/swap-plan Swap one subscription to another plan · Square Swap Plan #

Ask an LLM

“Can I upgrade a single subscriber to a different plan variation?”

“What does swapping the plan on one subscription change?”

Tell an agent

Swap subscription {subscription_id} to plan variation {new_plan_variation_id}.

Move just subscription {subscription_id} onto plan {new_plan_variation_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-subscriptions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Subscriptions API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (125 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-subscriptions-api-openapi.yml

Square Subscriptions API

Operations 12

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification