POST public/Plan/GetPlanSubscriptions
Request Information
URI Parameters
None.
Body Parameters
Plan| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanId | integer |
None. |
|
| Code | string |
None. |
|
| Description | string |
None. |
|
| ProductId | integer |
None. |
|
| SortOrder | integer |
None. |
|
| IsActive | boolean |
None. |
|
| MonthlyPrice | decimal number |
None. |
|
| YearlyPrice | decimal number |
None. |
|
| MonthlyAvailable | boolean |
None. |
|
| YearlyAvailable | boolean |
None. |
|
| YearlyPriceFor2Years | decimal number |
None. |
|
| MonthlyPriceFor2Years | decimal number |
None. |
|
| YearlyPriceFor3Years | decimal number |
None. |
|
| MonthlyPriceFor3Years | decimal number |
None. |
|
| ContactLimit | integer |
None. |
|
| ContactsOffered | integer |
None. |
|
| Recommended | boolean |
None. |
|
| ProductCode | string |
None. |
|
| MonthlyPromotionCode | string |
None. |
|
| YearlyPromotionCode | string |
None. |
|
| ProductFamilyId | integer |
None. |
|
| ProductFamilyName | string |
None. |
|
| ProductFamilyLogo | string |
None. |
|
| ProductFamilyLogoLarge | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PlanId": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"ProductId": 4,
"SortOrder": 5,
"IsActive": true,
"MonthlyPrice": 1.0,
"YearlyPrice": 1.0,
"MonthlyAvailable": true,
"YearlyAvailable": true,
"YearlyPriceFor2Years": 1.0,
"MonthlyPriceFor2Years": 1.0,
"YearlyPriceFor3Years": 1.0,
"MonthlyPriceFor3Years": 1.0,
"ContactLimit": 9,
"ContactsOffered": 10,
"Recommended": true,
"ProductCode": "sample string 12",
"MonthlyPromotionCode": "sample string 13",
"YearlyPromotionCode": "sample string 14",
"ProductFamilyId": 15,
"ProductFamilyName": "sample string 16",
"ProductFamilyLogo": "sample string 17",
"ProductFamilyLogoLarge": "sample string 18"
}
application/xml, text/xml
Sample:
<Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Account.DTO.Library.Financial.Plan"> <Code>sample string 2</Code> <ContactLimit>9</ContactLimit> <ContactsOffered>10</ContactsOffered> <Description>sample string 3</Description> <IsActive>true</IsActive> <MonthlyAvailable>true</MonthlyAvailable> <MonthlyPrice>1</MonthlyPrice> <MonthlyPriceFor2Years>1</MonthlyPriceFor2Years> <MonthlyPriceFor3Years>1</MonthlyPriceFor3Years> <MonthlyPromotionCode>sample string 13</MonthlyPromotionCode> <PlanId>1</PlanId> <ProductCode>sample string 12</ProductCode> <ProductFamilyId>15</ProductFamilyId> <ProductFamilyLogo>sample string 17</ProductFamilyLogo> <ProductFamilyLogoLarge>sample string 18</ProductFamilyLogoLarge> <ProductFamilyName>sample string 16</ProductFamilyName> <ProductId>4</ProductId> <Recommended>true</Recommended> <SortOrder>5</SortOrder> <YearlyAvailable>true</YearlyAvailable> <YearlyPrice>1</YearlyPrice> <YearlyPriceFor2Years>1</YearlyPriceFor2Years> <YearlyPriceFor3Years>1</YearlyPriceFor3Years> <YearlyPromotionCode>sample string 14</YearlyPromotionCode> </Plan>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ITypedResponseOfListOfPlanSubscription| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of PlanSubscription |
None. |
|
| Category | string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.