memberships

Get Active Membership

Changed on

Get the authenticated user's active membership.

Returns 404 if the user has no active membership (e.g., still in onboarding and hasn't selected a plan yet).

Requires authentication via Bearer token. A guest has no membership and gets the no-membership answer without a Payments call.

get/memberships/

Request

  • Base URL: https://api.helloaxel.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.helloaxel.com/memberships/
  • Auth: HTTP bearer

Response

Successful Response

idstring uuid required
user_idstring uuid required
plan_idstring uuid required
statusstring required
started_atstring date-time required
expires_atstring date-time nullable required
cancelled_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
plan_slugstring required
plan_namestring required
plan_descriptionstring nullable required
referral_eligibleboolean required
price_cents_usdinteger nullable required
referred_bystring uuid nullable required
referrer_namestring nullable
is_complimentaryboolean
is_code_membershipboolean
is_memberboolean required

Whether user is a member (has full access via paid or referred plan).

Changes

  • fa4c4b94f345Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status