This is an old revision of the document!

AddMeteredRequest Call Reference

AddMeteredRequest lets you add a metered charge onto a subscription. This feature is only available with the Early Impact Gateway.

View:

AddMeteredRequest

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"?>
    <AddMeteredRequest>
        <Username>string</Username>	
        <Token>string</Token>	
        <Guid>string</Guid>	
	<Amount>currency</Amount>	
        <Memo>string</Memo>
        <RefName>string</RefName>
    </AddMeteredRequest>

Elements

Name	Type	Occurrence	Meaning
AddMeteredRequest	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	The Subscription ID or Order Number
Amount	string	required	The reason you are canceling the subscription
Memo	string	required	The reason you are canceling the subscription
RefName	string	required	The reason you are canceling the subscription

AddMeteredResponse

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"?>
    <AddMeteredResponse>
        <Ack>string</Ack>
	<Timestamp>timestamp</Timestamp>
    </AddMeteredResponse>

Elements

Name	Type	Occurrence	Meaning
AddMeteredResponse	container	required	Parent Element
Ack	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

AddMeteredRequest Call Reference