Documentation
External Checkout Connections API
Connect FastSpring, Gumroad or WooCommerce one-time purchases to perpetual licenses without moving their payments or tax.
Choose who takes the payment
Full Store connects your own design to SoundSync-managed Stripe or PayPal checkout. SoundSync is the merchant for those sales and manages their applicable tax flow. One-time managed purchases support Stripe and PayPal; subscriptions use Stripe. Your frontend does not collect card details or calculate its own tax.
External licensing keeps FastSpring, Gumroad or your WooCommerce store and gateway responsible for checkout, tax, receipts, monetary refunds and payouts. SoundSync connects supported confirmed purchases to perpetual licenses and customer access. External proceeds do not become SoundSync checkout revenue or payout earnings. Service and external-redemption usage charges still apply.
External purchases are not managed checkout
A verified external purchase can grant a one-time perpetual license through a configured FastSpring, Gumroad or WooCommerce connection. It does not make SoundSync the merchant for that purchase, move its tax obligations or pay the external provider's fees. Refund the money through the original provider; authenticated full-return events remove only the connector's original access. Partial or ambiguous returns require license review.
A provider notification does not silently verify the buyer's email, create a password or enroll the buyer in marketing. Customers separately use the current verified account/claim flow. Signup and eligible SoundSync purchase enrollment retain the published marketing policy, including unsubscribe and suppression protections.
A connection has its own environment
Create separate Test and Live connections with separate mappings and credentials. External Test/Live selection does not change SoundSync's Stripe or PayPal environment. Test events produce simulated keys, not customer access, usable plugin activations, payout earnings or usage charges. Use temporary evaluation licenses for plugin testing.
SoundSync
Understand each state before enabling
| State | Meaning |
|---|---|
| Draft | Save the provider-specific configuration and owned product mappings. A changed mapping invalidates the previous configuration check. |
| Configuration checked | Saved configuration is internally consistent. This check does not contact the provider or prove a hosted purchase. |
| Provider seen | An authenticated provider request reached the connection; this is distinct from a successful full purchase/refund rehearsal. |
| Active | Checked eligible mappings can fulfill supported completed sales. A reserved key alone is not payment confirmation. |
| Paused | New issuance is stopped. Supported authenticated returns/revocations remain separate so old access can still be corrected. |
| Review required | Missing mappings or partial/ambiguous returns need deliberate correction; do not guess which license to revoke. |
One-time perpetual products
Map serial-enabled one-time products. Subscriptions, bundles, expansions, preorder activation and gifts to another recipient are outside this connector workflow. Full confirmed units record external-redemption usage once; retries and reservations do not add another charge. Mappings and order snapshots protect independent purchases when a product is returned.
Retry the original evidence
Inspect the integration event log, correct the saved cause, then retry the stored original authenticated event. A browser return or posted paid flag never proves a purchase. Duplicate events do not issue duplicate licenses; conflicting identity or quantities require reconciliation. Partial/amount-only returns remain in review, not a silent full revocation.
SoundSync
Provider setup
SoundSync
Requests and responses
/api/developer/commerce-integrations
List provider connections, mappings and recent integration activity
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"publicId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"configurationCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"providerSeenAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"mappings": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations
Create a draft provider connection
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Request fields
- provider: fastspring | gumroad | woocommerce
- environment: test | live (required)
- name: string
- Returns
- 201: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string",
"maxLength": 80
}
},
"additionalProperties": true,
"required": [
"environment"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"publicId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"configurationCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"providerSeenAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/{id}/mappings
Save a provider product mapping
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Request fields
- externalProduct: string (required)
- productId: integer (required)
- enabled: boolean
- checkoutUrl: string
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. FastSpring uses product path, Gumroad API product_id, WooCommerce numeric product/variation ID. Product must be owned, available and serial-enabled, without a subscription, bundle or expansion. Saving invalidates the prior configuration check and moves an active connection to draft. checkoutUrl must use the allowed provider/store origin.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"externalProduct": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"enabled": {
"type": "boolean"
},
"checkoutUrl": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"externalProduct",
"productId"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"mapping": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/{id}/credentials
Save private provider configuration
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Request fields
- accessToken: string
- storeOrigin: string
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Gumroad requires a view_sales token and verifies the seller against its fixed API host; WooCommerce requires the HTTPS store origin. FastSpring credentials are generated by setup instead. No single request schema requires both provider-specific fields. Reconfiguration returns the connection to draft.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"storeOrigin": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"publicId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"configurationCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"providerSeenAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/{id}/check
Check saved mappings and configuration
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Does not contact the provider or prove a purchase. providerVerified reports whether an authenticated provider request was seen; it is separate from the configuration check.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"message": {
"type": "string"
},
"providerVerified": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/{id}/status
Enable checked fulfillment or pause new issuance
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Request fields
- status: active | paused (required)
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Enabling requires current configuration check and valid mappings. Pause blocks new fulfillment; authenticated return/revocation handling remains separate.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"paused"
]
}
},
"additionalProperties": true,
"required": [
"status"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"publicId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"configurationCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"providerSeenAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/{id}/setup
Read private fulfillment and webhook instructions
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"publicId": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"fastspring",
"gumroad",
"woocommerce"
]
},
"environment": {
"type": "string",
"enum": [
"test",
"live"
]
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"configurationCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"providerSeenAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/commerce-integrations/events/{id}/retry
Retry the original stored authenticated event
- Auth
- Account Bearer session token
- Scope
- api_keys.manage and all-products scope in the selected developer workspace; connection, event and product ownership are checked.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Retry uses the stored original payload after correcting the cause. It does not send a provider purchase or refund request, and duplicate issuance remains protected.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"code": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/integrations/commerce/fastspring/{publicId}/webhook
Receive authenticated fastspring purchase and access events
- Auth
- FastSpringSignature
- Scope
- Connection-bound provider authentication and environment; raw-byte signatures/merchant verification apply.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Use the provider-generated payload, not a hand-built success flag. Exact raw bytes are required for signature verification. Full supported returns revoke only the original grants; partial/ambiguous returns require review. A 503 requests original-event retry; duplicate/conflicting events are reconciled. Uses X-FS-Signature HMAC-SHA256 and expanded events.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"code": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/integrations/commerce/gumroad/{publicId}/webhook/{secret}
Receive authenticated gumroad purchase and access events
- Auth
- Private generated URL secret plus independent merchant API sale verification; no account Bearer token
- Scope
- Connection-bound provider authentication and environment; raw-byte signatures/merchant verification apply. The required secret path parameter is private authentication, not a public anonymous grant.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Use the provider-generated payload, not a hand-built success flag. Exact raw bytes are required for signature verification. Full supported returns revoke only the original grants; partial/ambiguous returns require review. A 503 requests original-event retry; duplicate/conflicting events are reconciled. The URL secret authenticates notification hints; saved merchant credentials independently verify the sale, seller, product and current refund/access state. Treat the entire URL as private.
Request, response and error reference
Request (application/json or application/x-www-form-urlencoded)
{
"type": "object",
"properties": {},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"code": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/integrations/commerce/woocommerce/{publicId}/webhook
Receive authenticated woocommerce purchase and access events
- Auth
- WooCommerceSignature
- Scope
- Connection-bound provider authentication and environment; raw-byte signatures/merchant verification apply.
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- External one-time perpetual licensing only. No external gross sales, payment processing, tax, monetary refund or payout balance is created in SoundSync. Test connections simulate keys without usable licenses or financial entries. Confirmed Live units record idempotent external-redemption usage. Configuration checks are not hosted provider tests. Setup responses contain private credentials and must not be logged, shared or cached. All responses use Cache-Control: no-store. Use the provider-generated payload, not a hand-built success flag. Exact raw bytes are required for signature verification. Full supported returns revoke only the original grants; partial/ambiguous returns require review. A 503 requests original-event retry; duplicate/conflicting events are reconciled. Uses X-WC-Webhook-Signature HMAC-SHA256 and matching X-WC-Webhook-Source. An unsigned form registration ping returns ok:true,ping:true but never processes an order or grants access.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"code": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/integrations/commerce/fastspring/{publicId}/fulfill/{mappingId}
Reserve FastSpring quantity-based license keys
- Auth
- FastSpringFulfillment
- Scope
- Active connection and owned eligible mapping; matching authenticated completed event is separately required.
- Request fields
- reference: string (required)
- email: string (required)
- name: string
- quantity: integer (required)
- subscription: string
- Returns
- 200: Inspect the response schema and conditional states.
- Notes
- Returns the same reserved keys for repeated order/reference/quantity requests. A reservation is not an entitlement or successful activation. Test keys are simulated. Keep this credential on FastSpring servers, not in the plugin, customer email or browser. Ordinary offline-grace behavior on already disconnected devices is unchanged.
Request, response and error reference
Request (application/x-www-form-urlencoded or application/json)
{
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"quantity": {
"type": "integer",
"minimum": 1
},
"subscription": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"reference",
"email",
"quantity"
]
}
HTTP 200 response (text/plain)
{
"type": "string"
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
