Subscription management and recurring billing solutions
SubscriptionBridge
 
Table of Contents

EventRequest Call Reference

EventRequest will trigger a specific event for a specific subscription.

View:

EventRequest

Overview

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box.

XML

<?xml version="1.0" encoding="utf-8"?>
    <EventRequest>
        <Username>string</Username>	
        <Token>string</Token>	
	<GUID>string</GUID>
	<Action>string</Action>	
    </EventRequest>

Elements

Name Type Occurrence Meaning
EventRequest container required Parent Element
Username string required Merchant API username (this is not your SubscriptionBridge login id)
Token string required Your application's security token. view also: How to create a token
GUID string required This is the unique ID that was returned with your SubscriptionRequest
Action string required This is the action you want to trigger.

Actions

The follow are the valid parameters for the “Action” element in the XML above:

  • Trial_Ending_Reminder
  • Trial_Ending_Reminder_Final
  • Balance_Due
  • Balance_Due_Final
  • Subscription_Canceled

EventResponse

Overview

The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box.

XML

<?xml version="1.0" encoding="utf-8"?>
    <EventResponse>	
        <Status>string</Status>
	<Timestamp>timestamp</Timestamp> 
    </EventResponse>

Elements

Name Type Occurrence Meaning
EventResponse container required Parent Element
Status string always Success, Error, or Warning
Timestamp string always All responses return the official SB time stamp in UTC/GMT
Packages container always A container element that contains a list of repeating package elements
C:/Domains/subscrip/wiki.subscriptionbridge.com/wwwroot/sbdata10/pages/developer_guide/call_reference/eventrequest.txt · Last modified: 2010/01/05 23:00 (external edit)
 


Contact us for more information, or head over to the free trial sign-up form to give SubscriptionBridge a try!   Sign Up Free