Subscription Details

GET

https://api.zid.sa/v1/market/app/subscription

This endpoint enables app partners to fetch details about a merchant's app subscription, including plan, status, and billing information.

🔑Scopes

Subscription.read - Subscription Read

Request

Header Params

Body Params application/x-www-form-urlencoded

Responses

🟢200OK

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zid.sa/v1/market/app/subscription' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Accept: application/json' \
--data-urlencode 'app_id=123'

Response Example

200 - Example 1

{
    "status": "object",
    "subscription": {
        "app_id": 2376,
        "store_id": 26520,
        "store_url": "https://example.zidtest.com/",
        "plan_name": "1استخدام",
        "subscription_status": "active",
        "start_date": "2025-02-04T15:55:07.000000Z",
        "end_date": null,
        "merchant_phone_no": "+201063989603",
        "merchant_email": "m.example@zid.sa",
        "is_usage_based": 1,
        "pending_charges": 100,
        "settled_charges": 1,
        "charges": [
            {
                "id": "9eaac8b0-3530-4bdb-b2fb-34b4efe22179",
                "subscription_id": 333,
                "amount": 300,
                "amount_details": {
                    "amount": 34500,
                    "currency": "SAR",
                    "formatted": "ر.س‎ 345.00"
                },
                "status": "pending",
                "overdue_at": null,
                "created_at": "2025-04-13T16:58:06.000000Z"
            }
        ]
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": "Store subscription details of the provided token"
    }
}

Modified at 2026-02-06 13:05:19

Events

Update Usage-Based Charges