Create a membership plan

Minimum role: ADMIN. Active workspace via the X-Workspace-Id header.

POST/membership-plans

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).

x-api-keyAPI key · headerrequired

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

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).

Request body

requiredapplication/json

namestringrequired

min length 1

descriptionstring

pricenumberrequired

min 0

currencystringrequired

default: "COP"

billingCyclestringrequired

Allowed:MONTHLYQUARTERLYSEMIANNUALANNUALLIFETIME

benefitPresalebooleanrequired

default: false

benefitFreeTicketbooleanrequired

default: false

benefitDiscountbooleanrequired

default: false

benefitExclusiveContentbooleanrequired

default: false

benefitMerchbooleanrequired

default: false

isActivebooleanrequired

default: true

sortOrderintegerrequired

min 0 · max 9007199254740991 · default: 0

Responses

201

dataMembershipPlanrequired

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

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

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

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

Bodyapplication/json

namestring*descriptionstringpricenumber*currencystring*billingCyclestring*benefitPresaleboolean*benefitFreeTicketboolean*benefitDiscountboolean*benefitExclusiveContentboolean*benefitMerchboolean*isActiveboolean*sortOrderinteger*

Request

curl -X POST 'https://admin.appfreeticket.com/api/v1/membership-plans' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "price": 0,
  "currency": "COP",
  "billingCycle": "MONTHLY",
  "benefitPresale": false,
  "benefitFreeTicket": false,
  "benefitDiscount": false,
  "benefitExclusiveContent": false,
  "benefitMerch": false,
  "isActive": true,
  "sortOrder": 0
}'

const response = await fetch("https://admin.appfreeticket.com/api/v1/membership-plans", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"price\": 0,\n  \"currency\": \"COP\",\n  \"billingCycle\": \"MONTHLY\",\n  \"benefitPresale\": false,\n  \"benefitFreeTicket\": false,\n  \"benefitDiscount\": false,\n  \"benefitExclusiveContent\": false,\n  \"benefitMerch\": false,\n  \"isActive\": true,\n  \"sortOrder\": 0\n}"
});

import requests

response = requests.post(
    "https://admin.appfreeticket.com/api/v1/membership-plans",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"price\": 0,\n  \"currency\": \"COP\",\n  \"billingCycle\": \"MONTHLY\",\n  \"benefitPresale\": false,\n  \"benefitFreeTicket\": false,\n  \"benefitDiscount\": false,\n  \"benefitExclusiveContent\": false,\n  \"benefitMerch\": false,\n  \"isActive\": true,\n  \"sortOrder\": 0\n}",
)

Response

{
  "data": {
    "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"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}