Open eBay Subscription Call Reference Version 1.2.0 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

Retrieves all available billing statements for a subscriber. For each statement, provides a balance due. The call is generally used before a getBillingRecords call. The call is for statements that already have been billed. The application identity and token are sent in HTTPS header.

Back to top

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getBillingStatementsRequest xmlns="http://www.ebay.com/marketplace/services">
  <subscriptionId> long </subscriptionId>
</getBillingStatementsRequest>

Back to top

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getBillingStatementsResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <statement> BillingStatement
    <adjustmentTotal currencyId="string"> Amount (double) </adjustmentTotal>
    <balanceDue currencyId="string"> Amount (double) </balanceDue>
    <closedTime> dateTime </closedTime>
    <newChargeTotal currencyId="string"> Amount (double) </newChargeTotal>
    <newCreditTotal currencyId="string"> Amount (double) </newCreditTotal>
    <paymentTotal currencyId="string"> Amount (double) </paymentTotal>
    <statementId> string </statementId>
    <statementTime> dateTime </statementTime>
    <statementTotal currencyId="string"> Amount (double) </statementTotal>
  </statement>
  <!-- ... more statement nodes here ... -->
</getBillingStatementsResponse>

Back to top

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Requests billing statements for a specified subscription ID.

Description

Demonstrates how to request billing statements for a specified subscription ID. After statements are retrieved, you can get records for a statement by specifying the statement ID in a getBillingRecords call.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<getBillingStatementsRequest xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
  <subscriptionId>5330007258</subscriptionId>
</getBillingStatementsRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<getBillingStatementsResponse xmlns:ms="http://www.ebay.com/marketplace/services" xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2010-02-28T02:02:10.126Z</timestamp>
  <statement>
    <statementId>6785808:1</statementId>
    <statementTime>2009-12-10T07:00:00.000Z</statementTime>
    <closedTime>2009-12-10T04:56:50.000Z</closedTime>
    <statementTotal currencyId="USD">99.98</statementTotal>
    <adjustmentTotal currencyId="USD">0.0</adjustmentTotal>
    <paymentTotal currencyId="USD">-99.98</paymentTotal>
    <newChargeTotal currencyId="USD">99.98</newChargeTotal>
    <newCreditTotal currencyId="USD">0.0</newCreditTotal>
    <balanceDue currencyId="USD">0.0</balanceDue>
  </statement>
</getBillingStatementsResponse>

Back to top

Back to top

© 2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.