Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET https://api.club-os.com/memberships?clubLocationId=[clubLocationId]&membershipId=[membershipId]

Parameters

The following fields must be included as parameters in the URL of the request.

VariableTypeDescription
clubLocationIdIntegerThe Club OS unique id for the club location you wish to access. Club OS will provide these to you.
membershipIdIntegerThe Club OS unique id for the membership you are requesting.

 

POST /memberships

Add a membership to the system.

Note:  If the membership is being added belongs to a Club OS prospect lead account and the status is true, then the prospect lead will be converted to a member and some additional fields will apply (see below)on a successful request.

POST https://api.club-os.com/memberships?clubLocationId=[clubLocationId]

...

Parameters

The following fields must be included as parameters in the body URL of the HTTP request as a valid JSON string.If the memberId is for a Club OS prospect and the agreement status is true,this is the Club OS unique id for the trainer who will be assigned to the prospectrequest.

VariableTypeDescription
clubLocationIdIntegerThe Club OS unique id for the club location you wish to access. Club OS will provide these to you.
Request Body

The following fields must be included in the body of the HTTP request as a valid JSON string.

PropertyTypeRequiredDefaultDescription
memberIdIntegerY The Club OS unique id for the member who bought the membership.
salespersonIdIntegerY The Club OS unique id for the salesperson who sold the membership.
localMembershipIdStringY Your systems unique id for the membership.
statusBooleanYfalse

true - the membership is active and the customer is caught up on payments.

false - the membership is inactive due to deliquent billing, membership cancellation, etc.

autoRenewBooleanYfalse

true - membership auto-renews.

false - membership does not auto-renew.

startDateDate (M-d-YYYY)Y The effective start date of the membership.
endDateDate (M-d-YYYY)N The end date of the membership if one exists.
saleDateDate (M-d-YYYY)Y The date of the sale.
nameStringY The name of the membership, i.e. 'Gold', 'Silver', 'Platinum'
paidOnSaleDecimalY The amount paid on the saleDate, or the date the membership was purchased.
downPaymentNameStringN The name of the down payment, i.e. 'Initiation Fee', or 'First Month Fee'
downPaymentSubtotalDecimalN The amount of the down payment without taxes.
downPaymentTaxesDecimalN 

The amount of taxes on the down payment.

recurPaymentNameStringN The name of the recurring payment, i.e. 'Membership Dues'.
recurPaymentSubtotalDecimalN The amount of the recurring payment without taxes.
recurPaymentTaxesDecimalN The amount of taxes on the recurring payment.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.
trainerIdIntegerN 

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this is the Club OS unique id for the trainer who will be assigned to the prospect lead account.

templateUsernameStringN 

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this is the username of a Club OS template to be applied to the prospect lead account.

sendEmailBooleanNfalse

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this will send a welcome email to the prospect lead account.

Response Messages

...

Update a membership in the system.  If   

Note:  If the membership is being added belongs to a Club OS prospect lead account and the status is true, then the prospect lead will be converted to a member and some additional fields will apply (see below)on a successful request.

PUT https://api.club-os.com/memberships?clubLocationId=[clubLocationId]

Parameters

The following fields must be included as parameters in the URL of the request.

VariableTypeDescription
clubLocationIdIntegerThe Club OS unique id for the club location you wish to access. Club OS will provide these to you.
Request Body

The following fields must be included in the body of the HTTP request as a valid JSON string.

PropertyTypeRequiredDefaultDescription
membershipIdIntegerY The Club OS unique id for the membership to update.
statusBooleanYfalse

true - the membership is active and the customer is caught up on payments.

false - the membership is inactive due to deliquent billing, membership cancellation, etc.

autoRenewBooleanYfalse

true - membership auto-renews.

false - membership does not auto-renew.

startDateDate (M-d-YYYY)Y The effective start date of the membership.
endDateDate (M-d-YYYY)N The end date of the membership if one exists.
saleDateDate (M-d-YYYY)Y The date of the sale.
nameStringY The name of the membership, i.e. 'Gold', 'Silver', 'Platinum'
paidOnSaleDecimalY The amount paid on the saleDate, or the date the membership was purchased.
downPaymentNameStringN The name of the down payment, i.e. 'Initiation Fee', or 'First Month Fee'
downPaymentSubtotalDecimalN The amount of the down payment without taxes.
downPaymentTaxesDecimalN 

The amount of taxes on the down payment.

recurPaymentNameStringN The name of the recurring payment, i.e. 'Membership Dues'.
recurPaymentSubtotalDecimalN The amount of the recurring payment without taxes.
recurPaymentTaxesDecimalN The amount of taxes on the recurring payment.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.
trainerIdIntegerN 

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this is the Club OS unique id for the trainer who will be assigned to the prospect lead account.

templateUsernameStringN 

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this is the username of a Club OS template to be applied to the prospect lead account.

sendEmailBooleanNfalse

If the memberId is for a Club OS prospect lead and the agreement membership status is true,

this will send a welcome email to the prospect lead account.

Response Messages

...