Zid Docs

Get Subscription Details

GETv1/market/app/subscription

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

Subscription.read - Subscription Read

Request

Header Params

string

required

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Example:

application/json

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6IlA3WTFZbWk1YVBTQnNrYkRtOFBGZGc9PSIsInZhbHVlIjoiL3QvVmtuMHFQdGNMdkNwZ0FCZkh3Y1l4aEs5NDhGVnFXbWVZYlFJb2kucdcNrekppN09CVTlnYlducjRLbjhXNzhFTFhhZDZTSXdRbUphSEYyUkZJWTJFZ0h3Ymlzb1RVNmxlaEkjgftrmpIZ1RmZXVFYUszZG5DZDZjbTRqNzByNVBMTktzYkQ3WGQ5MDhqbWo2NWFkT3MvRExmYVY4YXBCakkwSjR1L2pTbUR4dWZvd2h5K2tTQlAvRlN2TnZuOVFROW42WTRqZmtkWUZWem4rRXFLVU00aGJtQT0iLCJtYWMiOiJjM2U2ZGRmMjY1ZjFmMmI5YjZlMzFkMGFhNmMzYjM5ZjhiOWE0YjVhMzU2ZTRhYTkxOTVlYmFiMTVkY2I1NWQ2IiwidGFnIjoiIn0=

Accept-Language

string

required

Preferred language for the response. Defaults to en if not specified.

Example:

User-Agent

string

required

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

Body Params application/x-www-form-urlencoded

app_id

string

optional

Unique identifier for the application.

Example:

123

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

string

required

Indicates the status of the API response.

subscription

object

required

Contains the subscription details associated with the provided token.

app_id

integer

required

Unique identifier of the subscribed application.

Example:

2376

store_id

integer

required

Unique identifier of the store associated with the subscription.

Example:

26520

store_url

string

required

URL of the store associated with the subscription.

Example:

https://example.zidtest.com/

plan_name

string

required

Name of the subscription plan in Arabic.

Example:

1استخدام

subscription_status

string

required

Current status of the subscription.

Example:

active

start_date

string

required

Timestamp indicating when the subscription started.

Example:

2025-02-04T15:55:07.000000Z

end_date

null

required

Timestamp indicating when the subscription ends.

merchant_phone_no

string

required

Contact phone number of the merchant associated with the subscription.

Example:

+201063989603

merchant_email

string

required

Email address of the merchant associated with the subscription.

Example:

m.example@zid.sa

is_usage_based

integer

required

Indicates if the subscription follows a Usage-Based Pricing model. 1 for true (usage-based), 0 for false (fixed pricing).

Example:

pending_charges

integer

required

The amount of charges that are yet to be settled for the subscription.

Example:

100

settled_charges

integer

required

The total amount of charges that have been successfully settled.

Example:

message

object

required

Contains additional information about the API response.

type

object

optional

The type of the message.

code

null

optional

The code associated with the message.

name

null

optional

The name of the message.

description

string

optional

A detailed description of the message.

Example:

Store subscription details of the provided token

{
  "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": "+201089889606",
    "merchant_email": "m.example@zid.sa",
    "is_usage_based": 1,
    "pending_charges": 100,
    "settled_charges": 1
  },
  "message": {
    "type": "object",
    "code": null,
    "name": null,
    "description": "Store subscription details of the provided token"
  }
}

Last modified: 8 days ago