Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership Template Program

Add accessible programs to a Membership Template

Add accessible programs to a Membership Template.

post/memberships/templates/{membership_template_id}/programs

Path parameters

membership_template_idinteger required

Membership Template Id

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

program_idsinteger[]

List of Program Id's to add to the Membership

Example request

{
  "program_ids": [
    1234567891234567
  ]
}

Response

Membership Template Data

idinteger

Membership Template Id

namestring

Membership Name

descriptionstring

Membership Description

membership_type_idinteger

Membership Type Id

membership_typestring

Membership Type

attendance_type_idinteger

Attendance Type Id

attendance_typestring

Attendance Type

attendance_limitinteger

Attendance Limit

attendance_limit_frequencyinteger

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

attendance_limit_type_idinteger

Attendance Limit Type Id

attendance_limit_typestring

Attendance Limit Type

number_of_sessionsinteger

The number of sessions for the membership

does_membership_expireboolean

Determines if the membership expires. Only applicable to Class Packs

expiration_type_idinteger

Expiration Type Id

expiration_typestring

Expiration Type

expiration_lengthinteger

Expiration Length

revenue_category_idinteger

Revenue Category Id

revenue_categorystring

Revenue Category

membership_contract_template_idinteger

Membership Contract Template Id

contract_namestring

Name of the Contract Template on the Membership Template

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.

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 response

{
  "id": 1234567891234567,
  "membership_type_id": 1234567891234567,
  "attendance_type_id": 1234567891234567,
  "attendance_limit_type_id": 1234567891234567,
  "expiration_type_id": 1234567891234567,
  "revenue_category_id": 1234567891234567,
  "membership_contract_template_id": 1234567891234567,
  "service_id": 1234567891234567,
  "service_duration_id": 1234567891234567,
  "payment_plan_templates": [
    {
      "id": 1234567891234567,
      "initial_payment_interval_time_unit_id": 1234567891234567,
      "initial_commitment_time_unit_id": 1234567891234567,
      "monthly_initial_payment_option_template": {
        "monthly_initial_payment_option_template_id": 1234567891234567,
        "monthly_initial_payment_option_template_type_id": 1234567891234567,
        "monthly_initial_payment_option_template_setup_fee": 0.1,
        "monthly_initial_payment_option_template_cost": 0.1
      },
      "pay_in_full_initial_payment_option_template": {
        "pay_in_full_initial_payment_option_template_id": 1234567891234567,
        "pay_in_full_initial_payment_option_template_type_id": 1234567891234567,
        "pay_in_full_initial_payment_option_template_setup_fee": 0.1,
        "pay_in_full_initial_payment_option_template_cost": 0.1
      },
      "renewal_payment_interval_time_unit_id": 1234567891234567,
      "renewal_commitment_time_unit_id": 1234567891234567,
      "monthly_renewal_payment_option_template": {
        "monthly_renewal_payment_option_template_id": 1234567891234567,
        "monthly_renewal_payment_option_template_type_id": 1234567891234567,
        "monthly_renewal_payment_option_template_cost": 0.1
      },
      "pay_in_full_renewal_payment_option_template": {
        "pay_in_full_renewal_payment_option_template_id": 1234567891234567,
        "pay_in_full_renewal_payment_option_template_type_id": 1234567891234567,
        "pay_in_full_renewal_payment_option_template_cost": 0.1
      },
      "payment_plan_template_location_tax_rates": [
        {
          "location_id": 1234567891234567,
          "tax_rate_id": 1234567891234567,
          "tax_rate": 0.1,
          "tax_rate_type_id": 1234567891234567
        }
      ],
      "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"
      }
    }
  ],
  "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"
  }
}