Deprecated - API v1 will be switched off on 01.07.2022. Please upgrade to API v2
Payment plan details
Payment plan details is detaild representation of single payment plan in your company.
Payment plan details properties
Payment plan holds the same data as Payment plan plus some detailed attributes of a payment plan. Only payment plan details specyfic properties are described here.
| Name | Type | Description |
|---|---|---|
startDate |
string |
Payment plan start date. |
endDate |
string |
Payment plan end date. |
minimumAge |
int |
Minimum age for club member to be able to purchase selected payment plan. |
freezeAllowed |
bool |
true if membership with a given payment plan can be freezed, false otherwise. |
paymentOnStartDate |
bool |
true if first payment must be executed on paymentplan startDate, false otherwise. |
displayName |
string |
Payment plan display name. |
shortDescription |
string |
Payment plan short description. |
description |
string |
Payment plan description. |
commitmentPeriod |
string |
Minimum commitment period represented as {value}{unit}. Possible unit values :
Example:
|
fees |
Fees | Contract fees. |
paymentInterval |
string |
Payment interval represented as {value}{unit}. Possible unit values :
Example:
|
membership |
Membership | Payment plan membership. |
channels |
array |
An array of string objects, each representing a channel given payment plan is available in. Possible values :
|
addOns |
array |
An array of Add on objects, each representing a payment plan add on. If isAddOnPaymentPlan == false an array is empty. |
regulationFiles |
array |
An array of File objects |
Retrive detailed information about specyfic payment plan 
GET PaymentPlans/PaymentPlan
Returns detailed payment plan information.
Parameters
| Name | Type | Description |
|---|---|---|
paymentPlanId |
long |
Required. Payment plan identifier. |
languageCode |
string |
Language identifier payment plan display name, short description and description should be translated to (for example EN, DE etc.).. |
Example request
In this example we fetch payment plan with id = 44 detailed information.
curl -i
-X GET
-H "Authorization: Bearer $ACCESS_TOKEN"
http://yoursubdomain.perfectgym.com/Api/PaymentPlans/PaymentPlan
?paymentPlanId=40
Example response
Status: 200 OK
{
"elements": [
{
"startDate": "2015-01-01T00:00:00",
"endDate": "2016-12-31T00:00:00",
"freezeAllowed": true,
"paymentOnStartDate": false,
"displayName": "Open 24 months",
"shortDescription": "",
"description": "",
"commitmentPeriod": "24M",
"fees": {
"joiningFee": {
"net": 0,
"tax": 0,
"taxRate": 23,
"gross": 0
},
"administartionFee": {
"net": 15.45,
"tax": 3.55,
"taxRate": 23,
"gross": 19
},
"membershipFee": {
"net": 16.18,
"tax": 3.72,
"taxRate": 23,
"gross": 19.9
},
"freezFee": {
"net": 0,
"tax": 0,
"taxRate": 23,
"gross": 0
}
},
"paymentInterval": "1M",
"membership": {
"id": 20,
"timestamp": 280599,
"name": "High5 Full",
"isActive": true,
"isDeleted": false
},
"id": 44,
"timestamp": 447623,
"name": "Open 24m",
"isActive": true,
"isDeleted": false,
"regulationFiles": [
{
"id": 101,
"name": "file.pdf"
}
]
}
]
}
