GetBillingAgreementDetails

Returns details about the Billing Agreement object and its current state.

Description

The GetBillingAgreementDetails operation returns details about the Billing Agreement object and its current state. A Billing Agreement object provides details about the following:

  • Buyer
  • Description
  • Destination (optional)
  • Merchant billing agreement details (optional)
  • List of constraints (optional)

This operation has a maximum request quota of 20 and a restore rate of two requests every second in the production environment. It has a maximum request quota of five and a restore rate of one request every second in the sandbox environment. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Parameter name Required Type Description
AmazonBillingAgreementId Yes xs:string The billing agreement identifier.

This value is retrieved from the Amazon Button, AddressBook, or Wallet widgets.
AccessToken No xs:string The buyer access token. You must provide a valid AccessToken if you want to get the full shipping address before the billing agreement is confirmed. Otherwise you will only receive the city, state, postal code, and country before you confirm the billing agreement.

This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon.

Response elements

Element name Description
BillingAgreementDetails Encapsulates details about the Billing Agreement object and its current state.

Type: BillingAgreementDetails

Examples

Sample query request


POST /OffAmazonPayments/2013-01-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: <Your User Agent Header>

AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE
&Action=GetBillingAgreementDetails
&AmazonBillingAgreementId=C01-8824045-7416542
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&SellerId=YOUR_SELLER_ID_HERE
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2013-12-11T10%3A38%3A44.000Z
&Version=2013-01-01
&Signature=gP11oEBaaiQdASWsLDyid18Wn%2BB%2FKZQQtKgpHCtEXAMPLE

Sample response


<GetBillingAgreementDetailsResponse
  xmlns="https://mws.amazonservices.com/
        schema/OffAmazonPayments_Sandbox/2013-01-01">
<GetBillingAgreementDetailsResult>
  <BillingAgreementDetails>
    <AmazonBillingAgreementId>C01-8824045-7416542</AmazonBillingAgreementId>
    <Constraints>
      <ConstraintID>BuyerConsentNotSet</ConstraintID>
      <Description>
        Buyer has not given consent for this Billing Agreement.
      </Description>
    </Constraints>
    <CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp>
    <Destination>
      <DestinationType>Physical</DestinationType>
      <PhysicalDestination>
        <City>Seattle</City>
        <CountryCode>US</CountryCode>
        <PostalCode>98104</PostalCode>
        <StateOrRegion>WA</StateOrRegion>
      </PhysicalDestination>
    </Destination>
     <BillingAgreementLimits>
      <AmountLimitPerTimePeriod>
        <CurrencyCode>USD</CurrencyCode>
        <Amount>500</Amount>
      </AmountLimitPerTimePeriod>
      <TimePeriodStartDate>2013-12-01T00:00:00Z</TimePeriodStartDate>
      <TimePeriodEndDate>2014-01-01T00:00:00Z</TimePeriodEndDate>
      <CurrentRemainingBalance>
        <CurrencyCode>USD</CurrencyCode>
        <Amount>94.50</Amount>
      </CurrentRemainingBalance>
    </BillingAgreementLimits>
    <BillingAgreementStatus>
      <State>Draft</State>
    </BillingAgreementStatus>
    <ReleaseEnvironment>Sandbox</ReleaseEnvironment>
  </BillingAgreementDetails>
</GetBillingAgreementDetailsResult>
<ResponseMetadata>
  <RequestId>4a08624e-fffa-4fe7-bc19-ef9330c42f6a</RequestId>
</ResponseMetadata>
</GetBillingAgreementDetailsResponse>

See also