Versions Compared

Key

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

...

PropertyTypeRequiredDefaultDescription
membershipIdIntegerY The Club OS unique id for the membership to update.
salespersonIdIntegerY The Club OS unique id for the salesperson who sold 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 lead and the membership status is true,

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

templateUsernameStringN 

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

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

sendEmailBooleanNfalse

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

this will send a welcome email to the lead account.

...