POST api/Subscription

Request Information

URI Parameters

None.

Body Parameters

SubscriptionViewModel
NameDescriptionTypeAdditional information
PlanId

globally unique identifier

None.

IBAN

string

None.

Company

string

None.

TechnicalContact

string

None.

AdminContact

string

None.

TechnicalEmail

string

None.

AdminEmail

string

None.

Request Formats

application/json, text/json

Sample:
{
  "planId": "b823caf6-a883-4f2c-b8c1-26899c5d579d",
  "iban": "sample string 2",
  "company": "sample string 3",
  "technicalContact": "sample string 4",
  "adminContact": "sample string 5",
  "technicalEmail": "sample string 6",
  "adminEmail": "sample string 7"
}

application/xml, text/xml

Sample:
<SubscriptionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SquareRoute.Portal.Models">
  <AdminContact>sample string 5</AdminContact>
  <AdminEmail>sample string 7</AdminEmail>
  <Company>sample string 3</Company>
  <IBAN>sample string 2</IBAN>
  <PlanId>b823caf6-a883-4f2c-b8c1-26899c5d579d</PlanId>
  <TechnicalContact>sample string 4</TechnicalContact>
  <TechnicalEmail>sample string 6</TechnicalEmail>
</SubscriptionViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateSubscriptionResultViewModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Key

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "key": "sample string 2"
}

application/xml, text/xml

Sample:
<CreateSubscriptionResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SquareRoute.Portal.Models">
  <Key>sample string 2</Key>
  <Success>true</Success>
</CreateSubscriptionResultViewModel>