POST api/me/ptf-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

PtfSubscriptionModel
NameDescriptionTypeAdditional information
Id

integer

None.
StripeSubscriptionId

string

None.
SubscriptionStatusId

integer

None.
Status

string

None.
UserId

integer

None.
SubscriberFirstName

string

None.
SubscriberLastName

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.
PricePerProperty

decimal number

None.
BillingCycleAnchor

date

None.
StartDate

date

None.
EndedAt

date

None.
TrialDurationInDays

integer

None.
SetupFee

decimal number

None.
TrialStart

date

None.
TrialEnd

date

None.
Quantity

integer

None.
LiveMode

boolean

None.
MaxAnalysisCount

integer

None.
MaxReportCount

integer

None.
MaxUserCount

integer

None.
UnlimitedAnalysisSupport

boolean

None.
UnlimitedReportSupport

boolean

None.
EmailMarketingSupport

boolean

None.
WhiteLabelingSupport

boolean

None.
AppealGiftingSupport

boolean

None.
AppealDiscountingSupport

boolean

None.
AppealReferralFeeSupport

boolean

None.
DashboardAccessSupport

boolean

None.
ClosingReportSupport

boolean

None.
MultiPropertyAnalysisSupport

boolean

None.
WebIntegrationSupport

boolean

None.
ApiAccessSupport

boolean

None.
CancelationReason

string

None.
CreatedDate

date

None.
LastModifiedDate

date

None.
CancelationDate

date

None.
SubscriptionNumber

string

None.
StripePlanId

string

None.
SubscriberEmail

string

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",
  "stripeCustomerId": "sample string 8",
  "productBundlePlanId": 9,
  "planName": "sample string 10",
  "planPrice": 11.0,
  "stripeCouponId": "sample string 12",
  "discountPercent": 13.0,
  "taxRate": 14.0,
  "pricePerProperty": 15.0,
  "billingCycleAnchor": "2025-05-20T16:21:25.1119576-05:00",
  "startDate": "2025-05-20T16:21:25.1140365-05:00",
  "endedAt": "2025-05-20T16:21:25.1140365-05:00",
  "trialDurationInDays": 17,
  "setupFee": 18.0,
  "trialStart": "2025-05-20T16:21:25.1150815-05:00",
  "trialEnd": "2025-05-20T16:21:25.1150815-05:00",
  "quantity": 19,
  "liveMode": true,
  "maxAnalysisCount": 21,
  "maxReportCount": 22,
  "maxUserCount": 23,
  "unlimitedAnalysisSupport": true,
  "unlimitedReportSupport": true,
  "emailMarketingSupport": true,
  "whiteLabelingSupport": true,
  "appealGiftingSupport": true,
  "appealDiscountingSupport": true,
  "appealReferralFeeSupport": true,
  "dashboardAccessSupport": true,
  "closingReportSupport": true,
  "multiPropertyAnalysisSupport": true,
  "webIntegrationSupport": true,
  "apiAccessSupport": true,
  "cancelationReason": "sample string 36",
  "createdDate": "2025-05-20T16:21:25.1192403-05:00",
  "lastModifiedDate": "2025-05-20T16:21:25.1192403-05:00",
  "cancelationDate": "2025-05-20T16:21:25.1192403-05:00",
  "subscriptionNumber": "sample string 38",
  "stripePlanId": "sample string 39",
  "subscriberEmail": "sample string 40"
}

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","stripeCustomerId":"sample string 8","productBundlePlanId":9,"planName":"sample string 10","planPrice":11.0,"stripeCouponId":"sample string 12","discountPercent":13.0,"taxRate":14.0,"pricePerProperty":15.0,"billingCycleAnchor":"2025-05-20T16:21:25.1119576-05:00","startDate":"2025-05-20T16:21:25.1140365-05:00","endedAt":"2025-05-20T16:21:25.1140365-05:00","trialDurationInDays":17,"setupFee":18.0,"trialStart":"2025-05-20T16:21:25.1150815-05:00","trialEnd":"2025-05-20T16:21:25.1150815-05:00","quantity":19,"liveMode":true,"maxAnalysisCount":21,"maxReportCount":22,"maxUserCount":23,"unlimitedAnalysisSupport":true,"unlimitedReportSupport":true,"emailMarketingSupport":true,"whiteLabelingSupport":true,"appealGiftingSupport":true,"appealDiscountingSupport":true,"appealReferralFeeSupport":true,"dashboardAccessSupport":true,"closingReportSupport":true,"multiPropertyAnalysisSupport":true,"webIntegrationSupport":true,"apiAccessSupport":true,"cancelationReason":"sample string 36","createdDate":"2025-05-20T16:21:25.1192403-05:00","lastModifiedDate":"2025-05-20T16:21:25.1192403-05:00","cancelationDate":"2025-05-20T16:21:25.1192403-05:00","subscriptionNumber":"sample string 38","stripePlanId":"sample string 39","subscriberEmail":"sample string 40"}

application/xml, text/xml

Sample: 
<PtfSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <ApiAccessSupport>true</ApiAccessSupport>
  <AppealDiscountingSupport>true</AppealDiscountingSupport>
  <AppealGiftingSupport>true</AppealGiftingSupport>
  <AppealReferralFeeSupport>true</AppealReferralFeeSupport>
  <BillingCycleAnchor>2025-05-20T16:21:25.1119576-05:00</BillingCycleAnchor>
  <CancelationDate>2025-05-20T16:21:25.1192403-05:00</CancelationDate>
  <CancelationReason>sample string 36</CancelationReason>
  <ClosingReportSupport>true</ClosingReportSupport>
  <CreatedDate>2025-05-20T16:21:25.1192403-05:00</CreatedDate>
  <DashboardAccessSupport>true</DashboardAccessSupport>
  <DiscountPercent>13</DiscountPercent>
  <EmailMarketingSupport>true</EmailMarketingSupport>
  <EndedAt>2025-05-20T16:21:25.1140365-05:00</EndedAt>
  <Id>1</Id>
  <LastModifiedDate>2025-05-20T16:21:25.1192403-05:00</LastModifiedDate>
  <LiveMode>true</LiveMode>
  <MaxAnalysisCount>21</MaxAnalysisCount>
  <MaxReportCount>22</MaxReportCount>
  <MaxUserCount>23</MaxUserCount>
  <MultiPropertyAnalysisSupport>true</MultiPropertyAnalysisSupport>
  <PlanName>sample string 10</PlanName>
  <PlanPrice>11</PlanPrice>
  <PricePerProperty>15</PricePerProperty>
  <ProductBundlePlanId>9</ProductBundlePlanId>
  <Quantity>19</Quantity>
  <SetupFee>18</SetupFee>
  <StartDate>2025-05-20T16:21:25.1140365-05:00</StartDate>
  <Status>sample string 4</Status>
  <StripeCouponId>sample string 12</StripeCouponId>
  <StripeCustomerId>sample string 8</StripeCustomerId>
  <StripePlanId>sample string 39</StripePlanId>
  <StripeSubscriptionId>sample string 2</StripeSubscriptionId>
  <SubscriberEmail>sample string 40</SubscriberEmail>
  <SubscriberFirstName>sample string 6</SubscriberFirstName>
  <SubscriberLastName>sample string 7</SubscriberLastName>
  <SubscriptionNumber>sample string 38</SubscriptionNumber>
  <SubscriptionStatusId>3</SubscriptionStatusId>
  <TaxRate>14</TaxRate>
  <TrialDurationInDays>17</TrialDurationInDays>
  <TrialEnd>2025-05-20T16:21:25.1150815-05:00</TrialEnd>
  <TrialStart>2025-05-20T16:21:25.1150815-05:00</TrialStart>
  <UnlimitedAnalysisSupport>true</UnlimitedAnalysisSupport>
  <UnlimitedReportSupport>true</UnlimitedReportSupport>
  <UserId>5</UserId>
  <WebIntegrationSupport>true</WebIntegrationSupport>
  <WhiteLabelingSupport>true</WhiteLabelingSupport>
</PtfSubscriptionModel>