CloseBillingAgreement

Confirms that you want to terminate the billing agreement with the buyer and that you do not expect to create any new order references or authorizations on this billing agreement.

Description

Call the CloseBillingAgreement operation on a previously confirmed billing agreement to indicate that you want to terminate the billing agreement with the buyer and that you do not expect to create any new order references or authorizations on this billing agreement. All open authorizations on the billing agreement can still be used to capture funds.

After successfully calling this operation, the billing agreement moves to the Closed state.

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.

ClosureReason

No

xs:string

Describes the reason for closing the billing agreement.

Maximum: 1024 characters

Response Elements

This operation returns only the standard response elements.

Examples

Example 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=CloseBillingAgreement
  &AmazonBillingAgreementId=C01-8824045-7416542
  &ClosureReason=Closing%20OR%20for%20Test
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SellerId=YOUR_SELLER_ID_HERE
  &SignatureMethod=HmacSHA256
  &SignatureVersion=2
  &Timestamp=2013-12-11T12%3A32%3A42.000Z
  &Version=2013-01-01
  &Signature=yrpMpoDfGLu567t611z27v4yJ8SURIVMKcy26sJEXAMPLE

Example Response

  <CloseBillingAgreementResponse
    xmlns="https://mws.amazonservices.com/
          schema/OffAmazonPayments_Sandbox/2013-01-01">
  <ResponseMetadata>
    <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId>
  </ResponseMetadata>
  </CloseBillingAgreementResponse>

Related Topics


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.