Skip to content
FreeTicketDocs
Esc
↑↓navigate↵open⌘Jpreview

Buyer membership status in a workspace

Requires the X-Customer-Session header. The enterprise service API key is OPTIONAL: with a key, the workspace is the one pinned to it (workspaceId is ignored); without a key, workspaceId is REQUIRED (422 if missing). active is true only with an ACTIVE, unexpired membership. If none is current, membership returns the most recent one (expired, cancelled or pending payment) so the landing page can choose the CTA; null = never a member of that workspace.

GET/customer/membership
Authorization
AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

or
x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters
workspaceIdstring

Required only without an enterprise service API key. Ignored with a key.

Header parameters
X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses
200

OK

dataCustomerMembershipStaterequired
Show properties
activebooleanrequired

true only with an ACTIVE, unexpired membership in this workspace.

membershipobject | nullrequired
Show properties
Any of:
object
idstringrequired
statusstringrequired
Allowed:PENDINGACTIVEEXPIREDCANCELLEDPAUSED
planMembershipPlanrequired
Show properties
idstringrequired
organizationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
namestringrequired
descriptionstring | nullrequired
Show properties
Any of:
string
string
null
null
pricenumberrequired
currencystringrequired
billingCyclestringrequired
Allowed:MONTHLYQUARTERLYSEMIANNUALANNUALLIFETIME
benefitsobjectrequired
Show properties
presalebooleanrequired
freeTicketbooleanrequired
discountbooleanrequired
exclusiveContentbooleanrequired
merchbooleanrequired
isActivebooleanrequired
sortOrderintegerrequired
min -9007199254740991 · max 9007199254740991
createdAtstringrequired
startedAtstring | nullrequired
Show properties
Any of:
string
string
null
null
expiresAtstring | nullrequired

null = LIFETIME or a membership with no expiry.

Show properties
Any of:
string
string
null
null
autoRenewbooleanrequired
null
null
401

Missing or invalid credential.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
403

Insufficient role or resource not accessible.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
404

Resource does not exist or is out of scope.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
422

Operation error.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://admin.appfreeticket.com/api/v1/customer/membership' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "data": {
    "active": true,
    "membership": {
      "id": "string",
      "status": "PENDING",
      "plan": {
        "id": "string",
        "organizationId": "string",
        "name": "string",
        "description": "string",
        "price": 0,
        "currency": "string",
        "billingCycle": "MONTHLY",
        "benefits": {
          "presale": true,
          "freeTicket": true,
          "discount": true,
          "exclusiveContent": true,
          "merch": true
        },
        "isActive": true,
        "sortOrder": -9007199254740991,
        "createdAt": "string"
      },
      "startedAt": "string",
      "expiresAt": "string",
      "autoRenew": true
    }
  }
}