Suspend an account

An account can be suspended due to a customer going on holiday or medical reasons, during this period the regular payments on the account are put on hold. Suspensions can be indefinite–no end date of suspension. When the account is suspended the account is not billed but you may want to collect a suspension fee for administration purposes.

For example, you have a member who will not use the gym for the next two months and you do not want to charge this account regularly but want to have a $3 admin fee for suspension.

Suspension Fees

When creating a suspension, you can either create it with no charge for the customer or specify a suspension fee.
If the customer is going to be charged a fee for the suspension you should pass us the suspension fee and suspension fee frequency (which can be different to the recurring payment frequency) when creating the suspension.
If a suspension is not aligned with the recurring payment schedule then a pro-rata payment will occur.
Even if the suspension fee frequency is different to the account frequency Debitsuccess will still collect any suspension fees owing on the customers next regular payment date

For example, A customer is billed $50 monthly on the 1st of each month. A weekly $5 suspension is created starting on the 1st of February month for 2 weeks between 15th February to 28th February. On the 1st of February, the customer will be debited a pro-rata amount for February:

X days (the number of days in the month) - 14 days (the period of the suspension) * the daily amount the account pays
On the 1st of March, the customer will be debited their normal $50 instalment + $10 for the suspension ($5 * 2 weeks suspension).

Suspend account for the payment cycle

REST API

Use the create Suspension Schedule of Customer Services API to suspend an account for a payment cycle.

POST https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}/suspensionSchedules

minimumEffectiveDate start date of the suspension
SuspensionFee specify the suspension fee to be collected for a single frequency iteration
Frequency specify the frequency of the suspension fee to be collected. Frequency can be one-off, weekly, fortnightly, four-weekly, monthly, bi-monthly, quarterly
numberOfPayments specify the number of payment instalments to be covered by this suspension schedule. Using this parameter will auto-align the suspension start date to the next billing date

SOAP API

SuspendAccountForNumberOfPaymentCycles is used to suspend an existing account within the Debitsuccess billing system.

AccountReferenceNo
System generated account reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
AccountCode is returned when you retrieve account details using one of the GetCustomerAccount messages
ExternalAccountReferenceNo
An external unique reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
minimumEffectiveDate
NumberOfPaymentCycles
SuspensionFee
SuspensionFeeFrequency
DDStop
ODMailStop

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:SuspendAccountForNumberOfPaymentCycles>
         <deb:request>
            <deb1:User>
               <deb1:Password>testPassword</deb1:Password>
               <deb1:Username>testUser</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>ABC12345</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:MinimumEffectiveDate>2022-03-31</deb1:MinimumEffectiveDate>
            <deb1:NumberOfPaymentCycles>5</deb1:NumberOfPaymentCycles>
            <deb1:SuspensionFee>10</deb1:SuspensionFee>
            <deb1:SuspensionFeeFrequency>Monthly</deb1:SuspensionFeeFrequency>
            <deb1:DDStop>true</deb1:DDStop>
            <deb1:ODMailStop>true</deb1:ODMailStop>
         </deb:request>
      </deb:SuspendAccountForNumberOfPaymentCycles>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="9603581e-c4c8-4a36-ad63-5cbf54e1ad7a" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <SuspendAccountForNumberOfPaymentCyclesResponse xmlns="Debitsuccess.WebServices.WCF">
         <SuspendAccountForNumberOfPaymentCyclesResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-07-01T14:43:36.230952+12:00</a:DateCreated>
            <a:Id>2708102e-2a9d-43ae-9482-d887452b1918</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
            <a:ScheduleId>48132090</a:ScheduleId>
            <a:SuspensionEndDate>2022-09-22T00:00:00</a:SuspensionEndDate>
            <a:SuspensionStartDate>2022-04-23T00:00:00</a:SuspensionStartDate>
         </SuspendAccountForNumberOfPaymentCyclesResult>
      </SuspendAccountForNumberOfPaymentCyclesResponse>
   </s:Body>
</s:Envelope>

Suspend account between dates

REST API

Use the create Suspension Schedule of Customer Services API to suspend an account for a period.

POST https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}/suspensionSchedules

minimumEffectiveDate start date of the suspension
SuspensionFee specify the suspension fee to be collected for a single frequency iteration
Frequency specify the frequency of the suspension fee to be collected. Frequency can be one-off, weekly, fortnightly, four-weekly, monthly, bi-monthly, quarterly
suspensionScheduleEndDate specify the end date of the suspension schedule in the "YYYY-MM-DD" format

SOAP API

SuspendAccountBetweenDates is used to suspend an existing account within the Debitsuccess billing system.

AccountReferenceNo
System generated account reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
AccountCode is returned when you retrieve account details using one of the GetCustomerAccount messages
ExternalAccountReferenceNo
An external unique reference for the customer account to be suspended. At least one of the parameters (AccountReferenceNo, ExternalAccountReferenceNo) must be supplied
EndDate
StartDate
SuspensionFee
SuspensionFeeFrequency
DDStop
ODMailStop

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:SuspendAccountBetweenDates>
         <deb:request>
            <deb1:User>
               <deb1:Password>testPassword</deb1:Password>
               <deb1:Username>testUser</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>ABC12345</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:EndDate>2021-03-31</deb1:EndDate>
            <deb1:StartDate>2020-07-30</deb1:StartDate>
            <deb1:SuspensionFee>10</deb1:SuspensionFee>
            <deb1:SuspensionFeeFrequency>Monthly</deb1:SuspensionFeeFrequency>
            <deb1:DDStop>true</deb1:DDStop>
            <deb1:ODMailStop>true</deb1:ODMailStop>
         </deb:request>
      </deb:SuspendAccountBetweenDates>
   </soapenv:Body>
</soapenv:Envelope>

Debitsuccess Developer Documentation

Suspend an account

Suspension Fees

Suspend account for the payment cycle

REST API

SOAP API

Sample request

Sample response

Suspend account between dates

REST API

SOAP API

Sample request

Sample response

Related Articles