...
| Variable | Type | Description |
|---|---|---|
| clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
| membershipId | Integer | The Club OS unique id for the membership you are requesting. |
POST /memberships
Add a user membership to the system.
POST http://api.club-os.com/memberships?clubLocationId=[clubLocationId]
...
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| localMembershipId | String | Y | Your systems unique id for the membership. | |
| status | Boolean | Y | 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. | |
| autoRenew | Boolean | Y | true - membership auto-renews. false - membership does not auto-renew. | |
| startDate | Date (M-d-YYYY) | Y | The effective start date of the membership. | |
| endDate | Date (M-d-YYYY) | N | The end date of the membership if one exists. | |
| saleDate | Date (M-d-YYYY) | Y | The date of the sale. | |
| name | String | Y | The name of the membership, i.e. 'Gold', 'Silver', 'Platinum' | |
| downPaymentName | String | N | The name of the down payment, i.e. 'Initiation Fee', or 'First Month Fee' | |
| downPaymentSubtotal | Decimal | N | The amount of the down payment without taxes. | |
| downPaymentTaxes | Decimal | N | The amount of taxes on the down payment. | |
| recurPaymentName | String | N | The name of the recurring payment, i.e. 'Membership Dues'. | |
| recurPaymentSubtotal | Decimal | N | The amount of the recurring payment without taxes. | |
| recurPaymentTaxes | Decimal | N | The amount of taxes on the recurring payment. |
PUT /
...
memberships
Update a users account typemembership's status.
POST http://api.club-os.com/users?clubLocationId=[clubLocationId]
...
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| userIdmembershipId | Integer | Y | The Club OS unique id for the member to update | |
| fullAccountstatus | Boolean | Y | false | Club OS has 2 types of member accounts, Full and Basic. Full means they get access to both nutrition and/or workout features based on the club's service plantrue - the membership is active and the customer is caught up on payments. false - Make the member a Basic account.true - Make the member full accountthe membership is inactive due to deliquent billing, membership cancellation, etc. |