getBillingRecords - Call Reference - Open eBay Application Integration service (deprecated; use the Open eBay Subscription service instead)

getBillingRecords

Use the Open eBay Subscription service instead. For more information, see the Release Notes for the Open eBay Subscription Service. In both services, this call retrieves detailed billing records associated with a subscriber's account. The application identity and token are sent in HTTPS header. Used with the getBillingStatements request, which returns summary billing information.

getBillingRecords Input

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"?>
<getBillingRecordsResponse 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 -->
  <record> OpeneBayBillingRecordType
    <adjustable> boolean </adjustable>
    <amount> Amount (double) </amount>
    <amount2> Amount (double) </amount2>
    <billed> boolean </billed>
    <billingAccountId> string </billingAccountId>
    <discountAmount> Amount (double) </discountAmount>
    <recordDescription> string </recordDescription>
    <recordId> string </recordId>
    <recordTime> dateTime </recordTime>
    <recordTime2> dateTime </recordTime2>
    <recordType> OpeneBayBillingRecordTypeType </recordType>
    <statementId> string </statementId>
    <taxAmount> Amount (double) </taxAmount>
    <taxRate> double </taxRate>
  </record>
  <!-- ... more record nodes here ... -->
</getBillingRecordsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	Indicates whether there are any errors or warnings associated with the processing of the request. Applicable values: • Failure (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) The request that triggered the error was processed successfully but with some warnings. • Success (out) The request was processed successfully, but something occurred that may affect your application or the user. • Warning (out) The request that triggered the error was processed successfully but with some warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	ActivityProfile about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the appilcation or data is resolved, resend the corrected request to eBay. • Request (out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. • System (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain upon which the error occurred. Domains include: Marketplace A business or validation error occurred for the UserProfile Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that resulted in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: • Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain upon which the error occurred. Subdomains include the following: UserProfile (in which the error is specific to the UserProfile service) and MarketplaceCommon (in which the error is common to all Marketplace services).
timestamp	dateTime	Always	The date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version	string	Always	Open eBay version.

Call-specific Output Fields

record	OpeneBayBillingRecordType	Conditionally, repeatable: [0..*]	Billing account transaction record.
record.adjustable	boolean	Conditionally	Returns true if adjustments such as discounts, credits, and usage can be applied to the record.
record.amount	Amount (double)	Always	The recordType determines what this value signifies. If recordType is Subscription, amount represents the total amount due for the subscription to two or fewer digits after the decimal point in the subscriber's currency. If recordType is OneTimeCharge, amount represents the amount of the charge to two or fewer digits after the decimal point in the subscriber's currency. If recordType is Usage, amount represents the total of the usage charge to two or fewer digits after the decimal point in the subscriber's currency. If recordType is Statement, amount represents the amount available to credit at the time of the statement, to two or fewer digits after the decimal point, in the subscriber's currency.
record.amount2	Amount (double)	Always	The recordType determines what this value signifies. If recordType is Subscription, amount2 represents the amount for the subscription in the biller's currency. If recordType is OneTimeCharge, amount2 represents the amount of the charge in the biller's currency. If recordType is Usage, amount2 represents the amount charged for the usage in the biller's currency. If recordType is Statement, amount2 represents the statement total, in the biller's currency.
record.billed	boolean	Always	Specifies whether or not a statement has been presented to the subscriber for the record.
record.billingAccountId	string	Always	Identifies a combination of application and subscriber. Also known as EID. Max length: 32.
record.discountAmount	Amount (double)	Conditionally	The recordType determines what this value signifies. If recordType is Subscription, discountAmount is the amount of a discount applied to the charges in the billing record, to two or fewer digits after the decimal point, in the billing currency. If recordType is OneTimeCharge, discountAmount is the amount of the discount applied to the charges in the billing record, to two or fewer digits after the decimal point, in the billing currency. If recordType is Usage, discountAmount is the amount of the discount applied to the charges in the billing record, to two or fewer digits after the decimal point, in the billing currency. If recordType is Statement, discountAmount is not returned because no further adjustments can be made once the statement has been created.
record.recordDescription	string	Conditionally	The recordType determines what this value signifies. If recordType is Subscription, recordDescription contains a text description of the subscription. If recordType is OneTimeCharge, recordDescription contains a text description of the charge. If recordType is Usage, recordDescription contains a text description of the usage. If recordType is Statement, recordDescription contains a text description of the statement. Max length: 1024.
record.recordId	string	Always	Unique identifier for the record, assigned by eBay. Contains state and location information about the record. An example of a recordId: 1111:222:333:444:x. Retrieve a recordID using getBillingRecords. Max length: 256.
record.recordTime	dateTime	Always	The recordType determines what this value signifies. If recordType is Subscription, recordTime represents the transaction date, equivalent to the statement date. If recordType is OneTimeCharge, recordTime represents the time of the transaction, equivalent to the statement date. If recordType is Usage, recordTime represents the time of the transaction, equivalent to the statement date. If recordType is Statement, recordTime represents the statement date.
record.recordTime2	dateTime	Always	The recordType determines what this value signifies. If recordType is Subscription, recordTime2 represents the beginning of the time range for which the subscriber is being charged. If recordType is OneTimeCharge, recordTime2 represents the effective date of the charge. If recordType is Usage, recordTime2 represents the date the charge was calculated by your application. If recordType is Statement, recordTime2 represents the statement preparation date.
record.recordType	OpeneBayBillingRecordTypeType	Always	Specifies whether the record is a one-time charge, a statement, a subscription charge, or a usage charge. For these four different kinds of records, the values transmitted for other elements, such as taxAmount and recordTime, represent elements appropriate for the record type. For example, for recordTime, if the recordType is Usage then recordTime represents the transaction date; but if recordType is Statement, recordTime represents the time of the statement's creation. See the specific values in each element. Applicable values: • OneTimeCharge (in/out) Indicates that the current billing record represents a one-time charge. • Statement (in/out) Indicates that the current billing record represents a statement. • SubscriptionCharge (in/out) Indicates that the current billing record represents a charge for a subscription. • UsageCharge (in/out) Indicates that the current billing record represents a usage charge.
record.statementId	string	Always	Unique identifier for a billing statement, created by eBay at statement time. Max length: 256.
record.taxAmount	Amount (double)	Conditionally	The recordType determines what this value signifies. If recordType is Subscription, taxAmount is the amount of the tax to two or fewer digits after the decimal point, in the billing currency. If recordType is OneTimeCharge, taxAmount is the amount of the tax to two or fewer digits after the decimal point, in the billing currency. If recordType is Usage, taxAmount is the amount of the tax to two or fewer digits after the decimal point, in the billing currency. If recordType is Statement, taxAmount is the total amount of any tax included in the statement.
record.taxRate	double	Always	Returns zero if no tax rate, or the tax rate. For euros, Luxembourg rate of 15% will be assumed. This field is for future use.

getBillingRecords Samples

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.

Sample: Basic Call

Requests billing records for a specified subscriber and plan and time range.

Description

An application is requesting billing records for a particular subscriber, in the time range between March 1, 2008, and March 1, 2009.

Input

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

<?xml version="1.0" encoding="UTF-8"?>
    <getBillingRecordsRequest xmlns="http://www.ebay.com/marketplace/services">
        <!--You may enter ANY elements at this point-->
        <planId>PlanID</planId>
        <subscriptionId>SubscriptionID</subscriptionId>
        <userName>UserName</userName>
        <recordType>Statement</recordType>
        <statementId>6790208:1</statementId>
        <!--Optional:-->
        <recordTimeRange>
          <!--Optional:-->
          <timeFrom>2008-03-01</timeFrom>
          <!--Optional:-->
          <timeTo>2009-03-01</timeTo>
          <!--You may enter ANY elements at this point-->
        </recordTimeRange>
        </getBillingRecordsRequest>

Output

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

<?xml version="1.0" encoding="UTF-8"?>
    <getBillingRecordsResponse xmlns="http://www.ebay.com/marketplace/services">
        <ack>Success</ack>
        <version>1.2.0</version>
        <timestamp>2009-09-09T06:59:24.939Z</timestamp>
        <record>
            <billingAccountId>160000036114001</billingAccountId>
            <recordType>Statement</recordType>
            <recordId>6790208:1:x:x:x</recordId>
            <billed>true</billed>
            <statementId>6790208:1</statementId>
            <recordTime>2008-04-30T07:00:00.000Z</recordTime>
            <recordTime2>2009-09-04T06:38:38.000Z</recordTime2>
            <amount currencyId="USD">49.99</amount>
            <amount2 currencyId="USD">149.97</amount2>
            <discountAmount currencyId="USD">0.0</discountAmount>
            <taxAmount currencyId="USD">0.0</taxAmount>
            <taxRate>0.0</taxRate>
            <recordDescription>statement</recordDescription>
            <adjustable>true</adjustable>
         </record>
    </getBillingRecordsResponse>

getBillingRecords Change History

Version	Description
1.2.0 2009-09-09	(added) New call

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool.

planId	long	Required	A planId is assigned by eBay to each subscription plan. Your application often uses this value in calls to the Open eBay Application Integration Service. Note that the planId is diffrent from the externalPlanId. In contrast to the planId, the externalPlanId is the value that you provide, as a "Developer Plan ID," when you create a subscription plan.
recordTimeRange	TimeRange	Optional	Requested time range for records.
recordTimeRange.timeFrom	dateTime	Required	Specifies the earliest (oldest) date to be used in a date range.
recordTimeRange.timeTo	dateTime	Required	Specifies the latest (most recent) date to be used in a date range.
recordType	OpeneBayBillingRecordTypeType	Optional	Specifies whether the record is a one-time charge, a statement, a subscription charge, or a usage charge. Applicable values: • OneTimeCharge (in/out) Indicates that the current billing record represents a one-time charge. • Statement (in/out) Indicates that the current billing record represents a statement. • SubscriptionCharge (in/out) Indicates that the current billing record represents a charge for a subscription. • UsageCharge (in/out) Indicates that the current billing record represents a usage charge.
statementId	string	Optional	Unique identifier for a billing statement, created by eBay at statement time. Obtain this value from the response to the getBillingStatements request. Max length: 256.
subscriptionId	long	Required	For a particular application, the subscriptionId uniquely identifies a user's subscription.
userName	string	Required	The eBay user ID of the subscriber.

Open eBay Application Integration (Deprecated) Call Reference Version 1.2.0

Open eBay Application Integration (Deprecated)
Call Reference Version 1.2.0