...
Property | Type | Required | Default | Description |
---|---|---|---|---|
localServiceId | String | Y | Your systems unique id for the club service. | |
memberId | Integer | Y | The Club OS unique id for the member who bought the club service. | |
salespersonId | Integer | N | The Club OS unique id for the salesperson who sold the club service. If blank, the default sales support account will be used. | |
name | String | Y | The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'. | |
startDate | Date (M-d-YYYY) | Y | The effective start date of the club service. | |
endDate | Date (M-d-YYYY) | N | The end date of the club service if one exists. | |
saleDate | Date (M-d-YYYY) | Y | The date of the sale. | |
qty | Decimal | Y | The qty of sessions purchased. | |
unitPrice | Decimal | Y | The unit price (cost of 1 item) of the service. | |
taxes | Decimal | N | The amount of taxes on the payment. | |
autoRenew | Boolean | Y | falsefalse | true - the club service auto-renews. false - the club service does not auto-renew. |
status | Boolean | Y | true | true - the club service is active and in good standing. false - the club service is inactive and not in good standing. |
paidOnSale | Decimal | Y | The amount paid on the saleDate, or the date the club service was purchased. | |
recurType | String | N | monthly | One of 'monthly' or 'weekly'. |
deleted | Boolean | N | false | 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.
...