SubscriptionBridge: recurring billing and subscription management system - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== EventRequest Call Reference ======


EventRequest will trigger a specific event for a specific subscription.  


**View:**

  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]  
  * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
  * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 


===== 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 ====

<code>

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

</code>


==== 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 ====

<code>

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

</code>


==== 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 |