Amazon Simple Pay
Advanced User Guide (API Version 2010-08-28)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

GetSubscriptionDetails

Description

GetSubscriptionDetails enables you to retrieve the subscription details for a specific SubscriptionId.

Request Parameters

ParameterDescription

Required

SubscriptionId

The subscription ID for the subscription of interest.

Type: String

Default: None

Constraint: Cannot be null or empty

Yes

You must also use the Action parameter as described in Common Request Parameters. Parameter names are case sensitive.

Response Elements

ElementDescription

SubscriptionDetails

A single SubscriptionDetails Type object, containing the details for the subscription.

Responses also include elements common to all responses. For more information, see Common Response Elements.

Errors

This action can return the following errors:

Examples

Sample REST Request

This section shows a sample request.

https://fps.sandbox.amazonaws.com/?
Action=GetSubscriptionDetails
&SubscriptionId=YourSubscriptionId
&AWSAccessKeyId=YourAccessKey
&Version=2010-08-28
&Timestamp=2011-03-11T06%3A46%3A23Z
&SignatureVersion=2
&Signature=YourCalculatedSignature
&SignatureMethod=HmacSHA256

Sample Response to REST Request

This section shows a sample REST response.

<GetSubscriptionDetailsResponse 
    xmlns="http://fps.amazonaws.com/doc/2010-08-28/">
    <GetSubscriptionDetailsResult>
        <SubscriptionDetails>
            <SubscriptionId>YourSubscriptionId</SubscriptionId>
            <Description>SubscriptionDescription</Description>
            <SubscriptionAmount>
                <CurrencyCode>USD</CurrencyCode>
                <Value>10.000000</Value>
            </SubscriptionAmount>
            <PromotionalAmount>
                <CurrencyCode>USD</CurrencyCode>
                <Value>4.000000</Value>
            </PromotionalAmount>
            <NumberOfPromotionalTransactions>
                2 
            </NumberOfPromotionalTransactions>
            <StartDate>2011-04-07T08:16:52.000-07:00</StartDate>
            <EndDate>2011-04-07T08:19:52.000-07:00</EndDate>
            <SubscriptionPeriod>
                <Value>18</Value>
                <TimeUnit>week</TimeUnit>
            </SubscriptionPeriod>
            <SubscriptionFrequency>
                <Value>6</Value>
                <TimeUnit>week</TimeUnit>
            </SubscriptionFrequency>
            <SubscriptionStatus>Completed</SubscriptionStatus>
            <NumberOfTransactionsProcessed>3</NumberOfTransactionsProcessed>
            <RecipientEmail>a@b.c</RecipientEmail>
            <RecipientName>RecipientName</RecipientName>
            <SenderEmail>p@q.r</SenderEmail>
            <SenderName>SenderName</SenderName>
        </SubscriptionDetails>
    </GetSubscriptionDetailsResult>
    <ResponseMetadata>
        <RequestId>RequestId</RequestId>
    </ResponseMetadata>
</GetSubscriptionDetailsResponse>