POST rest/v2/subscription/create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
user	User	None.
billingInfo	BillingInfo	None.
subscriber	Subscriber	None.

Request Formats

application/json, text/json

Sample:

{
  "user": {
    "userID": "c97c0fea-5017-4b53-a2f2-c6cace99a5dd"
  },
  "billingInfo": {
    "ratePlanID": "sample string 1",
    "zuoraRatePlanID": "sample string 2",
    "paymentMethodID": "sample string 3",
    "activateTrial": true,
    "couponCode": "sample string 5"
  },
  "subscriber": {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "customerName": "sample string 3",
    "districtCode": "sample string 4",
    "contactInfo": {
      "emailAddress": "sample string 1",
      "addresses": [
        {
          "addressType": "sample string 1",
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "poBox": "sample string 4",
          "city": "sample string 5",
          "countryCode": "sample string 6",
          "stateCode": "sample string 7",
          "postalCode": "sample string 8"
        },
        {
          "addressType": "sample string 1",
          "addressLine1": "sample string 2",
          "addressLine2": "sample string 3",
          "poBox": "sample string 4",
          "city": "sample string 5",
          "countryCode": "sample string 6",
          "stateCode": "sample string 7",
          "postalCode": "sample string 8"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<SubscriptionActivationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HMH.EnterpriseEngineering.Subscriptions.Api.Data.Models.Subscription">
  <billingInfo>
    <activateTrial>true</activateTrial>
    <couponCode>sample string 5</couponCode>
    <paymentMethodID>sample string 3</paymentMethodID>
    <ratePlanID>sample string 1</ratePlanID>
    <zuoraRatePlanID>sample string 2</zuoraRatePlanID>
  </billingInfo>
  <subscriber>
    <contactInfo>
      <addresses>
        <Address>
          <addressLine1>sample string 2</addressLine1>
          <addressLine2>sample string 3</addressLine2>
          <addressType>sample string 1</addressType>
          <city>sample string 5</city>
          <countryCode>sample string 6</countryCode>
          <poBox>sample string 4</poBox>
          <postalCode>sample string 8</postalCode>
          <stateCode>sample string 7</stateCode>
        </Address>
        <Address>
          <addressLine1>sample string 2</addressLine1>
          <addressLine2>sample string 3</addressLine2>
          <addressType>sample string 1</addressType>
          <city>sample string 5</city>
          <countryCode>sample string 6</countryCode>
          <poBox>sample string 4</poBox>
          <postalCode>sample string 8</postalCode>
          <stateCode>sample string 7</stateCode>
        </Address>
      </addresses>
      <emailAddress>sample string 1</emailAddress>
    </contactInfo>
    <customerName>sample string 3</customerName>
    <districtCode>sample string 4</districtCode>
    <firstName>sample string 1</firstName>
    <lastName>sample string 2</lastName>
  </subscriber>
  <user>
    <userID>c97c0fea-5017-4b53-a2f2-c6cace99a5dd</userID>
  </user>
</SubscriptionActivationRequest>

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

Response Information

Resource Description

SubscriptionActivationResponse

Name	Type	Additional information
accountID	string	None.
accountNumber	string	None.
paymentMethodID	string	None.
subscriptionID	string	None.
subscriptionNumber	string	None.
activateTrial	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "accountID": "sample string 1",
  "accountNumber": "sample string 2",
  "paymentMethodID": "sample string 3",
  "subscriptionID": "sample string 4",
  "subscriptionNumber": "sample string 5",
  "activateTrial": true
}

application/xml, text/xml

Sample:

<SubscriptionActivationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HMH.EnterpriseEngineering.Subscriptions.Api.Data.Models.Subscription">
  <accountID>sample string 1</accountID>
  <accountNumber>sample string 2</accountNumber>
  <activateTrial>true</activateTrial>
  <paymentMethodID>sample string 3</paymentMethodID>
  <subscriptionID>sample string 4</subscriptionID>
  <subscriptionNumber>sample string 5</subscriptionNumber>
</SubscriptionActivationResponse>