REST API

The Insy REST API is JSON over HTTPS, served from api.insy.io and authenticated with a server-side API key sent as a bearer token.

The Insy REST API lets you provision memberships, open hosted checkout sessions and sign people up for drops from your own funnel, storefront or backoffice. It speaks JSON over HTTPS, authenticates with an API key, and has no SDK — every example here is plain HTTP you can port to whatever your stack already uses.

Base URL

https://api.insy.io

Send Content-Type: application/json on requests with a body, and read the response as JSON. Paths are unversioned — no /v1, no version header — and endpoints only ever grow, so write clients that ignore unknown response fields rather than ones that fail on them.

The response envelope

Most endpoints wrap their payload in a BaseResponse: a success carries data, a failure carries errorCode and usually message. Keys that do not apply are usually omitted, but some endpoints send data: null on failure instead — so don’t test for the data key, check the field you actually need with a positive test like data?.link.

{
  "success": true,
  "data": {
    "status": "created"
  }
}

{
  "success": false,
  "errorCode": "not_found",
  "message": "Community not found"
}

Type every key as optional. Check the HTTP status first, then success, then read data — see Errors for the status codes and the different shape that validation and auth failures use.

Next