Knowledge Marketing
Home Reference

POST SavePaidSubscriber?accessKey={accessKey}

This method allows you to insert or update a paid subscriber record.

SOAP Examples

C#

             class Test
             {
                 static void Main()
                 {
                     UADServiceClient client = new UADServiceClient();
            
                     // Use the 'client' variable to call operations on the service.
                     PaidSubscription paidSub = new PaidSubscription();
                     Guid guid = new Guid("00000000-0000-0000-0000-000000000000");
                     Response response = client.SavePaidSubscriber( guid, paidSub);
             
                     // Always close the client.
                     client.Close();
                 }
             }
             
             
Visual Basic

             Class Test
                 Shared Sub Main()
                     Dim client As UADServiceClient = New UADServiceClient()
                     ' Use the 'client' variable to call operations on the service.
                     Dim paidSub as PaidSubscription = new PaidSubscription()
                     Dim guid as Guid = new Guid("00000000-0000-0000-0000-000000000000")
                     Dim response As Response = client.SavePaidSubscriber( guid, paidSub)
             
                     ' Always close the client.
                     client.Close()
                 End Sub
             End Class
             

JSON Examples

No request example. No response example.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessKey

Client access key.

globally unique identifier

Required

Body Parameters

The PaidSubscription object your saving.

PaidSubscription
NameDescriptionTypeAdditional information
OrderDate

Subscription order date for the PaidSubscription object.

date

None.

IsGift

If the PaidSubscription object is a gift.

boolean

None.

Payment

PaidSubscriptionPayment for the PaidSubscription object.

PaidSubscriptionPayment

None.

SubscriberFirstName

First name of the PaidSubscription object.

string

None.

SubscriberLastName

Last name of the PaidSubscription object.

string

None.

SubscriberEmail

Email for the PaidSubscription object.

string

None.

SubscriberTitle

Title for the PaidSubscription object.

string

None.

SubscriberCompany

Company for the PaidSubscription object.

string

None.

SubscriberPhone

Phone number for the PaidSubscription object.

string

None.

SubscriberMobile

Mobile number for the PaidSubscription object.

string

None.

SubscriberFax

Fax number for the PaidSubscription object.

string

None.

RenewalCode

Subscription renewal code for the PaidSubscription object.

string

None.

Source

Source for the PaidSubscription object.

string

None.

MailingFirstName

Mailing first name of the PaidSubscription object.

string

None.

MailingLastName

Mailing last name of the PaidSubscription object.

string

None.

MailingEmail

Mailing email for the PaidSubscription object.

string

None.

MailingTitle

Mailing title for the PaidSubscription object.

string

None.

MailingCompany

Mailing company for the PaidSubscription object.

string

None.

MailingAddress

Mailing address for the PaidSubscription object.

string

None.

MailingAddress2

Mailing address2 for the PaidSubscription object.

string

None.

MailingCity

Mailing city for the PaidSubscription object.

string

None.

MailingState

Mailing state for the PaidSubscription object.

string

None.

MailingZip

Mailing zip for the PaidSubscription object.

string

None.

MailingPlus4

Mailing plus4 for the PaidSubscription object.

string

None.

MailingCounty

Mailing county for the PaidSubscription object.

string

None.

MailingCountry

Mailing country for the PaidSubscription object.

string

None.

MailingLatitude

Mailing latitude for the PaidSubscription object.

decimal number

None.

MailingLongitude

Mailing longitude for the PaidSubscription object.

decimal number

None.

BillingFirstName

Billing first name of the PaidSubscription object.

string

None.

BillingLastName

Billing last name of the PaidSubscription object.

string

None.

BillingEmail

Mailing email for the PaidSubscription object.

string

None.

BillingTitle

Mailing title for the PaidSubscription object.

string

None.

BillingCompany

Billing company for the PaidSubscription object.

string

None.

BillingAddress

Billing address for the PaidSubscription object.

string

None.

BillingAddress2

Billing address2 for the PaidSubscription object.

string

None.

BillingCity

Billing city for the PaidSubscription object.

string

None.

BillingState

Billing state for the PaidSubscription object.

string

None.

BillingZip

Billing zip for the PaidSubscription object.

string

None.

BillingPlus4

Billing plus4 for the PaidSubscription object.

string

None.

BillingCounty

Billing county for the PaidSubscription object.

string

None.

BillingCountry

Billing country for the PaidSubscription object.

string

None.

BillingLatitude

Billing latitude for the PaidSubscription object.

decimal number

None.

BillingLongitude

Billing longitude for the PaidSubscription object.

decimal number

None.

ProductDemographics

List of PaidSubscriptionProductDemographic objects for the PaidSubscription object.

Collection of PaidSubscriptionProductDemographic

None.

BundleItems

List of PaidBundleItem objects for the PaidSubscription object.

Collection of PaidBundleItem

None.

Request Formats

application/json, text/json

Sample:
{
  "<OrderDate>k__BackingField": "2020-08-08T04:15:57.4423896-05:00",
  "<IsGift>k__BackingField": true,
  "<Payment>k__BackingField": {
    "<Amount>k__BackingField": 1.1,
    "<Note>k__BackingField": "sample string 2",
    "<TransactionId>k__BackingField": "sample string 3",
    "<PaymentType>k__BackingField": "Check"
  },
  "<SubscriberFirstName>k__BackingField": "sample string 3",
  "<SubscriberLastName>k__BackingField": "sample string 4",
  "<SubscriberEmail>k__BackingField": "sample string 5",
  "<SubscriberTitle>k__BackingField": "sample string 6",
  "<SubscriberCompany>k__BackingField": "sample string 7",
  "<SubscriberPhone>k__BackingField": "sample string 8",
  "<SubscriberMobile>k__BackingField": "sample string 9",
  "<SubscriberFax>k__BackingField": "sample string 10",
  "<RenewalCode>k__BackingField": "sample string 11",
  "<Source>k__BackingField": "sample string 12",
  "<MailingFirstName>k__BackingField": "sample string 13",
  "<MailingLastName>k__BackingField": "sample string 14",
  "<MailingEmail>k__BackingField": "sample string 15",
  "<MailingTitle>k__BackingField": "sample string 16",
  "<MailingCompany>k__BackingField": "sample string 17",
  "<MailingAddress>k__BackingField": "sample string 18",
  "<MailingAddress2>k__BackingField": "sample string 19",
  "<MailingCity>k__BackingField": "sample string 20",
  "<MailingState>k__BackingField": "sample string 21",
  "<MailingZip>k__BackingField": "sample string 22",
  "<MailingPlus4>k__BackingField": "sample string 23",
  "<MailingCounty>k__BackingField": "sample string 24",
  "<MailingCountry>k__BackingField": "sample string 25",
  "<MailingLatitude>k__BackingField": 26.1,
  "<MailingLongitude>k__BackingField": 27.1,
  "<BillingFirstName>k__BackingField": "sample string 28",
  "<BillingLastName>k__BackingField": "sample string 29",
  "<BillingEmail>k__BackingField": "sample string 30",
  "<BillingTitle>k__BackingField": "sample string 31",
  "<BillingCompany>k__BackingField": "sample string 32",
  "<BillingAddress>k__BackingField": "sample string 33",
  "<BillingAddress2>k__BackingField": "sample string 34",
  "<BillingCity>k__BackingField": "sample string 35",
  "<BillingState>k__BackingField": "sample string 36",
  "<BillingZip>k__BackingField": "sample string 37",
  "<BillingPlus4>k__BackingField": "sample string 38",
  "<BillingCounty>k__BackingField": "sample string 39",
  "<BillingCountry>k__BackingField": "sample string 40",
  "<BillingLatitude>k__BackingField": 41.1,
  "<BillingLongitude>k__BackingField": 42.1,
  "<ProductDemographics>k__BackingField": [
    {
      "<ProductCode>k__BackingField": "sample string 1",
      "<DemographicName>k__BackingField": "sample string 2",
      "<OtherTextValue>k__BackingField": "sample string 3",
      "<Values>k__BackingField": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "<ProductCode>k__BackingField": "sample string 1",
      "<DemographicName>k__BackingField": "sample string 2",
      "<OtherTextValue>k__BackingField": "sample string 3",
      "<Values>k__BackingField": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "<BundleItems>k__BackingField": [
    {
      "<BundleName>k__BackingField": "sample string 1",
      "<Price>k__BackingField": 2.1
    },
    {
      "<BundleName>k__BackingField": "sample string 1",
      "<Price>k__BackingField": 2.1
    }
  ]
}

application/xml, text/xml

Sample:
<PaidSubscription xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderDate>2020-08-08T04:15:57.4423896-05:00</OrderDate>
  <IsGift>true</IsGift>
  <Payment>
    <Amount>1.1</Amount>
    <Note>sample string 2</Note>
    <TransactionId>sample string 3</TransactionId>
    <PaymentType>Check</PaymentType>
  </Payment>
  <SubscriberFirstName>sample string 3</SubscriberFirstName>
  <SubscriberLastName>sample string 4</SubscriberLastName>
  <SubscriberEmail>sample string 5</SubscriberEmail>
  <SubscriberTitle>sample string 6</SubscriberTitle>
  <SubscriberCompany>sample string 7</SubscriberCompany>
  <SubscriberPhone>sample string 8</SubscriberPhone>
  <SubscriberMobile>sample string 9</SubscriberMobile>
  <SubscriberFax>sample string 10</SubscriberFax>
  <RenewalCode>sample string 11</RenewalCode>
  <Source>sample string 12</Source>
  <MailingFirstName>sample string 13</MailingFirstName>
  <MailingLastName>sample string 14</MailingLastName>
  <MailingEmail>sample string 15</MailingEmail>
  <MailingTitle>sample string 16</MailingTitle>
  <MailingCompany>sample string 17</MailingCompany>
  <MailingAddress>sample string 18</MailingAddress>
  <MailingAddress2>sample string 19</MailingAddress2>
  <MailingCity>sample string 20</MailingCity>
  <MailingState>sample string 21</MailingState>
  <MailingZip>sample string 22</MailingZip>
  <MailingPlus4>sample string 23</MailingPlus4>
  <MailingCounty>sample string 24</MailingCounty>
  <MailingCountry>sample string 25</MailingCountry>
  <MailingLatitude>26.1</MailingLatitude>
  <MailingLongitude>27.1</MailingLongitude>
  <BillingFirstName>sample string 28</BillingFirstName>
  <BillingLastName>sample string 29</BillingLastName>
  <BillingEmail>sample string 30</BillingEmail>
  <BillingTitle>sample string 31</BillingTitle>
  <BillingCompany>sample string 32</BillingCompany>
  <BillingAddress>sample string 33</BillingAddress>
  <BillingAddress2>sample string 34</BillingAddress2>
  <BillingCity>sample string 35</BillingCity>
  <BillingState>sample string 36</BillingState>
  <BillingZip>sample string 37</BillingZip>
  <BillingPlus4>sample string 38</BillingPlus4>
  <BillingCounty>sample string 39</BillingCounty>
  <BillingCountry>sample string 40</BillingCountry>
  <BillingLatitude>41.1</BillingLatitude>
  <BillingLongitude>42.1</BillingLongitude>
  <ProductDemographics>
    <PaidSubscriptionProductDemographic>
      <ProductCode>sample string 1</ProductCode>
      <DemographicName>sample string 2</DemographicName>
      <OtherTextValue>sample string 3</OtherTextValue>
      <Values>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Values>
    </PaidSubscriptionProductDemographic>
    <PaidSubscriptionProductDemographic>
      <ProductCode>sample string 1</ProductCode>
      <DemographicName>sample string 2</DemographicName>
      <OtherTextValue>sample string 3</OtherTextValue>
      <Values>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Values>
    </PaidSubscriptionProductDemographic>
  </ProductDemographics>
  <BundleItems>
    <PaidBundleItem>
      <BundleName>sample string 1</BundleName>
      <Price>2.1</Price>
    </PaidBundleItem>
    <PaidBundleItem>
      <BundleName>sample string 1</BundleName>
      <Price>2.1</Price>
    </PaidBundleItem>
  </BundleItems>
</PaidSubscription>

Response Information

Resource Description

Response object containing an int.

ResponseOfInt32
NameDescriptionTypeAdditional information
ProcessCode

ProcessCode for the Response object.

string

None.

Status

Status for the Response object.

ServiceResponseStatusTypes

None.

Message

Message for the Response object.

string

None.

Result

Result for the Response object.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "<ProcessCode>k__BackingField": "sample string 1",
  "<Status>k__BackingField": "Success",
  "<Message>k__BackingField": "sample string 2",
  "<Result>k__BackingField": 3
}

application/xml, text/xml

Sample:
<ResponseOfInt32 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProcessCode>sample string 1</ProcessCode>
  <Status>Success</Status>
  <Message>sample string 2</Message>
  <Result>3</Result>
</ResponseOfInt32>