AT&T API Platform SDK for Microsoft®  2.3.3
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Properties
ATT_MSSDK.Paymentv3.SubscriptionStatus Class Reference

Encapsulates return values from the SubscriptionRaw Status API. More...

List of all members.

Public Member Functions

 SubscriptionStatus ()
 Initializes a new instance of the SubscriptionStatus class.

Static Public Member Functions

static SubscriptionStatus ParseXML (string xmlInput)
 Parse an XML document and create a SubscriptionStatus object.

Properties

string Id [get, set]
 Gets or sets the Id of the SubscriptionStatus object.
string Status [get, set]
 Gets or sets the Status of the SubscriptionStatus object.
string Type [get, set]
 Gets or sets the Type of the SubscriptionStatus object.
string ConsumerId [get, set]
 Gets or sets the Unique Consumer Id.
string MerchantTransactionId [get, set]
 Gets or sets the MerchantTransactionId of the SubscriptionStatus object.
string MerchantSubscriptionId [get, set]
 Gets or sets the Subscription ID that is being created/used, if transaction was a subscription. This field will only appear after the transaction has been authorized (status = AUTHORIZED).
string Description [get, set]
 Gets or sets the Short description of the product that is being sold.
double Amount [get, set]
 Gets or sets the Amount of transaction with a maximum of 2 decimal places. Examples: 0.99 to 2.99.
string ContentCategory [get, set]
 Gets or sets the Content Category from a predefined list.
string MerchantProductId [get, set]
 Gets or sets the Purchased Product ID in the merchant's system.
string MerchantApplicationId [get, set]
 Gets or sets the Merchant application identifier that initiated the payment transaction.
string MerchantId [get, set]
 Gets or sets the Merchant identifier in the external system.
bool IsSuccess [get, set]
 Gets or sets a Boolean flag indicating the status of the request.
string Version [get, set]
 Gets or sets the Version of the API signature.
string IsAutoCommitted [get, set]
 Gets or sets the True in R2. Read only parameter.
string Channel [get, set]
 Gets or sets the Merchant UI channel. Must be set to MOBILE_WEB in Release R1.
string Currency [get, set]
 Gets or sets as USD.
string SubscriptionPeriod [get, set]
 Gets or sets the value of period. The interval at which the subscription will be charged.
int PeriodAmount [get, set]
 Gets or sets the number of periods that pass between the renewals.
string Recurrences [get, set]
 Gets or sets the number of times the subscription will be renewed.

Detailed Description

Encapsulates return values from the SubscriptionRaw Status API.


Constructor & Destructor Documentation


Member Function Documentation

Parse an XML document and create a SubscriptionStatus object.

Parameters:
xmlInputThe XML document to parse
Returns:
The SubscriptionStatus values returned.

Property Documentation

Gets or sets the Amount of transaction with a maximum of 2 decimal places. Examples: 0.99 to 2.99.

Gets or sets the Merchant UI channel. Must be set to MOBILE_WEB in Release R1.

Gets or sets the Unique Consumer Id.

Gets or sets the Content Category from a predefined list.

Gets or sets as USD.

Gets or sets the Short description of the product that is being sold.

Gets or sets the Id of the SubscriptionStatus object.

Gets or sets the True in R2. Read only parameter.

Gets or sets a Boolean flag indicating the status of the request.

Gets or sets the Merchant application identifier that initiated the payment transaction.

Gets or sets the Merchant identifier in the external system.

Gets or sets the Purchased Product ID in the merchant's system.

Gets or sets the Subscription ID that is being created/used, if transaction was a subscription. This field will only appear after the transaction has been authorized (status = AUTHORIZED).

Gets or sets the MerchantTransactionId of the SubscriptionStatus object.

Gets or sets the number of periods that pass between the renewals.

Gets or sets the number of times the subscription will be renewed.

Gets or sets the Status of the SubscriptionStatus object.

Gets or sets the value of period. The interval at which the subscription will be charged.

Gets or sets the Type of the SubscriptionStatus object.

Gets or sets the Version of the API signature.