Basic type for specifying monetary amounts. A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An Amount expresses both the value (a double) and the currency. Details such as prices, fees, costs, and payments are specified as amount types. Currency in which the monetary amount is specified. A three-letter ID, such as USD, CAD, DEM. Currently, USD is the only available value. addUsage Yes Container for time ranges. Specifies the earliest (oldest) date to be used in a date range. getBillingRecords addUsage Yes getCredits No Specifies the latest (most recent) date to be used in a date range. getBillingRecords addUsage Yes getCredits No Base response container for all service operations. Base response container for all service operations. Contains error information associated with the request. Indicates whether there are any errors or warnings associated with the processing of the request. Always Information for an error or warning that occurred when eBay processed the request. Conditionally Open eBay version. 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. Always Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. The request was processed successfully, but something occurred that may affect your application or the user. 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. The request that triggered the error was processed successfully but with some warnings. The request that triggered the error was processed successfully but with some warnings. ErrorMessage to indicate any Error/Warning occured as part of service call. Any run time error will not be reported here, but will be reported aspart of soap fault. ActivityProfile about a single error. Conditionally This represents error details. 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. Conditionally Name of the domain upon which the error occurred. <dl> <lh>Domains include:</lh> <dt> Marketplace </dt> <dd> A business or validation error occurred for the UserProfile Service. </dd> <dt> SOA </dt> <dd> An exception occurred in the Service Oriented Architecture (SOA) framework. </dd> </dl> 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that resulted in the error. 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). Conditionally Unique identifier for an exception associated with an error. Conditionally 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. Conditionally Contextual information associated with an error. The name of the parameter in the list of parameter types returned within the error type. Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. 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. 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. There are three categories of error: request errors, application errors, and system errors. Request and application errors are caused primarily by invalid data passed in the request. System errors are caused primarily by application failures and cannot be corrected by changing request values. 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. 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. 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. Container for available types of charges that your application's subscribers can incur. The subscription is on a free trial basis. Non-recurring charge. Non-recurring setup charge. Recurring charge for a plan when the plan charges are not to be pro-rated at the end of subscription. Not applicable for usage. Recurring charge for a plan when the plan charges are to be pro-rated at the end of subscription. Not applicable for usage. Indicates a plan for which the subscriber will pay usage charges. A free plan that will not have usage or other charges. Billable charge that is not included in the plan and is not subject to eBay service fee. For example, shipping charges. Container for details about the type of billing record. Indicates that the current billing record represents a charge for a subscription. Indicates that the current billing record represents a one-time charge. Indicates that the current billing record represents a usage charge. Indicates that the current billing record represents a statement. Container for the state of the credit. Indicates that the credit has been submitted. Indicates that the credit transaction is pending. Indicates that the credit transaction has been processed. Indicates that the credit transaction has failed to be processed. Container for explanation of the credit. Explains why the credit has been applied to the subscriber's account. Container for details about a billing statement. Unique identifier for a billing statement, created by eBay at statement time. 256 getBillingStatements Always Time a statement was generated. Subscribers will see the date only. getBillingStatements Always Time at which full payment was made. getBillingStatements Always Previous statement balance, plus new charges (RC, NRC, Usage, Prebill Usage Adjustments, Discounts, Unit Credits and Taxes) and payments. getBillingStatements Always Net adjustments applied to this statement. These are post-bill adjustments only. A negative value denotes a credit and a positive value denotes a debit. Changes such as payments or adjustments are made against statements. getBillingStatements Always Total payments already applied to the statement. getBillingStatements Always Total new charges (combination of postitive and negative charges). newChargeTotal minus adjustmentTotal lets you know the available balance to credit for the statement. getBillingStatements Always Total new negative charges for statement. Includes pre-billed adjustments. Not changed after statement creation. getBillingStatements Always Sum of of new charges plus adjustments plus payments. getBillingStatements Always Container for details about a billing record. For future use: amounts can be in the biller's currency, that is, in the currency in which your third-party application will be paid, or it can be in the user's currency, if different. Currently the only currency available is the U.S. dollar. Identifies a combination of application and subscriber. Also known as EID. 32 getBillingRecords 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. getBillingRecords 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. 256 getBillingRecords Always Specifies whether or not a statement has been presented to the subscriber for the record. getBillingRecords Always Unique identifier for a billing statement, created by eBay at statement time. 256 getBillingRecords 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. getBillingRecords 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. getBillingRecords 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. getBillingRecords 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. getBillingRecords Always 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. getBillingRecords 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. getBillingRecords Conditionally 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 Always 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. 1024 getCredits getBillingRecords Conditionally addCredit No Returns true if adjustments such as discounts, credits, and usage can be applied to the record. getBillingRecords Conditionally Container for details about a credit given to a subscriber. Unique identifier assigned to the credit request by eBay. getCredits Conditionally The eBay user ID of the subscriber. getCredits Conditionally Total amount of the credit applied to the subscriber's account. getCredits Conditionally The date assigned to the credit request by the application. getCredits Conditionally A unique identifier for a credit. getCredits Conditionally Explains why the credit has been applied to the subscriber's account. getCredits Conditionally Describes the credit applied to the subscriber's account. 1024 getCredits Conditionally A unique identifier for each combination of an application and a subscriber. 32 getCredits Conditionally Unique identifier for the billing statement in which the credit was applied to the subscriber's account, created by eBay at statement time. 256 getCredits Conditionally 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. getCredits Conditionally 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. 256 getCredits Conditionally The recordType determines what this value signifies. If recordType is Subscription, recordTime represents the statement date. If recordType is OneTimeCharge, recordTime represents the time of the transaction. If recordType is Usage, recordTime represents the time of the transaction. If recordType is Statement, recordTime represents the statement time. getCredits Conditionally The recordType determines what this value signifies. If recordType is Subscription, amount2 represents the credit amount in the billing currency. If recordType is OneTimeCharge, amount2 represents the the credit amount in the billing currency. If recordType is Usage, amount2 represents the credit amount in the billing currency. If recordType is Statement, amount2 represents the statement total. getCredits 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. getCredits Conditionally Time the credit was processed by eBay. getCredits Conditionally The lifecycle state of the credit can be submitted, pending, processed, or failed. getCredits Conditionally When a credit is manually processed, may include a note from eBay to the application such as, "Your credit request was processed successfully." getCredits Conditionally 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 reports usage for which the subscriber is to be billed. The application identity and token are sent in the HTTPS header.

Use the Open eBay Subscription service instead. Reports a charge.

Use the Open eBay Subscription service instead. Retrieves billing statements.

Use the Open eBay Subscription service instead. Retrieves detailed billing records. Used with the getBillingStatements request.

This call is reserved for future use.

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. addCredit Yes For a particular application, the subscriptionId uniquely identifies a user's subscription. addCredit Yes The eBay user ID of the subscriber. addCredit Yes Amount to be credited to the subscriber. The amount is in the billing currency (the currency specified in the original charge). addCredit Yes The date assigned to the credit request by the application. addCredit Yes A transaction reference number that you can assign to the credit. This number will be returned in the getCredit response. addCredit Yes Explains why the credit has been applied to the subscriber's account. addCredit Yes Describes the credit applied to the subscriber's account. 1024 addCredit Yes A unique identifier for each combination of an application and a subscriber. 32 addCredit Yes Unique identifier for a billing statement, created by eBay at statement time. Returned in the getBillingRecords response. 256 addCredit Yes 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. Returned in the getBillingRecords response. addCredit Yes 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. Returned in the getBillingRecords response. 256 addCredit Yes The recordType determines what this value signifies. Returned in the getBillingRecords response. If recordType is Subscription, recordTime represents the beginning of the time range, the time from, that ends at the time to given in recordTime2. If recordType is OneTimeCharge, recordTime represents the time of the transaction. If recordType is Usage, recordTime represents the time of the transaction. If recordType is Statement, recordTime represents the statement time. addCredit Yes The recordType determines what this value signifies. Returned in the getBillingRecords response. eBay uses this value to ensure that the credit is matched to the correct original charge. If recordType is Subscription, amount2 represents the subscription amount, in the billing currency, against which the credit is to be applied. If recordType is OneTimeCharge, amount2 represents the charge amount, in the billing currency, against which the credit is to be applied. If recordType is Usage, amount2 represents the amount of the usage charge, in the billing currency, against which the credit is to be applied. If recordType is Statement, amount2 represents the statement total, in the billing currency, against which the credit is to be applied. addCredit Yes The recordType determines what this value signifies. Returned in the getBillingRecords response. 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. addCredit No Reserved for future use. Unique identifier assigned to the credit request by eBay. addCredit Conditionally This call is reserved for future use.

This call is reserved for future use.

The eBay user ID of the subscriber. getCredits No Unique identifier assigned to the credit request by eBay. getCredits Yes The lifecycle state of the credit can be submitted, pending, processed, or failed. getCredits No Time range filter for the requested credits. getCredits No Reserved for future use. Details about the requested credits. getCredits Conditionally 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 advances the billing start date for a subscription. The call is used when a subscriber wants to upgrade to a full subscription before the end of the free trial period. Use this request during the free trial period, between the subscription start date and the billing start date. Set, for example, seven days after the start of the free trial period. The application identity and token are sent in HTTPS header.

Use the Open eBay Subscription service instead. Advances the billing start date for a subscription.