Create Membership Template

Create a new Membership Template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Data to create a new Membership Template.

Data to create a Membership Template

string
required

Membership Template Name

string

Membership Template Description

int64
required

Membership Type Id. Indicates if the Membership Template is for a Class or Session Pack.

int64

Revenue Category Id

int64
required

Attendance Type Id. Determines if the Membership is Limited or Unlimited.

int32

Attendance Limit

int32

The frequency/number of days that the class attendance limit applies to. Only for Limited Class Plans that have an attendance limit type of daily.

int64

Attendance Limit Type Id. Expects a Unit of Time Id.

int32

The number of sessions for the membership

boolean

Determines if the membership expires. Only applicable to Class and Appointment Packs

int64

Expiration Type Id

int32

Expiration Length

int64

The Service for the Membership. Only applicable to Appointment Pack Templates.

int64

Id of the Service Duration for the Membership. If no ServiceDuration is provided and there is only 1 available ServiceDuration, that duration will be used. Only applicable to Appointment Pack Templates.

boolean

When true, can use rollover sessions.

int32

The maximum number of sessions that can be used in a booking period (attendance limitation + rollover). Only applies to limited plan memberships. When value is 0, no limit exists.

locations
array of int64s

Locations to add to the Membership Template.

locations
programs
array of int64s

Programs to add to the Membership Template.

programs
int64

Id of the Contract that applies to the Membership Template

string

HTML for the message that will be shown in OSP for this membership when confirming purchase

payment_plan_templates
array of objects

Payment Plans to add to the Membership Template

payment_plan_templates
Headers
string
required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json