Sign in
Admin

Get payment events list with pagination and filters

Retrieve a paginated list of payment events with optional filtering by user, notification type, subtype, and currency. Amounts are calculated as positive for income and negative for expenses.

get/admin/payment-events

Query parameters

pagenumber
Example:1

Page number (default: 1)

limitnumber
Example:10

Number of items per page (default: 10)

userIdstring
Example:user-uuid-here

Filter by user ID

firebaseUserIdstring
Example:firebase-uid-here

Filter by Firebase user ID

notificationType'SUBSCRIBED' | 'DID_CHANGE_RENEWAL_PREF' | 'DID_CHANGE_RENEWAL_STATUS' | 'OFFER_REDEEMED' | 'DID_RENEW' | 'EXPIRED' | 'DID_FAIL_TO_RENEW' | 'GRACE_PERIOD_EXPIRED' | 'PRICE_INCREASE' | 'REFUND' | 'REFUND_DECLINED' | 'CONSUMPTION_REQUEST' | 'RENEWAL_EXTENDED' | 'REVOKE' | 'TEST' | 'RENEWAL_EXTENSION' | 'REFUND_REVERSED' | 'EXTERNAL_PURCHASE_TOKEN' | 'ONE_TIME_CHARGE'
Example:SUBSCRIBED

Filter by notification type

subtype'INITIAL_BUY' | 'RESUBSCRIBE' | 'DOWNGRADE' | 'UPGRADE' | 'AUTO_RENEW_ENABLED' | 'AUTO_RENEW_DISABLED' | 'VOLUNTARY' | 'BILLING_RETRY' | 'PRICE_INCREASE' | 'GRACE_PERIOD' | 'PENDING' | 'ACCEPTED' | 'BILLING_RECOVERY' | 'PRODUCT_NOT_FOR_SALE' | 'SUMMARY' | 'FAILURE' | 'UNREPORTED'
Example:INITIAL_BUY

Filter by subtype

currencystring
Example:USD

Filter by currency

productType'AUTO_RENEWABLE' | 'NON_RENEWABLE' | 'CONSUMABLE' | 'NON_CONSUMABLE'
Example:AUTO_RENEWABLE

Filter by product type

Response

Payment events list retrieved successfully

totalnumber required

Total number of payment events

pagenumber required

Current page number

limitnumber required

Number of items per page

totalPagesnumber required

Total number of pages

Example response

{
  "paymentEvents": [
    {
      "subtype": "INITIAL_BUY",
      "currency": "USD",
      "calculatedAmount": 9.99,
      "isIncome": true,
      "eventName": "Subscription Started",
      "productId": "com.example.premium",
      "purchaseDate": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 10,
  "totalPages": 15
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.