POST api/RenewMembership

Processes and bills a membership renewal.

Request Information

URI Parameters

None.

Body Parameters

RenewMembershipRequest
NameDescriptionTypeAdditional information
SessionKey

string

Required
InterestList

List of interest Id values, set bool value to true

 Dictionary of integer [key] and boolean [value]
RenewalStartDate

string
AutoRenewal

boolean
AddOnMemberships

Collection of add-on memberships

 Collection of AddOnMembership
MembershipLevel

Membership level value

 string

Required
MembershipAmount

Amount of the membership donation

 decimal number

Required
AdditionalDonationFundId

Tessitura fund for any additional donation

 integer
AdditionalDonationAmount

Amount of the additional donation

 decimal number
Email

string
Phone

string
AdditionalFirstName

For optional second person

 string
AdditionalLastName

For optional second person

 string
AdditionalEmail

For optional second person

 string
FirstName

string
LastName

string
Address1

string
Address2

string
City

string
StateId

Two letter state value from CountriesStates method

 string
CountryId

integer
PostalCode

string
CreditCardNumber

string

Required
CreditCardType

Tessitura credit card Id value

 integer

Required
CreditCardName

Name on credit card

 string

Required
CreditCardCVV

string

Required
CreditCardExpirationMonth

integer

Required

Range: inclusive between 1 and 12
CreditCardExpirationYear

integer

Required
StoredCreditCardId

integer
SourceId

For optional source id that will be used for the membership purchase session

 integer

Request Formats

application/json, text/json

Sample: 
{
  "SessionKey": "sample string 1",
  "InterestList": {
    "1": true,
    "3": true
  },
  "RenewalStartDate": "sample string 2",
  "AutoRenewal": true,
  "AddOnMemberships": [
    {
      "MembershipLevel": "sample string 1",
      "MembershipAmount": 2.0
    },
    {
      "MembershipLevel": "sample string 1",
      "MembershipAmount": 2.0
    }
  ],
  "MembershipLevel": "sample string 4",
  "MembershipAmount": 5.0,
  "AdditionalDonationFundId": 6,
  "AdditionalDonationAmount": 7.0,
  "Email": "sample string 8",
  "Phone": "sample string 9",
  "AdditionalFirstName": "sample string 10",
  "AdditionalLastName": "sample string 11",
  "AdditionalEmail": "sample string 12",
  "FirstName": "sample string 13",
  "LastName": "sample string 14",
  "Address1": "sample string 15",
  "Address2": "sample string 16",
  "City": "sample string 17",
  "StateId": "sample string 18",
  "CountryId": 19,
  "PostalCode": "sample string 20",
  "CreditCardNumber": "sample string 21",
  "CreditCardType": 22,
  "CreditCardName": "sample string 23",
  "CreditCardCVV": "sample string 24",
  "CreditCardExpirationMonth": 25,
  "CreditCardExpirationYear": 26,
  "StoredCreditCardId": 27,
  "SourceId": 28
}

application/xml, text/xml

Sample: 
<RenewMembershipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution">
  <Address1>sample string 15</Address1>
  <Address2>sample string 16</Address2>
  <City>sample string 17</City>
  <CountryId>19</CountryId>
  <CreditCardCVV>sample string 24</CreditCardCVV>
  <CreditCardExpirationMonth>25</CreditCardExpirationMonth>
  <CreditCardExpirationYear>26</CreditCardExpirationYear>
  <CreditCardName>sample string 23</CreditCardName>
  <CreditCardNumber>sample string 21</CreditCardNumber>
  <CreditCardType>22</CreditCardType>
  <FirstName>sample string 13</FirstName>
  <LastName>sample string 14</LastName>
  <PostalCode>sample string 20</PostalCode>
  <SourceId>28</SourceId>
  <StateId>sample string 18</StateId>
  <StoredCreditCardId>27</StoredCreditCardId>
  <AdditionalDonationAmount>7</AdditionalDonationAmount>
  <AdditionalDonationFundId>6</AdditionalDonationFundId>
  <AdditionalEmail>sample string 12</AdditionalEmail>
  <AdditionalFirstName>sample string 10</AdditionalFirstName>
  <AdditionalLastName>sample string 11</AdditionalLastName>
  <Email>sample string 8</Email>
  <MembershipAmount>5</MembershipAmount>
  <MembershipLevel>sample string 4</MembershipLevel>
  <Phone>sample string 9</Phone>
  <AddOnMemberships>
    <AddOnMembership>
      <MembershipAmount>2</MembershipAmount>
      <MembershipLevel>sample string 1</MembershipLevel>
    </AddOnMembership>
    <AddOnMembership>
      <MembershipAmount>2</MembershipAmount>
      <MembershipLevel>sample string 1</MembershipLevel>
    </AddOnMembership>
  </AddOnMemberships>
  <AutoRenewal>true</AutoRenewal>
  <InterestList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintboolean>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfintboolean>
    <d2p1:KeyValueOfintboolean>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfintboolean>
  </InterestList>
  <RenewalStartDate>sample string 2</RenewalStartDate>
  <SessionKey>sample string 1</SessionKey>
</RenewMembershipRequest>

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

Response Information

Resource Description

RenewMembershipResult object

ApiSuccessOfRenewMembershipResult
NameDescriptionTypeAdditional information
Success

boolean
Data

RenewMembershipResult

Response Formats

application/json

Sample: 
{
  "Success": true,
  "Data": {
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 6,
    "PrimaryAddressError": true,
    "NewSessionKey": "Pt6MNbpgIexGv39WfpdVXn7nWENTJRXcWvNVbmmrBD8L1XrNas2r9gtXl/89VakUjflp3uvwMDD5nvayN69hXeb9wx1we/nhwrGdfAojztM=",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

text/json

Sample: 
{
  "Success": true,
  "Data": {
    "MembershipDonationAdded": true,
    "AdditionalDonationAdded": true,
    "AutoRenewalPaymentSaved": true,
    "AddOnMembershipsAdded": [
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      },
      {
        "MembershipLevel": "sample string 1",
        "MembershipAmount": 2.0
      }
    ],
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 6,
    "PrimaryAddressError": true,
    "NewSessionKey": "an3mA3sDqe0odEFOmpslxHUDM5ONGOAnMYYXZ6TuKQShuIsxp807cgEcuWr6+IURCvydVCPUkdM65p8axIzieDZaD+lqnHXXFC5a6ZYfgmI=",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<ApiSuccessOfRenewMembershipResultyx5QZ_PAX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution">
    <Error xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Error>
    <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 8</NewSessionKey>
    <OrderEmailSent xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</OrderEmailSent>
    <OrderNumber xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">6</OrderNumber>
    <PrimaryAddressError xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PrimaryAddressError>
    <PurchaseCompleted xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PurchaseCompleted>
    <d2p1:AddOnMembershipsAdded>
      <d2p1:AddOnMembership>
        <d2p1:MembershipAmount>2</d2p1:MembershipAmount>
        <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel>
      </d2p1:AddOnMembership>
      <d2p1:AddOnMembership>
        <d2p1:MembershipAmount>2</d2p1:MembershipAmount>
        <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel>
      </d2p1:AddOnMembership>
    </d2p1:AddOnMembershipsAdded>
    <d2p1:AdditionalDonationAdded>true</d2p1:AdditionalDonationAdded>
    <d2p1:AutoRenewalPaymentSaved>true</d2p1:AutoRenewalPaymentSaved>
    <d2p1:MembershipDonationAdded>true</d2p1:MembershipDonationAdded>
  </Data>
</ApiSuccessOfRenewMembershipResultyx5QZ_PAX>