Versions Compared

Key

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

...

PropertyTypeRequiredDefaultDescription
localServiceIdStringY Your systems unique id for the club service.
memberIdIntegerY The Club OS unique id for the member who bought the club service.
salespersonIdIntegerN The Club OS unique id for the salesperson who sold the club service. If blank, the default sales support account will be used.
nameStringY The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'.
startDateDate (M-d-YYYY)Y The effective start date of the club service.
endDateDate (M-d-YYYY)N The end date of the club service if one exists.
saleDateDate (M-d-YYYY)Y The date of the sale.
qtyDecimalY The qty of sessions purchased.
unitPriceDecimalY The unit price (cost of 1 item) of the service.
taxesDecimalN The amount of taxes on the payment.
autoRenewBooleanY falsefalse

true - the club service auto-renews.

false - the club service does not auto-renew.

statusBooleanYtrue

true - the club service is active and in good standing.

false - the club service is inactive and not in good standing.

paidOnSaleDecimalY The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.
deletedBooleanNfalse

true - the club service is deleted

false - the club service is non-deleted and active

Response Messages

One of the following messages will be returned when the request succeeds.

...