Requests the version of the service.

Returns the version of the service.

Container for available types of charges that your application's subscribers can incur. The subscription is on a free trial. Non-recurring charge (one-time subscription fee). 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. For this kind of charge originating from the addUsage call, a manual credit is needed for a desired adjustment. Recurring charge for a plan when the plan charges are to be pro-rated at the end of subscription. Not applicable for usage. A charge 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 types of transactions that can be contained in billing records. Indicates that the billing record represents a recurring subscription charge. Pre-defined in the billing plan (not ever applied through the addUsage call). Indicates that the billing record represents a one-time subscription charge or a setup fee. Equivalent to NRC (non-recurring charge). Pre- defined in the billing plan (not ever applied through the addUsage call). Indicates just that the charge in the billing record was applied by the addUsage call. Indicates that the billing record represents a statement. Pre-defined in the billing plan (not ever applied through the addUsage call). Indicates that the billing record represents a refund of charges that the user has paid after cancellation date. This might apply, for example, to a user who is subscribed to a plan that is prorated, who has been billed in advance for a month and who unsubscribes before the end of that month. Credits can be added manually or system-generated upon subscription cancellation. Indicates that the billing record represents a credit for one-time subscription fee or setup fee. Indicates that the billing record represents a credit for usage charge. Indicates that the billing record represents an account-level credit statement for the user. Indicates that the billing record represents a reversal of a CreditUsageCharge, a CreditOneTimeCharge, or a CreditSubscriptionCharge. Indicates that the billing record represents a payment reversal, which records that a regularly scheduled payment has failed. A payment reversal and a payment will both appear on the user's account. Indicates that the billing record represents a payment refund, in which money has been refunded to the user's PayPal account. Indicates that the billing record represents all transactions related to payment like reversal and refund and not just payment. Reserved for future use. When discounts are introduced, a discount, such as 10% off a subscription charge or 100% of for a month or $10 for the first 3 months, will be calculated at bill processing time. Indicates that the billing record represents all types of credit such as CreditSubscriptionCharge, CreditOneTimeCharge, CreditUsageCharge, CreditStatement, CreditReversal. Indicates that the billing record represents all types of charges such as SubscriptionCharge, OneTimeCharge, UsageCharge. Indicates that the billing record represents all transactions in the statement. The format of the statement image after your application has successfully converted it. After your application uncompresses the base64 data, your application must convert it to text/html format. Indicates that the format of the image is text/html. The data for the billing statement generally is returned as compressed. If the value of imageCompressionType field is other than none, your application must uncompress the data. Indicates that the billing statement image is uncompressed. Indicates that the billing statement image is gzip-compressed. Container for the statement image and data about the image. getBillingStatementImage Conditionally Contains the image of a billing statement. The image is base64-encoded and usually compressed. getBillingStatementImage Conditionally The format of the statement image after your application has decompressed it and then decoded it from the base64 format. getBillingStatementImage Conditionally The type of compression, generally the gzip type of compression. The data for the billing statement usually is returned as gzip-compressed. getBillingStatementImage Conditionally Container for details about a billing statement. Unique identifier for a billing statement, created at statement-time. 256 getBillingStatements Always Time a statement was generated. Subscribers see the date only. getBillingStatements Always Time at which full payment was made. Note that a payment reversal can reopen a statement. getBillingStatements Always Previous statement balance, plus new charges (RC, NRC, Usage, Prebill Usage Adjustments, Discounts, Unit Credits and Taxes) and payments. This value doesn't change after statement creation. getBillingStatements Always Net adjustments (credits) applied to this statement. Varies, depending on credits applied. These are post-bill adjustments only. 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). The newChargeTotal minus the adjustmentTotal lets you know the available balance to credit for the statement. This value doesn't change after statement creation. getBillingStatements Always Total new negative charges for a statement. Includes pre-billed adjustments. Not changed after statement creation. getBillingStatements Always Sum of the new charges, plus adjustments, plus payments. getBillingStatements Always Container for details about a usage charged to a subscriber. For a particular application, the subscriptionId uniquely identifies a user's subscription and the plan ID. addUsage Yes Reserved for future use. The transaction date assigned to the transaction by the application. addUsage Yes The transaction reference number assigned by the third party developer. 10 addUsage Yes Memo that will be visible on the subscriber statement. 60 addUsage Yes Amount that eBay will display, as a charge, to the subscriber, on behalf of your application. The charge amount must have two or fewer digits after the decimal point and 12 or fewer digits before the decimal point. addUsage Yes Identifier of the charge. Free, FreeTrial, NRCSetup, RecurringProRateEnd addUsage Yes Set to true when you require immediate payment for the charge type. Not available if the subscription is cancelled. addUsage No false Adds charges for a subscriber, including some nonusage types of charges, e.g. a monthly subscription fee. Also can be used after a subscription is cancelled. Available whether or not the subscriber is on a free trial. See the usage.chargeType input field for the ways the call can be used. The App ID and the EIDP token are sent in the HTTPS header.

Adds charges for a subscriber, including some nonusage types of charges, e.g. a monthly subscription fee.

Container for information about the charge for which the subscriber will be billed. addUsage Yes Response container for the addUsage operation. An ID assigned to the transaction. Store this for reference, because this value is displayed on the user's statement. addUsage Always 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.

Retrieves all available billing statements for a subscriber.

For a particular application, the subscriptionId uniquely identifies a user's subscription. getBillingStatements Yes Response container for the getBillingStatements operation. Billing statement details. getBillingStatements Conditionally Retrieves the detailed billing records associated with a subscriber's account. The call is for records already billed. The getBillingRecords call is used after you have used getBillingStatements to retrieve a statementId. The application identity and token are sent in HTTPS header.

Retrieves detailed billing records associated with a subscriber's account. The getBillingRecords call is used after you have used getBillingStatements to retrieve a statementId.

For a particular application, the subscriptionId uniquely identifies a user's subscription. getBillingRecords Yes Specifies whether the record is a one-time charge, a statement, a subscription charge, or a usage charge. getBillingRecords No Unique identifier for a billing statement, created by eBay at statement time. Obtain this value from the response to the getBillingStatements request. 256 getBillingRecords No Requested time range for records. getBillingRecords No Response container for the getBillingRecords operation. Transaction record for a billing account. getBillingRecords Conditionally Advances the billing start date for a subscription 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. For more information, see the Users Guide. Set, for example, seven days after the start of the free trial period. The App ID and the EIDP token are sent in the HTTPS header.

Advances the billing start date for a subscription when a subscriber wants to upgrade to a full subscription before the end of the free trial period.

For a particular application, the subscriptionId uniquely identifies a user's subscription. setBillingStartDate Yes Date from which a subscription begins to incur subscription charges. setBillingStartDate Yes Indicates whether the call was successful. Requests a change in the subscription state of a user. The App ID and the EIDP token are sent in the HTTPS header.

Requests a change in the subscription state of a user.

For a particular application, the subscriptionId uniquely identifies a user's subscription and billing plan. setSubscriptionState Yes The new state of the user's subscription. CancelledPending, Created setSubscriptionState Yes Reason for the change in the subscription state of the user. setSubscriptionState Yes Whether the subscription should immediately be cancelled. For more information on cancelling a subscription, see the Managed Billing Platform Guide. Only can apply if the subscription state is set to cancelled and the plan is non-prorated-at-end. setSubscriptionState No Indicates whether the call was successful. Returns a list of subscription plans, including details, for the application making the request. Filterable by plan state.

Returns a list of subscription plans, including details, for the application making the request.

Filters response by specifying the state of plans to be returned. getSubscriptionPlans No Response container for getSubscriptionPlans operation in the application integration service. Information about a subscription plan. getSubscriptionPlans Always Returns information about an application's subscribers. The application identity and token are sent in the HTTPS header.

Returns information about an application's subscribers.

The eBay user ID of the subscriber. If the output selector is SubscriptionHistory, then this field is required. getSubscribers No Specifies the subscription state of the subscribers to be returned. getSubscribers No Specifies the start of a time range for filtering the subscribers to be returned. getSubscribers No Specifies the end of a time range for filtering the subscribers to be returned. getSubscribers No Specify a value of SubscriberCount in this field if you want to get a count of subscribers. Specify a value of SubscriptionHistory in this field if you want to get subscribers's history. If you specify a value of SubscriptionHistory, you must specify the user name(s) in the request. getSubscribers No Controls the pagination of the result set. getSubscribers No Response container for the getSubscribers call. Not returned if the output selector is set to SubscriptionHistory. getSubscribers Conditionally Information about the subscriber and subscription history. getSubscribers Conditionally The page number of the response data, the number of entries, etc. getSubscribers Always Container for information about a subscriber. The user ID of the eBay member. getSubscribers Conditionally Details about the subscription. getSubscribers Conditionally Details about the subscription history. getSubscribers Conditionally Container for a subscription in the subscription history. Information about one of the subscriptions in the subscriber's history with the application. getSubscribers Conditionally In the case of getSubscribers, you can specify an output selector of SubscriptionHistory or of SubscriberCount. If you specify an output selector of SubscriptionHistory, then you must include the user name of the user whose history you are retrieving. getSubscribers No Use this value if you want to get a count of subscribers. Use this value if you want to get subscribers' history. If you specify a value of SubscriptionHistory, you must specify the user name(s) in the request. Defines possible subscription states. Used in getSubscribers to filter by subscription state. For internal use. The subscription has been created and is not yet active. The user is actively subscribed to the application. Suspended state, possibly due to a payment failure or past due account. There is a block (which can be removed) on the user's access to the application. The user cannot start the application. User is no longer subscribed to the application. When a user clicks the "unsubscribe" link to unsubscribe from your non-prorated plan, eBay sends an updateSubscriber call to your application with the the subscription end date in the note field. The subscriptionStateChangeInfo.newState field may still be Active, but the user's status in in your Active Subscribers list will be CancelledPending. If you want to cancel the user's subscription immediately, use the control in the embedded applications tab in your My Account page as follows. In the embedded applications tab, select Active Users, and search for the user. Pull down the Status selection list, select Cancel Immediately, and then click Submit. One of the following has occurred: your application rejected the subscription after receiving an addSubscriber call, or you have manually changed the subscription to the rejected state. When a user clicks the "unsubscribe" link to unsubscribe from your non-prorated plan, eBay sends an updateSubscriber call to your application with the the subscription end date in the note field. The subscriptionStateChangeInfo.newState field may still be Active, but the user's status in in your Active Subscribers list will be CancelledPending. If you want to cancel the user's subscription immediately, use the control in the embedded applications tab in your My Account page as follows. In the embedded applications tab, select Active Users, and search for the user. Pull down the Status selection list, select Cancel Immediately, and then click Submit. The user's free trial period has elapsed. Defines possible subscription plan lifecycle states. Plan has been created. With a plan in this state you can test how it displays in the subscription flow, and subscribe to the plan without incurring charges. You can also continue to make changes to the plan. A plan in this state has been submitted for approval and is being tested by eBay. Plans in this state cannot be changed. Applies when eBay begins configuring the plan in the Managed Billing Platform. If the Developers Program finds an error in the information you provided or in the app, you are notified and the plan is placed in a "change requested" state for you to edit. Please note: When a plan is in a "non-active" state (stored, submitted for configuration, pending, or change requested), the plan is treated as private, meaning that only users specified in the Permission tag of the deployment descriptor can view the plan. Plans in this state cannot be changed. For future use. The plan is subscribable. The plan can remain hidden from the public in the active state, during final verification. Container for information about a subscription plan. getSubscriptionPlans Always ID assigned to the subscription plan by eBay. getSubscriptionPlans Always A developer-assigned value identifying the plan. Also passed in the externalPlanID field of the addSubscriber call. getSubscriptionPlans Always Defined in the billing plan, the planName accompanies the application name in statements sent to subscribers. getSubscriptionPlans Always Corresponds to the site ID. For example, EBAY-US. getSubscriptionPlans Always Specifies whether the plan is free to subscribers, or must be paid for. getSubscriptionPlans Always If true, the plan is visible to all users, on the condition that the start date is in the past (because users never see a plan with a start date that is in the future). If false, visible only to you and eBay administrators. getSubscriptionPlans Always Information about the version that eBay assigned to a subscription plan. getSubscriptionPlans Always Container for information about a user's subscription to a subscription plan. getSubscribers Always Identifies a user's subscription to a billing plan offered by an Open eBay app. getSubscribers Always Identifies the plan to which the user is subscribed. getSubscribers Always A developer-assigned Plan ID that will be passed in the externalID field of the addSubscriber call to notify you of a new subscription. getSubscribers Always Identifies the state of the subscription. getSubscribers Always The reason for the subscription state. getSubscribers Conditionally Information about a subscriber's eligibility for a free trial. getSubscribers Conditionally The date when the user subscribed to the plan, e.g. the start of the free trial. getSubscribers Always End date of the user's subscription. Specifically, the endDate is the date on which the subscription actually ends. That is, for a prorated-at-end plan, it is the date when the user unsubscribed. (For prorated-at-end plans, the cancel and end dates are the same.) For a nonprorated-at-end plan, it is the date of the term end. getSubscribers Conditionally Start date of the user's term for purposes of billing. getSubscribers Conditionally The date when the user submitted a cancel request getSubscribers Conditionally Reserved for future use. Container for information about the version that the third-party developer assigned to a subscription plan. getSubscriptionPlans Always The ID of the entire version of the plan, at the plan level. getSubscriptionPlans Always The version number of the plan. When the third-party developer submits updates to the plan, eBay increments the version of the plan. getSubscriptionPlans Always Information about the plan that is displayed to potential subscribers in the subscription flow. getSubscriptionPlans Always State of the plan, e.g. Active. getSubscriptionPlans Always Start time of the plan version. getSubscriptionPlans Always End time of the plan version. getSubscriptionPlans Conditionally Details about this version of the plan. getSubscriptionPlans Always Container for reasons for subscription states. Subscription is pending an OEPI response. eBay has made the corresponding OEPI call to your application's listener but has not received a response, or has received a response with a Pending status. Or eBay has not yet made the OEPI call. Subscription is pending on eBay internal billing processing. User has been billed, and a payment failure has occurred. The subscription is still active. User will be suspended by eBay if the account balance is greater than one dollar and more than 18 days have elapsed since the last billing statement. eBay will cancel the subscription at 22 days after the last billing statement. Developer has suspended the subscription. eBay has suspended the subscription, possibly because of a payment failure and an account past due. User can not use the application until the subscription state returns to Active. After the user brings the account current, the subscription's transition back to the Active state takes about five minutes. Following the suspension of a past due subscription, if the account remains unpaid, eBay will put the subscription in the AccountNotPaidInTime state and cancel the the subscription. Account has been cancelled by developer. User has cancelled the subscription. If this occurs during the free trial period, the subscription is cancelled immediately. If the user requests immediate cancellation from a paid subscription, see Cancel Immediately in the Managed Billing Platform Guide for steps you should take. eBay has cancelled the subscription, possibly because the account remained unpaid for 22 days following a billing statement. Developer has declined to accept the subscription. eBay has declined to accept the subscription. Contains information about a subscriber's eligibility for a free trial. The subscription is not eligible for a free trial, probably because the user has previously subscribed to a free trial. The subscription is ineligible for a free trial because the user's token has been revoked. Container for information about a version of a subscription plan. ID for the charge type (there is a charge type of each version of the plan). getSubscriptionPlans Always The type of charge the plan utilizes. Examples: recurring fee, usage fee, and non-recurring setup fee. getSubscriptionPlans Always Length of the term in charge term units (specifically, see the chargeTermUnit field). For example, if the term unit is month, the chargeTerm value is the number of months. Note that if the plan is a free trial, this field is the number of days. getSubscriptionPlans Conditionally The term unit. Multiply the chargeTerm value by the chargeTermUnit value to arrive at the length of the plan version, as set by the third party developer. getSubscriptionPlans Conditionally The amount of money charged for the plan, as set by the third party developer, based on the charge type. getSubscriptionPlans Conditionally Additional plan information that is displayed on the page where a user views plans, under "Usage Fee." The value in the extendedDescription field is only applicable when information was added with the addUsage call. getSubscriptionPlans Conditionally Applied with addUsage, for the charge type. getSubscriptionPlans Conditionally For recurring charges, defines the unit of time for which a user is charged. Charge recurs daily. Only applies to a free trial. Charge recurs monthly. Charge recurs weekly. Charge recurs quarterly. Charge is annual. Container for attributes that identify the amounts in a billing record. When RecordAmount has this attribute, amount represents the amount charged in the biller's currency. When RecordAmount has this attribute, amount represents the amount charged in the subscriber's currency. When RecordAmount has this attribute, amount represents 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. When RecordAmount has this attribute, amount represents the amount of the tax to two or fewer digits after the decimal point, in the billing currency. When RecordAmount has this attribute, the amount represents the amount credited to the subscriber in a statement, in the subscriber's currency. When RecordAmount has this attribute, the amount represents the payment amount in the subscriber's currency. Monetary amount of the charge, in the subscriber's currency. When RecordAmount has this attribute, the amount represents the value of new charges, in the subscriber's currency. Container for attributes that identify the time values in a billing record. When RecordTime has this attribute, the time specified represents the statement date. When RecordTime has this attribute, the time specified is the timestamp of the transaction. When RecordTime has this attribute, the time specified is the timestamp of the statement creation. When RecordTime has this attribute, the time specified is the beginning of the time range for which the subscriber is being charged. When RecordTime has this attribute, the time specified is the end of the time range for which the subscriber is being charged. When RecordTime has this attribute, the time specified is the timestamp of the transaction. An amount value in a billing record. getBillingRecords Always The type of amount value of a record. getBillingRecords Always A time value in a record. getBillingRecords Always The type of time value of a record. getBillingRecords 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. A unique identifier for each combination of an application and a subscriber. Used for billing-related calls (getBillingStatements, getBillingRecords). Also known as EID. 32 getBillingRecords Always Specifies the type of record. The possible types are one-time charge, statement, subscription charge, and usage charge. In the case of each record type, the values of other fields, such as taxAmount and recordTime, are appropriate to the record type. For example, if the recordType is usage charge, then recordTime represents the transaction date. If recordType is statement, recordTime represents the time of the statement's creation. 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 For this record, specifies whether the fee appeared on the user's statement (i.e., whether it's been billed). getBillingRecords Always Unique identifier for a billing statement, created at statement-time. 256 getBillingRecords Always The recordType determines what this value signifies. If recordType is SubscriptionCharge, recordTime represents the transaction date. If recordType is OneTimeCharge, recordTime represents the time of the transaction. If recordType is UsageCharge, recordTime represents the time of the transaction. If recordType is Statement, recordTime represents the statement date. getBillingRecords Always The recordType determines what this value signifies. If recordType is SubscriptionCharge, 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 UsageCharge, 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 SubscriptionCharge, recordDescription contains a text description of the subscription. If recordType is OneTimeCharge, recordDescription contains a text description of the charge. If recordType is UsageCharge, recordDescription contains a text description of the usage. If recordType is Statement, recordDescription contains a text description of the statement. 1024 getBillingRecords Always Allows additional description for the record. 1024 getBillingRecords Conditionally True if the transaction can be credited. Only applicable to one-time charges and setup fees. getBillingRecords Always Retrieves the image of a billing statement. After you have retrieved an ID of a billing statement using getBillingStatements, you can call getBillingStatementImage to retrieve the image of the billing statement. The image is base64-encoded. The image is of a single billing statement of a user who is subscribed to your application. In your getBillingStatementImage call, you specify a subscription ID and the ID of the statement whose image you want to retrieve. Depending on the value returned in the statementImage.imageCompressionType field, your application may or may not need to uncompress the base64 data. Your application must convert the base64 data into text format. The end-result is a text file containing the HTML for the billing statement you specified in the request. If the statementImageMessage field is returned, that field will contain text about a problem that has occurred in the retrieval of the billing statement image.

Retrieves the image of a billing statement.

Unique identifier for a user's subscription. getBillingStatementImage Yes Unique identifier for a billing statement. You can obtain this value using the getBillingStatements call. 256 getBillingStatementImage Yes Response container for the getBillingStatementImage call. The image of a billing statement. The image is base64-encoded. The image is of a single billing statement of a user who is subscribed to your application. Your application must uncompress the base64 data and then convert the base64 data into text format. The end-result will be a text file containing the HTML for the billing statement you specified in the request. getBillingStatementImage Conditionally This message about the billing statement image is returned only if a problem has occurred in the retrieval of the billing statement image. The following problems can prevent an image from being returned: The image may not be available, or the image may be too large. If image is too large, only the first page will be returned (or, in some cases, no pages will be returned). getBillingStatementImage Conditionally Container for types of credits that can be contained in credit records. Indicates that the credit record represents a refund of charges that the user has paid after cancellation date. This might apply, for example, to a user who is subscribed to a plan that is prorated, who has been billed in advance for a month and who unsubscribes before the end of that month. Credits can be added manually or system-generated upon subscription cancellation. Indicates that the credit record represents a credit so a subscriber for a one-time subscription fee or setup fee. Indicates that the credit record represents a credit to a subscriber for a usage charge. Indicates that the billing record represents an account-level credit statement for the user. Requests the application of a credit to a subscriber's account. Use this operation to issue credits to your users so that account balances reflect credits issued.

Requests the application of a credit to a subscriber's account.

For a particular application, the subscriptionId uniquely identifies a user's subscription. addCredit Yes Possible values are CreditSubscriptionCharge,CreditOneTimeCharge,CreditUsageCharge and CreditStatement. 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 statement date is applicable only for the CreditSubscriptionCharge creditRecordType. addCredit Yes Specifies the amount you want to credit. The amount credited may differ, for example if a partial credit has already been applied. addCredit Yes Explains why the credit has been applied to the subscriber's account.Possible values: 100 - Courtesy 101 - Non-payment 102 - Test account 103 - Bugs 104 - Pricing issue 105 - Site outage: eBay site outage 106 - Site outage: app site outage 107 - Promo: general addCredit Yes Date on which the credit is requested. addCredit Yes The eBay user ID of the subscriber. 32 addCredit Yes A description of the credit applied to the subscriber's account, which will appear in the user's View Account Status. 270 addCredit Yes Identifier for the request, assigned by the app. The app should supply a unique externalCreditId for each request. addCredit Yes Returns the disposition of the AddCredit request. Unique identifier assigned to the credit request by eBay. addCredit Conditionally Actual amount credited. This value might be equal or less than the original amount. addCredit Conditionally Makes a refund for a subscriber's payment. To use this call, you first must give eBay permission to make refunds on your behalf. You can give this permission with the help of an eBay account manager. Otherwise, the call fails. The addRefund call applies for a payment for which the getBillingRecords call returned the recordType value as Payment. If a refund is made, the refund will be reflected on the subscriber's billing account. In addRefund, specify the transactionId value as the value that was returned in the record.recordId field of the getBillingRecords call (for the payment). To use addRefund, the associated charges must have been credited, e.g. due to automatic crediting by eBay, or due to a credit made with the addCredit call. Thus, for the refund to occur, there must be an existing credit balance. The addRefund call is generally used only for active accounts, but can be used in other situations as well. Note that by December 2010, eBay will automatically refund all cancelled subscriptions.

Makes a refund for a subscriber's payment.

For a particular application, the subscription ID uniquely identifies a user's subscription. addRefund Yes Specify the transactionId value as the value that was returned in the record.recordId field of the getBillingRecords call, if the getBillingRecords call returned the the recordType value as Payment. 256 addRefund Yes Amount, in the billing currency, of the refund requested for the subscriber's account. addRefund Yes The refund date, provided by the third-party developer. Analogous to the usage.chargeTime value provided by the third-party developer in the addUsage call. addRefund Yes A name for the subscriber that is identifiable by the third-party developer. 30 addRefund Yes Text to display to the subscriber, about the refund. 270 addRefund Yes A reference number provided by the third-party developer. Helps to prevent duplicate requests. Analogous to the usage.externalChargeId value provided by the third-party developer in the addUsage call. 10 addRefund Yes Response to an addRefund request. Unique identifier assigned to the refund request. addRefund Conditionally Amount of the refund request. addRefund Conditionally Retrieves records of refunds. You can request refunds for a subscription ID, or you can specify a transaction ID (in this case, a refundId value returned in an addRefund response). If you do not specify a transaction ID (a refundId returned by addRefund) or a subscription ID, the set of refunds that applies to your subscribers is returned. You also can specify a time range.

Retrieves the status of refunds, based on the criteria specified.

The time range for the retrieval of records. If no time range is specified, the last six months of data is returned. getRefundStatus No For a particular application, the subscription ID uniquely identifies a user's subscription. getRefundStatus No The refundId value that is returned in the addRefund response. 256 getRefundStatus No Response to a request for refund status. Container for information about a refund. getRefundStatus Conditionally Container for information about the refund that applies to a transaction (record). This refund status is one of the following: Submitted, Pending, Processed, or Failed. getRefundStatus Conditionally An error code that applies to the refund. The error code can be 2509 (refund rejected), 2510 (refund amount is greater than any of the payments), or 2511 (timeout error). getRefundStatus Conditionally This value is either "S" (for "service") or B (for "batch"). "Service" means initiated by a third-party developer, or initiated manually. "Batch" applies in other cases, e.g. if a subscription was cancelled, and as a result, a refund was made. getRefundStatus Conditionally For a particular application, the subscriptionId uniquely identifies a user's subscription. getRefundStatus Conditionally The refund ID that is returned in the addRefund response. 256 getRefundStatus Conditionally Amount of the refund for the transaction. getRefundStatus Conditionally Date of the refund request. getRefundStatus Conditionally 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 getBillingStatements getBillingRecords Always getRefundStatus Conditionally Container for time ranges. getSubscribers getBillingRecords getRefundStatus No Specifies the earliest (oldest) date to be used in a date range. getSubscribers getBillingRecords getRefundStatus No Specifies the latest (most recent) date to be used in a date range. addUsage Yes getSubscribers getBillingRecords getRefundStatus No This is the base class for request container for all service operations. Base response container for all service operations. Contains error information associated with the request. Indicates whether or not errors or warnings were generated during the processing of the request. Always Information for an error or warning that occurred when eBay processed the request. Conditionally The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Always This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Always Documentation goes here 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. This type is used to represent a combination of site and Locale. Locales are combination of language and territory. Some territories have a default language. Others can have more than one language and there might not be a default one. Example: EBAY-US indicates language English in territory U.S. EBAY-ENCA indicates language en_US in territory Canada. EBAY-FRCA indicates language en_FR in territory Canada. Accepted values are use case specific. The syntax is: ebay_properties '-' site ('_' variant)? where ? emans optional. Example for ebay_properties are: EBAY, AC, SDC, PP etc site is not just limited to country language. We actually have MOTOR. The only use of variant for now is OLD for depreciated sites. The page number and the entries per page. getSubscribers No Specifies the number of the page of data to return in the current call. getSubscribers No Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. getSubscribers No The pagination response data. The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. getSubscribers Always The total number of entries. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. getSubscribers Always The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of entries divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data. This returned value indicates the page number of data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire set of data. The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of data in the set of data, and the value for pageNumber is set to the respective (last) page number. getSubscribers Always The maximum number of entries that can be returned in the response. This number is always equal to the value that you specified for paginationInput.entriesPerPage. The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of entries found on the specified pageNumber. In this case, there will be fewer entries returned than the number specified in entriesPerPage. getSubscribers Always 1.2.0