Appointment, bookable appointment and slots operations
Magicline Open API
/API reference
/- Purchase an additional module contract
Get customer's contract data
Create contract cancelation amendment
Get studio's contract cancelation reason data
withdraw cancelation of contract
Get the idle period configuration of the contract
Validate an idle period request
Get the idle periods of the contract
Create a contract idle period amendment
Get contract idle period by id
Update a contract idle period
Withdraw a contract idle period
Get additional modules
Get purchasable additional modules
Validate an additional module contract request
Get an additional module contract
Create additional module contract cancelation amendment
withdraw cancelation of the additional module contract
Get contract's remaining idle periods
Get preview of an updated idle period charges and fees
Purchase an additional mo...
Magicline API (1.18.0)
- Appointment, bookable appointment and slots operations
- Redeem checkin vouchers
- Class and slots operations
- Cross studio operations
- Get customers and contracts
- Retrieve customer accounting details
- Retrieve customer communication details
- Retrieve customer transaction details
- Get device information
- Employee operations
- Debt collection operations
- Leads operations
- Get member lists
- Manage membership contracts
- Membership operations
- Online offer operations
- Payment operations
- Get studio information
- Get trial offers information
Download OpenAPI description
Languages
Servers
Demo tenant
https://open-api-demo.open-api.magicline.com/
Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/
Bodyapplication/jsonrequired
Unique ID of the payment frequency of the additional module
Example: 203
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-modules/validate
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/additional-modules/validate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-modules/validate' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"additionalModuleId": 203,
"paymentFrequencyId": 203,
"bookTrialPeriod": true
}'OK
Status of the addtional module validation
| Enum Value | Description |
|---|---|
| ADDITIONAL_MODULE_NOT_FOUND | The additional module could not be found. |
| ADDITIONAL_MODULE_CONTRACT_INVALID_STATUS, | The additional module contract is in an invalid status. |
| ADDITIONAL_MODULE_NOT_ONLINE_PURCHASABLE | The additional module is not purchasable online. |
| ADDITIONAL_MODULE_CONTRACT_ALREADY_PURCHASED | The additional module contract has already been purchased. |
| ADDITIONAL_MODULE_PURCHASABLE | The additional module is purchasable. |
| ADDITIONAL_MODULE_TRIAL_PERIOD_NOT_BOOKABLE | The additional module trial period cannot be booked. |
Example: "ADDITIONAL_MODULE_CONTRACT_ALREADY_PURCHASED"
Response
application/json
{ "validationStatus": "ADDITIONAL_MODULE_CONTRACT_ALREADY_PURCHASED" }
Bodyapplication/jsonrequired
Unique ID of the payment frequency of the additional module
Example: 203
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-modules/purchase
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/additional-modules/purchase
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-modules/purchase' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"additionalModuleId": 203,
"paymentFrequencyId": 203,
"bookTrialPeriod": true
}'Response
application/json
{ "id": 1001 }
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-module-contracts/{additionalModuleContractId}
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/additional-module-contracts/{additionalModuleContractId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/additional-module-contracts/{additionalModuleContractId}' \
-H 'X-API-KEY: YOUR_API_KEY_HERE'OK
Represents a financial data
Last possible cancelation date of the additional module contract
Example: "2022-01-15"
Cancelation status of the contract cancelation
| Enum Value | Description |
|---|---|
| PENDING_WITHDRAWAL_VERIFICATION | The cancelation withdrawal is pending verification. |
| CANCELED | The contract was canceled by the customer. |
| PENDING_VERIFICATION | The cancelation is pending verification. |
Example: "PENDING_VERIFICATION"
Whether a contract cancelation for the additional module contract can be withdrawn
Example: true
Represents the trial period of an additional module
Response
application/json
{ "name": "drink flat", "price": { "amount": 20, "currency": "EUR" }, "startDate": "2022-01-15", "endDate": "2022-01-15", "cancelationDate": "2022-01-15", "lastPossibleCancelationDate": "2022-01-15", "cancelationReason": "Illness", "contractCancelationStatus": "PENDING_VERIFICATION", "contractCancelationCanBeWithdrawn": true, "trialPeriod": { "term": { … }, "startDate": "2022-01-15" }, "rateCodes": [ { … } ], "availableCancelationDates": [ "2019-08-24" ] }