POST api/me/subscriptions

This method should be used to subscribe user to one of the supported product plans

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

Instance of

CreateSubscriptionBindingModel
NameDescriptionTypeAdditional information
PlanId

integer

Required
CardId

string

Required
Quantity

integer

Required
Coupon

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "planId": 1,
  "cardId": "sample string 2",
  "quantity": 3,
  "coupon": "sample string 4"
}

text/html

Sample: 
{"planId":1,"cardId":"sample string 2","quantity":3,"coupon":"sample string 4"}

application/xml, text/xml

Sample: 
<CreateSubscriptionBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.SubscriptionBinding">
  <CardId>sample string 2</CardId>
  <Coupon>sample string 4</Coupon>
  <PlanId>1</PlanId>
  <Quantity>3</Quantity>
</CreateSubscriptionBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateSubscriptionBindingModel'.

Response Information

Resource Description

Instance of

SubscriptionModel
NameDescriptionTypeAdditional information
Id

integer

None.
StripeSubscriptionId

string

None.
SubscriptionStatusId

integer

None.
Status

string

None.
UserId

integer

None.
SubscriberFirstName

string

None.
SubscriberLastName

string

None.
SubscriberEmail

string

None.
StripeCustomerId

string

None.
ProductBundlePlanId

integer

None.
PlanName

string

None.
PlanPrice

decimal number

None.
StripeCouponId

string

None.
DiscountPercent

decimal number

None.
TaxRate

decimal number

None.
PricePerAdditionalAppeal

decimal number

None.
BillingCycleAnchor

date

None.
StartDate

date

None.
EndedAt

date

None.
TrialDurationInDays

integer

None.
TrialStart

date

None.
TrialEnd

date

None.
Quantity

integer

None.
LiveMode

boolean

None.
MaxAppealCount

integer

None.
MaxPropertyCount

integer

None.
MaxExemptionCount

integer

None.
MaxCountyCount

integer

None.
AppealSRolloverSupport

boolean

None.
AdvertisementSupport

boolean

None.
AffiliateMarketingSupport

boolean

None.
ApiAccessSupport

boolean

None.
CustomPropertySearchToolSupport

boolean

None.
AutoDocGenerationSupport

boolean

None.
WhiteLabelingSupport

boolean

None.
MultiPropertyComparisonSupport

boolean

None.
LackOfUniformityReportSupport

boolean

None.
OvervaluationReportSupport

boolean

None.
FullPropertyProfileReportSupport

boolean

None.
MultiPropertyComparisonReportSupport

boolean

None.
PropertyTaxGuideReportSupport

boolean

None.
SellerTaxAnalysisReportSupport

boolean

None.
BuyerTaxAnalysisReportSupport

boolean

None.
EmbeddingSupport

boolean

None.
BatchImportSupport

boolean

None.
LeadGenerationSupport

boolean

None.
CsvExport

boolean

None.
CancelationReason

string

None.
CreatedDate

date

None.
LastModifiedDate

date

None.
CancelationDate

date

None.
SubscriptionNumber

string

None.
StripePlanId

string

None.
AppealManagementSupport

boolean

None.
ClientBillingSupport

boolean

None.
AllowCondoAnalysis

boolean

None.
AllowProspecting

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "stripeSubscriptionId": "sample string 2",
  "subscriptionStatusId": 3,
  "status": "sample string 4",
  "userId": 5,
  "subscriberFirstName": "sample string 6",
  "subscriberLastName": "sample string 7",
  "subscriberEmail": "sample string 8",
  "stripeCustomerId": "sample string 9",
  "productBundlePlanId": 10,
  "planName": "sample string 11",
  "planPrice": 12.0,
  "stripeCouponId": "sample string 13",
  "discountPercent": 14.0,
  "taxRate": 15.0,
  "pricePerAdditionalAppeal": 16.0,
  "billingCycleAnchor": "2025-11-01T05:55:58.2058373-05:00",
  "startDate": "2025-11-01T05:55:58.2058373-05:00",
  "endedAt": "2025-11-01T05:55:58.2058373-05:00",
  "trialDurationInDays": 18,
  "trialStart": "2025-11-01T05:55:58.2058373-05:00",
  "trialEnd": "2025-11-01T05:55:58.2058373-05:00",
  "quantity": 19,
  "liveMode": true,
  "maxAppealCount": 21,
  "maxPropertyCount": 22,
  "maxExemptionCount": 23,
  "maxCountyCount": 24,
  "appealSRolloverSupport": true,
  "advertisementSupport": true,
  "affiliateMarketingSupport": true,
  "apiAccessSupport": true,
  "customPropertySearchToolSupport": true,
  "autoDocGenerationSupport": true,
  "whiteLabelingSupport": true,
  "multiPropertyComparisonSupport": true,
  "lackOfUniformityReportSupport": true,
  "overvaluationReportSupport": true,
  "fullPropertyProfileReportSupport": true,
  "multiPropertyComparisonReportSupport": true,
  "propertyTaxGuideReportSupport": true,
  "sellerTaxAnalysisReportSupport": true,
  "buyerTaxAnalysisReportSupport": true,
  "embeddingSupport": true,
  "batchImportSupport": true,
  "leadGenerationSupport": true,
  "csvExport": true,
  "cancelationReason": "sample string 44",
  "createdDate": "2025-11-01T05:55:58.2058373-05:00",
  "lastModifiedDate": "2025-11-01T05:55:58.2058373-05:00",
  "cancelationDate": "2025-11-01T05:55:58.2058373-05:00",
  "subscriptionNumber": "sample string 46",
  "stripePlanId": "sample string 47",
  "appealManagementSupport": true,
  "clientBillingSupport": true,
  "allowCondoAnalysis": true,
  "allowProspecting": true
}

text/html

Sample: 
{"id":1,"stripeSubscriptionId":"sample string 2","subscriptionStatusId":3,"status":"sample string 4","userId":5,"subscriberFirstName":"sample string 6","subscriberLastName":"sample string 7","subscriberEmail":"sample string 8","stripeCustomerId":"sample string 9","productBundlePlanId":10,"planName":"sample string 11","planPrice":12.0,"stripeCouponId":"sample string 13","discountPercent":14.0,"taxRate":15.0,"pricePerAdditionalAppeal":16.0,"billingCycleAnchor":"2025-11-01T05:55:58.2058373-05:00","startDate":"2025-11-01T05:55:58.2058373-05:00","endedAt":"2025-11-01T05:55:58.2058373-05:00","trialDurationInDays":18,"trialStart":"2025-11-01T05:55:58.2058373-05:00","trialEnd":"2025-11-01T05:55:58.2058373-05:00","quantity":19,"liveMode":true,"maxAppealCount":21,"maxPropertyCount":22,"maxExemptionCount":23,"maxCountyCount":24,"appealSRolloverSupport":true,"advertisementSupport":true,"affiliateMarketingSupport":true,"apiAccessSupport":true,"customPropertySearchToolSupport":true,"autoDocGenerationSupport":true,"whiteLabelingSupport":true,"multiPropertyComparisonSupport":true,"lackOfUniformityReportSupport":true,"overvaluationReportSupport":true,"fullPropertyProfileReportSupport":true,"multiPropertyComparisonReportSupport":true,"propertyTaxGuideReportSupport":true,"sellerTaxAnalysisReportSupport":true,"buyerTaxAnalysisReportSupport":true,"embeddingSupport":true,"batchImportSupport":true,"leadGenerationSupport":true,"csvExport":true,"cancelationReason":"sample string 44","createdDate":"2025-11-01T05:55:58.2058373-05:00","lastModifiedDate":"2025-11-01T05:55:58.2058373-05:00","cancelationDate":"2025-11-01T05:55:58.2058373-05:00","subscriptionNumber":"sample string 46","stripePlanId":"sample string 47","appealManagementSupport":true,"clientBillingSupport":true,"allowCondoAnalysis":true,"allowProspecting":true}

application/xml, text/xml

Sample: 
<SubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <AdvertisementSupport>true</AdvertisementSupport>
  <AffiliateMarketingSupport>true</AffiliateMarketingSupport>
  <AllowCondoAnalysis>true</AllowCondoAnalysis>
  <AllowProspecting>true</AllowProspecting>
  <ApiAccessSupport>true</ApiAccessSupport>
  <AppealManagementSupport>true</AppealManagementSupport>
  <AppealSRolloverSupport>true</AppealSRolloverSupport>
  <AutoDocGenerationSupport>true</AutoDocGenerationSupport>
  <BatchImportSupport>true</BatchImportSupport>
  <BillingCycleAnchor>2025-11-01T05:55:58.2058373-05:00</BillingCycleAnchor>
  <BuyerTaxAnalysisReportSupport>true</BuyerTaxAnalysisReportSupport>
  <CancelationDate>2025-11-01T05:55:58.2058373-05:00</CancelationDate>
  <CancelationReason>sample string 44</CancelationReason>
  <ClientBillingSupport>true</ClientBillingSupport>
  <CreatedDate>2025-11-01T05:55:58.2058373-05:00</CreatedDate>
  <CsvExport>true</CsvExport>
  <CustomPropertySearchToolSupport>true</CustomPropertySearchToolSupport>
  <DiscountPercent>14</DiscountPercent>
  <EmbeddingSupport>true</EmbeddingSupport>
  <EndedAt>2025-11-01T05:55:58.2058373-05:00</EndedAt>
  <FullPropertyProfileReportSupport>true</FullPropertyProfileReportSupport>
  <Id>1</Id>
  <LackOfUniformityReportSupport>true</LackOfUniformityReportSupport>
  <LastModifiedDate>2025-11-01T05:55:58.2058373-05:00</LastModifiedDate>
  <LeadGenerationSupport>true</LeadGenerationSupport>
  <LiveMode>true</LiveMode>
  <MaxAppealCount>21</MaxAppealCount>
  <MaxCountyCount>24</MaxCountyCount>
  <MaxExemptionCount>23</MaxExemptionCount>
  <MaxPropertyCount>22</MaxPropertyCount>
  <MultiPropertyComparisonReportSupport>true</MultiPropertyComparisonReportSupport>
  <MultiPropertyComparisonSupport>true</MultiPropertyComparisonSupport>
  <OvervaluationReportSupport>true</OvervaluationReportSupport>
  <PlanName>sample string 11</PlanName>
  <PlanPrice>12</PlanPrice>
  <PricePerAdditionalAppeal>16</PricePerAdditionalAppeal>
  <ProductBundlePlanId>10</ProductBundlePlanId>
  <PropertyTaxGuideReportSupport>true</PropertyTaxGuideReportSupport>
  <Quantity>19</Quantity>
  <SellerTaxAnalysisReportSupport>true</SellerTaxAnalysisReportSupport>
  <StartDate>2025-11-01T05:55:58.2058373-05:00</StartDate>
  <Status>sample string 4</Status>
  <StripeCouponId>sample string 13</StripeCouponId>
  <StripeCustomerId>sample string 9</StripeCustomerId>
  <StripePlanId>sample string 47</StripePlanId>
  <StripeSubscriptionId>sample string 2</StripeSubscriptionId>
  <SubscriberEmail>sample string 8</SubscriberEmail>
  <SubscriberFirstName>sample string 6</SubscriberFirstName>
  <SubscriberLastName>sample string 7</SubscriberLastName>
  <SubscriptionNumber>sample string 46</SubscriptionNumber>
  <SubscriptionStatusId>3</SubscriptionStatusId>
  <TaxRate>15</TaxRate>
  <TrialDurationInDays>18</TrialDurationInDays>
  <TrialEnd>2025-11-01T05:55:58.2058373-05:00</TrialEnd>
  <TrialStart>2025-11-01T05:55:58.2058373-05:00</TrialStart>
  <UserId>5</UserId>
  <WhiteLabelingSupport>true</WhiteLabelingSupport>
</SubscriptionModel>