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

Squarespace Transactions API

The Squarespace Transactions API provides access to financial transaction records for a Squarespace merchant site. Developers can retrieve transaction history, including payment amounts, fees, and associated order or subscription references.

This API exposes 4 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.squarespace.com, https://api.squarespace.com/1.0.

4 operations 4 paths 21 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.squarespace.com
https://api.squarespace.com/1.0
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Squarespace Transactions API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (Authorization). It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authenticate using an API key or OAuth access token. Include the token in the Authorization header as "Bearer YOURTOKEN".

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Transactions 4
GET
/1.0/commerce/transactions
List transactions
getDocumentsByUpdatedOn 6 params → 200400
GET
/1.0/commerce/transactions/{documentIds}
Get transactions
getDocumentsById 3 params → 200400404
GET
/commerce/transactions
Retrieve All Transactions
listTransactions 3 params → 200400401403429
GET
/commerce/transactions/{transactionIds}
Retrieve Specific Transactions
getTransactions 1 param → 200400401403404429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are TransactionDocument (17 properties), TransactionPayment (13 properties), TransactionProcessingFee (9 properties), TransactionDocument_2 (8 properties). Each schema is shown below with its type and property counts.

TransactionRefund
object
Array of refunds for the payment transaction.
4 properties
TransactionDiscount
object
Array of discounts for an order payment transaction; empty for donations.
3 properties
TransactionSalesLineItem
object
Array of sales items for an order payment transaction; empty for donations.
6 properties
TransactionPayment
object
Array of payment transactions for the order or donation.
13 properties
PaymentGatewayError
string
Captures errors from the payment gateway; value is null if not applicable.
TransactionShippingLineItem
object
Array of shipping line items.
6 properties
ExternalTransactionProperty
object
Array of properties for the payment transaction provided by the payment gateway. Properties are listed in key/value pairs.
2 properties
StandardErrorPayload
object
5 properties
TransactionListResponse
object
1 property
TransactionProcessingFee
object
Array of processing fees associated with the payment.
9 properties
TransactionTax
object
Array of taxes for the shipping line item.
4 properties
PaginatedTransactionListResponse
object
2 properties
TransactionProcessingFeeRefund
object
Array of processing fee refunds for the payment.
6 properties
TransactionDocument
object
Array of Document resources.
17 properties
MonetaryAmount
object
A monetary amount with currency code and decimal value.
2 properties
Pagination
object
Pagination metadata included with list responses
3 properties
TransactionLineItem
object
A financial line item within a transaction document
5 properties
Money
object
A monetary value with currency
2 properties
Payment
object
A single payment record including gateway and amount information
7 properties
Error
object
Standard error response returned by the Squarespace API
4 properties
TransactionDocument_2
object
A document grouping financial transaction details for a single order or donation. Contains payment gateway information and line-level financial data.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

squarespace-transactions-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Squarespace Transactions 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.