User Payment History

This endpoint returns all payment transactions (subscription payments and one-time purchases) for a given subscriber.

Use the GET method to query a subscriber, subscriberId is required.

Method	GET
URL	https://api.zotlo.com/v1/transaction?subscriberId=&paymentType=&startDate=&endDate=&packageId=

Request Parameters

Field	Type	Description
subscriberId	Required	The email or phone number used by the user when starting the subscription.
paymentType	Optional	Filters by payment type. Allowed values: subscription, consumable (one-time payments).
startDate	Optional	Should be string (YYYY-MM-DD). Returns payments occurring after this date.
endDate	Optional	Should be string (YYYY-MM-DD). Returns payments occurring before this date.
packageId	Optional	Filters transactions belonging to a specific package.

Sample Request

GET https://api.zotlo.com/v1/transaction?subscriberId=SUBSCRIBER_ID&paymentType=subscription&startDate=2024-01-01&endDate=2024-01-30 HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••

You can find your AccessKey and AccessSecret in the Zotlo Panel under Developer Tools → API Keys

Sending ApplicationId is optional.

Successful Response

{
  "meta": {
    "requestId": "246a8e676214-REQ-659565f64ef8e",
    "httpStatus": 200
  },
  "result": {
    "transactions": [
      {
        "id": 57097,
        "payment_type": "subscription",
        "original_transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
        "transaction_id": "02c88e3a-f358-4adc-9c21-b979fb698e85",
        "provider_transaction_id": "b9b84a68-980e-404b-a705-45e5d327fdba",
        "package_id": "premium",
        "status": "renewal",
        "purchase_date": "2024-01-02 08:24:14",
        "expire_date": "2024-01-30 07:50:34",
        "original_purchase_date": "2023-11-30 07:50:34",
        "price": "49.00",
        "currency": "TRY",
        "country": "TR",
        "provider_name": "Zotlopos",
        "subscriptionId": 8260,
        "refund": null,
        "exchange": {
          "status": false,
          "detail": []
        }
      },
      {
        "id": 55001,
        "payment_type": "subscription",
        "original_transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
        "transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
        "provider_transaction_id": "b793670e-57d1-49df-8dcf-8d14426bd039",
        "package_id": "premium",
        "status": "start_paid",
        "purchase_date": "2023-11-30 07:50:34",
        "expire_date": "2023-12-30 07:50:34",
        "original_purchase_date": "2023-11-30 07:50:34",
        "price": "49.00",
        "currency": "TRY",
        "country": "TR",
        "provider_name": "Zotlo",
        "subscriptionId": 8260,
        "refund": null,
        "exchange": {
          "status": false,
          "detail": []
        }
      }
    ]
  }
}

Key Response Fields

Field	Description
transaction_id	Unique ID of the specific payment attempt.
original_transaction_id	The root transaction ID for the subscription or consumable order. All renewals reference this same ID.
payment_type	Type of payment: • subscription – Subscription payment (start, renewal, trial→paid). • consumable – One-time purchase.
package_id	Identifier of the product or subscription package.
status	Payment status type: • start_paid – First paid subscription purchase • trial – Trial started • trial_to_paid – Trial converted to paid • renewal – Subscription renewed • reactive – Reactivation payment • consumable – One-time purchase
purchase_date	Date and time when this payment attempt succeeded.
expire_date	Subscription expiry date for subscription payments (null for consumables).
original_purchase_date	First purchase date of the subscription.
price	Payment amount.
currency	Payment currency (USD, EUR, TRY etc.).
country	Country of purchase determined by payment metadata.
subscriptionId	Internal Zotlo subscription identifier (only for subscription payments).
refund	If the payment was refunded, contains refund metadata. Null otherwise.
exchange.status	Indicates whether currency exchange was applied.
exchange.detail	Additional exchange rate details if applicable.
checkout_type	Payment method (card, PayPal, GPay, ApplePay, etc.).
custom_parameters	May contains custom data (App specific user IDs, UTM data, Adjust/AppsFlyer/analytics IDs, IP address, etc.

Failed Response

All failed responses follow the same standard error format. (See: Error Handling)