SetBillingAgreementDetails

Sets billing agreement details such as a description of the agreement and other information about the merchant.

Description

Call the SetBillingAgreementDetails operation to specify billing agreement details such as a description of the agreement and other information about the merchant.

This operation has a maximum request quota of 10 and a restore rate of one request every second in the production environment. It has a maximum request quota of two and a restore rate of one request every two seconds 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.

BillingAgreementAttributes

Yes

BillingAgreementAttributes

The merchant-specified attributes of the billing agreement.

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=SetBillingAgreementDetails
  &AmazonBillingAgreementId=C01-8824045-7416542
  &BillingAgreementAttributes.PlatformId=PLATFORM_ID_HERE
  &BillingAgreementAttributes.SellerNote=APPROVE%20LITE%20APPROVE%20HEAVY
  &BillingAgreementAttributes.SellerBillingAgreementAttributes
    .CustomInformation=Example%20Customer%20Info
  &BillingAgreementAttributes.SellerBillingAgreementAttributes
    .StoreName=Test%20Store%20Name
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SellerId=YOUR_SELLER_ID_HERE
  &SignatureMethod=HmacSHA256
  &SignatureVersion=2
  &Timestamp=2013-12-11T10%3A57%3A18.000Z
  &Version=2013-01-01
  &Signature=Z0ZVgWu0ICF4FLxt1mTjyK%2BjdYG6Kmm8JxLTfsQEXAMPLE

Sample response

  <SetBillingAgreementDetailsResponse
    xmlns="https://mws.amazonservices.com/
          schema/OffAmazonPayments_Sandbox/2013-01-01">
  <SetBillingAgreementDetailsResult>
    <BillingAgreementDetails>
      <AmazonBillingAgreementId>C01-8824045-7416542</AmazonBillingAgreementId>
      <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>
      <BillingAgreementConsent>true</BillingAgreementConsent>
      <BillingAgreementStatus>
        <State>Draft</State>
      </BillingAgreementStatus>
      <BillingAgreementLimits>
        <AmountLimitPerTimePeriod>
          <CurrencyCode>USD</CurrencyCode>
          <Amount>500</Amount>
        </AmountLimitPerTimePeriod>
        <TimePeriodStartDate>2013-12-01T00:00:00Z</TimePeriodStartDate>
        <TimePeriodEndDate>2013-12-23T23:59:59Z</TimePeriodEndDate>
        <CurrentRemainingBalance>
          <CurrencyCode>USD</CurrencyCode>
          <Amount>94.50</Amount>
        </CurrentRemainingBalance>
      </BillingAgreementLimits>
      <ReleaseEnvironment>Sandbox</ReleaseEnvironment>
      <SellerNote>APPROVE  LITE APPROVE HEAVY</SellerNote>
      <SellerBillingAgreementAttributes>
        <CustomInformation>Example Customer Info</CustomInformation>
        <StoreName>Test Store Name</StoreName>
      </SellerBillingAgreementAttributes>
    </BillingAgreementDetails>
  </SetBillingAgreementDetailsResult>
  <ResponseMetadata>
    <RequestId>bab23c81-f7c9-4d1a-b76b-fbcec07e47f5</RequestId>
  </ResponseMetadata>
  </SetBillingAgreementDetailsResponse>

See also


Copyright © 2009-2018 Amazon.com, Inc. or its affiliates. Amazon and Amazon.com are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of their respective owners.