Add-on Purchases

GET

https://api.zid.sa/v1/managers/market/addons/purchases

Retrieve all add-ons purchased by a merchant from your application, including one-time and monthly add-ons, their current status, billing periods, and payment history.

Use this endpoint to verify a merchant's purchased add-ons, synchronize entitlements, or recover from missed webhook events. The response includes only purchases associated with the authenticated store and calling application.

🔑Scopes

Subscription.read - Subscription Read

Tokens carry this scope internally as third_subscription_read. If you are inspecting a token's scopes while debugging, that is the name you will see.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zid.sa/v1/managers/market/addons/purchases?addon_id=a2e2b610-4637-4f98-a251-cb858c040d6b&type=monthly&status=active&page=1&per_page=20' \
--header 'Authorization: {{Autherization}}' \
--header 'X-manager-Token: {{Access-Token}}'

Response Example

200 - Example 1

{
    "status": "object",
    "addon_purchases": [
        {
            "addon_purchase_id": "a2e2b610-fb3b-4fd1-8ae3-cfa9555b4e69",
            "addon_id": "a2e2b610-4637-4f98-a251-cb858c040d6b",
            "app_id": 6760,
            "store_id": 20863,
            "store_uuid": "ccec9997-4938-3b70-9043-7207fb2f9dd9",
            "name": {
                "ar": "رسائل واتساب إضافية",
                "en": "Extra WhatsApp messages"
            },
            "type": "one_time",
            "is_targeted": false,
            "unit": {
                "ar": "رسالة",
                "en": "messages"
            },
            "quantity": 500,
            "status": "active",
            "period_start": "2026-10-02T13:00:08+00:00",
            "period_end": "2026-12-02T13:00:08+00:00",
            "cancelled_at": null,
            "expired_at": null,
            "refunded_at": null,
            "created_at": "2026-10-02T13:00:08+00:00",
            "payments": [
                {
                    "purchase_id": "14c67bf2-ad4f-4e5b-980c-f942492fb7e3",
                    "kind": "initial",
                    "amount_paid": "22.98",
                    "currency": "SAR",
                    "period_start": "2026-10-02T13:00:08+00:00",
                    "period_end": "2026-11-02T13:00:08+00:00",
                    "paid_at": "2026-10-02T13:00:08+00:00",
                    "refunded_at": null
                }
            ]
        }
    ],
    "pagination": {
        "total": 1,
        "current_page": 1,
        "last_page": 1,
        "per_page": 20
    }
}

Modified at 2026-11-10 14:09:58

Subscription Details