Create Membership

post

https://api.wodify.com/v1/memberships

Create a new Membership for a Client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Data to create a new Membership. Any values not provided will be populated from the Membership Template.

Data to create a new Membership

client_id

int64

required

Id of the Client that the Membership is being created for

membership_template_id

int64

required

Id of the Template that the Membership will be created from

location_of_sale_id

int64

Id of the Location this Membership is being sold from. If no value is provided, the Clients default Location will be used.

start_date

date

The date the Membership will start. If no value is provided, the current date will be used.

attendance_type_id

int64

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

attendance_limit

int32

The number of attendances allowed for the given AttendanceLimitType

attendance_limit_frequency

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.

attendance_limit_type_id

int64

Id of the Attendance Limit Type. Excpect a UnitOfTime Id. Only applicable if the Membership is Limited

number_of_sessions

int32

The number of sessions allowed for the Membership. Only applicable for Class Packs.

sessions_already_used

int32

The number of sessions already used prior to creating the Membership. Only applicable for Class Packs.

does_membership_expire

string

Determines if the Membership is set to expire. Only applicable to Class Packs.

expiration_type_id

int64

Id of the Membership's Expiration Type. Expects a UnitOfTime Id. Only applicable if the Membership is a Class Pack and is configured to expire.

expiration_length

int32

Lenght of the Expiration for the given Expiration Type. Only applicable if the Membership is a Class Pack and is configured to expire.

is_absorbing_fees

string

Determines if Fees will be absorbed or passed on to the Client. If no value is provided, this will default to True.

payment_plan

object

required

Payment Plan data for a new Membership

discounts

array of objects

Discounts to apply to the new Membership

discounts

locations

object

List of Locations to add to a Membership

programs

object

List of Programs to add to a Membership

allow_rollover

string

When true, can use rollover sessions.

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

Headers

x-api-key

string

required

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

Response

Language

Loading…

Response

Choose an example:

application/json

200Data for the newly created Membership