AddMeteredRequest

Overview

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

Learn More:

AddMeteredRequest

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 (Not your Merchant Center login)
Token	string	required	Hash of API Username and Password. Creating a Token
Guid	string	always	This is the identifier for the subscription and should be referenced in future management requests
Amount	currency	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

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

Getting Started

Sites / Stores

Products

Subscriptions

Integration

AddMeteredRequest

Overview

AddMeteredRequest

XML

Elements

AddMeteredResponse

XML

Elements