v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Membership

Create Membership

Create a new Membership for a Client.

post/memberships

Headers

x-api-keystring required

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

Request body

client_idinteger required

Id of the Client that the Membership is being created for

membership_template_idinteger required

Id of the Template that the Membership will be created from

location_of_sale_idinteger

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

start_datestring date

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

attendance_type_idinteger

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

attendance_limitinteger

The number of attendances allowed for the given AttendanceLimitType

attendance_limit_frequencyinteger

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_idinteger

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

number_of_sessionsinteger

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

sessions_already_usedinteger

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

does_membership_expirestring

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

expiration_type_idinteger

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_lengthinteger

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_feesstring

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

allow_rolloverstring

When true, can use rollover sessions.

max_total_sessionsinteger

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.

Example request

{
  "client_id": 1234567891234567,
  "membership_template_id": 1234567891234567,
  "location_of_sale_id": 1234567891234567,
  "start_date": "2014-12-31",
  "attendance_type_id": 1234567891234567,
  "attendance_limit_type_id": 1234567891234567,
  "expiration_type_id": 1234567891234567,
  "payment_plan": {
    "payment_plan_template_id": 1234567891234567,
    "initial_payment_option_template_id": 1234567891234567,
    "initial_cost": 0.1,
    "initial_setup_fee": 0.1,
    "renewal_payment_option_template_id": 1234567891234567,
    "renewal_cost": 0.1
  },
  "discounts": [
    {
      "discount_id": 1234567891234567
    }
  ],
  "locations": {
    "location_ids": [
      1234567891234567
    ]
  },
  "programs": {
    "program_ids": [
      1234567891234567
    ]
  }
}

Response

Data for the newly created Membership

idinteger required

Identifies the Membership

client_idinteger required

Id of the Client that the Membership is for

namestring

Name of the Membership

membership_template_idinteger required

The Id of the Template used for this Membership

renewed_from_membership_idinteger

The Id of the Membership that this Membership was renewed from

has_been_renewedboolean

Determines if the Membership has been renewed

location_of_sale_idinteger

Id of the Location that the Membership was sold from

location_of_salestring

Name of the Location that the Membership was sold from

start_datestring date

The Membership start date

end_datestring date

Date that the Membership ends

membership_type_idinteger

Id of the Membership Type

membership_typestring

Name of the Membership Type

attendance_type_idinteger

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

attendance_typestring

Name of the Attendance Type

attendance_limit integer

Attendance Limit

attendance_limit_frequencyinteger

The frequency/number of days that the class attendance limit applies to.

attendance_limit_type_idinteger

Id of the Attendance Limit Type

attendance_limit_typestring

Name of the Attendance Limit Type

number_of_sessionsinteger

Number of sessions. Only applicable to Class and Appointment Pack's

sessions_already_usedinteger

Number of sessions already used for the Membership

does_membership_expireboolean

Determines if the Membership expires. Only appliable to Class and Appointment Packs

expiration_type_idinteger

Id of the Expiration Type

expiration_typestring

Name of the Expiration Type

expiration_lengthinteger

The Membership Expiration Length

expiration_datestring date

The Membership Expiration Date

original_expiration_datestring date

Date on which the Membership originally expired.

revenue_category_idinteger

Id of the Revenue Category for the sale of this Membership

revenue_categorystring

Name of the Revenue Category

membership_contract_template_idinteger

Id of the Contract Template for the Membership

contract_namestring

Name of the Contract for the Membership

contract_signed_on_datestring date-time

Date on which the Contract was signed

tax_rate_idinteger

Id of the Tax Rate that was applied to the Membership

tax_rate_namestring

Name of the Tax Rate

tax_ratenumber

Rate of tax

is_absorbing_feesboolean

Determines if processing fees are absorbed or passed on to the Client

service_idinteger

The Service Id of the Membership for Appointment Packs

servicestring

The Service of the Membership for Appointment Packs

service_duration_idinteger

Id of the Duration for the Service on an Appointment Pack Membership

service_duration_hoursinteger

The hours of the Service duration for Appointment Pack Memberships

service_duration_minutesinteger

The minutes of the Service duration for Appointment Pack Memberships

allow_rolloverboolean

When true, can use rollover sessions.

rollover_sessionsinteger

The count of sessions rolled over from previous membership/limited period. Only applies to limited plan memberships.

max_total_sessionsinteger

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.

has_scheduled_deactivationboolean

Indicates if the membership has a scheduled date to be deactivated

scheduled_deactivation_datestring date

Date on which a membership has been scheduled to deactivate

is_activeboolean required

Indicates if the Membership is active

is_deletedboolean

Indicates if the Membership was deleted

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

Example response

{
  "id": 1234567891234567,
  "client_id": 1234567891234567,
  "membership_template_id": 1234567891234567,
  "renewed_from_membership_id": 1234567891234567,
  "location_of_sale_id": 1234567891234567,
  "start_date": "2014-12-31",
  "end_date": "2014-12-31",
  "attendance_limit_type_id": 1234567891234567,
  "expiration_type_id": 1234567891234567,
  "expiration_date": "2014-12-31",
  "original_expiration_date": "2014-12-31",
  "revenue_category_id": 1234567891234567,
  "contract_signed_on_date": "2014-12-31T23:59:59.938Z",
  "tax_rate_id": 1234567891234567,
  "tax_rate": 0.1,
  "service_id": 1234567891234567,
  "service_duration_id": 1234567891234567,
  "payment_plan": {
    "auto_renew_stop_date": "2014-12-31",
    "initial_payment_option": {
      "payment_option_template_id": 1234567891234567,
      "payment_option_type_id": 1234567891234567,
      "cost": 0.1,
      "setup_fee": 0.1,
      "administrative_fee": 0.1,
      "tax": 0.1,
      "total_discount": 0.1,
      "total": 0.1
    },
    "renewal_payment_option": {
      "payment_option_template_id": 1234567891234567,
      "payment_option_type_id": 1234567891234567,
      "cost": 0.1,
      "setup_fee": 0.1,
      "administrative_fee": 0.1,
      "tax": 0.1,
      "total_discount": 0.1,
      "total": 0.1
    }
  },
  "membership_discounts": [
    {
      "id": 1234567891234567,
      "discount_id": 1234567891234567,
      "discount_type_id": 1234567891234567,
      "discount_percentage": 0.1,
      "discount_flat_amount": 0.1
    }
  ],
  "membership_holds": [
    {
      "id": 1234567891234567,
      "start_date": "2014-12-31",
      "end_date": "2014-12-31"
    }
  ],
  "scheduled_deactivation_date": "2014-12-31",
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}