POST api/admin/createTksSubscription

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
agentId	integer	None.
productPlanId	integer	None.
mlsId	string	None.
amount	decimal number	None.
trialEndDate	date	None.
trialStartDate	date	None.
payments	Collection of SplitPaymentModel	None.
numberOfMonths	integer	None.
invoiceMetadataNote	string	None.

Request Formats

application/json, text/json

Sample:

{
  "agentId": 1,
  "productPlanId": 2,
  "mlsId": "sample string 3",
  "amount": 4.0,
  "trialEndDate": "2024-12-21T15:44:14.4760265+00:00",
  "trialStartDate": "2024-12-21T15:44:14.4760265+00:00",
  "payments": [
    {
      "amount": 1.0,
      "paymentDate": "2024-12-21T15:44:14.4916609+00:00"
    },
    {
      "amount": 1.0,
      "paymentDate": "2024-12-21T15:44:14.4916609+00:00"
    }
  ],
  "numberOfMonths": 7,
  "invoiceMetadataNote": "sample string 8"
}

text/html

Sample:

{"agentId":1,"productPlanId":2,"mlsId":"sample string 3","amount":4.0,"trialEndDate":"2024-12-21T15:44:14.4760265+00:00","trialStartDate":"2024-12-21T15:44:14.4760265+00:00","payments":[{"amount":1.0,"paymentDate":"2024-12-21T15:44:14.4916609+00:00"},{"amount":1.0,"paymentDate":"2024-12-21T15:44:14.4916609+00:00"}],"numberOfMonths":7,"invoiceMetadataNote":"sample string 8"}

application/xml, text/xml

Sample:

<CreateTksSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Services">
  <Amount>4</Amount>
  <InvoiceMetadataNote>sample string 8</InvoiceMetadataNote>
  <NumberOfMonths>7</NumberOfMonths>
  <RemainingPayments>
    <SplitPaymentModel>
      <Amount>1</Amount>
      <PaymentDate>2024-12-21T15:44:14.4916609+00:00</PaymentDate>
    </SplitPaymentModel>
  </RemainingPayments>
  <SplitPayments>
    <SplitPaymentModel>
      <Amount>1</Amount>
      <PaymentDate>2024-12-21T15:44:14.4916609+00:00</PaymentDate>
    </SplitPaymentModel>
    <SplitPaymentModel>
      <Amount>1</Amount>
      <PaymentDate>2024-12-21T15:44:14.4916609+00:00</PaymentDate>
    </SplitPaymentModel>
  </SplitPayments>
  <TrialEndDate>2024-12-21T15:44:14.4760265+00:00</TrialEndDate>
  <TrialStartDate>2024-12-21T15:44:14.4760265+00:00</TrialStartDate>
  <AgentId>1</AgentId>
  <MlsId>sample string 3</MlsId>
  <ProductPlanId>2</ProductPlanId>
</CreateTksSubscriptionRequest>

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 'CreateTksSubscriptionRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.