List Subscriptions

GET

https://api.techrar.com/order/v1/merchant/subscriptions/

This endpoint allows you to list all merchant subscriptions

Permission

can_read_order - orders read only

Filters

You can filter subscriptions with almost all the fields in the subscriptions e.g. start_date_from, start_date_to, status, ..etc

Light Objects

In most list endpoints, the returned object will be light.
Use the details endpoint to get a detailed object

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.techrar.com/order/v1/merchant/subscriptions/?search=&search=&page=1&page_size=5&order_by=' \
--header 'app-id: 4' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "count": 26,
    "next": "http://localhost/order/v1/merchant/subscriptions/?page=2&page_size=2",
    "previous": null,
    "results": [
        {
            "id": 102212,
            "custom_fields": null,
            "customer": {
                "id": 1,
                "country_code": "966",
                "username": "0534501056",
                "mobile_number": "966534501056",
                "email": "[email protected]",
                "name": "Safwan Saigh",
                "lang": "en",
                "current_city_id": 1,
                "is_email_verified": true,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "national_id": "1111782031",
                "secondary_mobile_number": "0534501056",
                "date_of_birth": "1999-02-25",
                "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
                "joined_at": "2022-03-12T14:51:15.115924Z",
                "custom_fields": null
            },
            "invoices": [
                {
                    "id": 192,
                    "serial": "-",
                    "amount": 100,
                    "status": "unpaid",
                    "payment_url": "http://localhost:8000/order/v1/checkout/192/?entity=invoice",
                    "created_at": "2025-05-13 01:54:39.076673+00:00",
                    "due_date": "2025-05-13 01:54:39.076389+00:00",
                    "payment_method": null,
                    "payment_provider": null
                },
                {
                    "id": 186,
                    "serial": "INV-202500064",
                    "amount": 0,
                    "status": "paid",
                    "payment_url": null,
                    "created_at": "2025-05-12 06:55:01.018092+00:00",
                    "due_date": "2025-05-12 06:55:01.017499+00:00",
                    "payment_method": "free",
                    "payment_provider": "techrar"
                }
            ],
            "next_invoice": {
                "id": 192,
                "serial": "-",
                "amount": 100,
                "status": "unpaid",
                "payment_url": "http://localhost:8000/order/v1/checkout/192/?entity=invoice",
                "created_at": "2025-05-13 01:54:39.076673+00:00",
                "due_date": "2025-05-13 01:54:39.076389+00:00",
                "payment_method": null,
                "payment_provider": null
            },
            "name_en": "Trial",
            "name_ar": "Trial",
            "item_id": 109,
            "app_id": 86,
            "created_at": "2025-05-12T09:55:01.343826+03:00",
            "customer_id": 1,
            "duration": 1,
            "duration_unit": "day",
            "start_date": "2025-05-12",
            "end_date": "2025-05-12",
            "status": "suspended",
            "in_trial": false,
            "trial_start_date": "2025-05-12",
            "trial_end_date": "2025-05-13",
            "paused_at": null,
            "total_billing_cycles": 0,
            "remaining_billing_cycles": 0,
            "auto_renew": true,
            "current_period_start_date": "2025-05-12",
            "current_period_end_date": "2025-05-12",
            "last_billing_date": "2025-05-12",
            "next_billing_date": "2025-05-13",
            "usage_counter": 0,
            "usage_limit": null,
            "usage_unit": "credit",
            "auto_increment_usage": false,
            "order": 257
        },
        {
            "id": 102211,
            "custom_fields": null,
            "customer": {
                "id": 1,
                "country_code": "966",
                "username": "0534501056",
                "mobile_number": "966534501056",
                "email": "[email protected]",
                "name": "Safwan Saigh",
                "lang": "en",
                "current_city_id": 1,
                "is_email_verified": true,
                "is_mobile_verified": true,
                "is_blocked": false,
                "is_deleted": false,
                "is_verified": true,
                "national_id": "1111782031",
                "secondary_mobile_number": "0534501056",
                "date_of_birth": "1999-02-25",
                "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
                "joined_at": "2022-03-12T14:51:15.115924Z",
                "custom_fields": null
            },
            "invoices": [
                {
                    "id": 185,
                    "serial": "INV-202500063",
                    "amount": 0,
                    "status": "paid",
                    "payment_url": null,
                    "created_at": "2025-05-12 06:54:00.076216+00:00",
                    "due_date": "2025-05-12 06:54:00.075512+00:00",
                    "payment_method": "free",
                    "payment_provider": "techrar"
                },
                {
                    "id": 201,
                    "serial": "-",
                    "amount": 100,
                    "status": "unpaid",
                    "payment_url": "http://localhost:8000/order/v1/checkout/201/?entity=invoice",
                    "created_at": "2025-05-13 16:02:16.321041+00:00",
                    "due_date": "2025-05-13 16:02:16.285731+00:00",
                    "payment_method": null,
                    "payment_provider": null
                }
            ],
            "next_invoice": {
                "id": 201,
                "serial": "-",
                "amount": 100,
                "status": "unpaid",
                "payment_url": "http://localhost:8000/order/v1/checkout/201/?entity=invoice",
                "created_at": "2025-05-13 16:02:16.321041+00:00",
                "due_date": "2025-05-13 16:02:16.285731+00:00",
                "payment_method": null,
                "payment_provider": null
            },
            "name_en": "Trial",
            "name_ar": "Trial",
            "item_id": 109,
            "app_id": 86,
            "created_at": "2025-05-12T09:54:00.406305+03:00",
            "customer_id": 1,
            "duration": 1,
            "duration_unit": "day",
            "start_date": "2025-05-12",
            "end_date": "2025-05-12",
            "status": "suspended",
            "in_trial": false,
            "trial_start_date": "2025-05-12",
            "trial_end_date": "2025-05-13",
            "paused_at": null,
            "total_billing_cycles": 0,
            "remaining_billing_cycles": 0,
            "auto_renew": true,
            "current_period_start_date": "2025-05-12",
            "current_period_end_date": "2025-05-12",
            "last_billing_date": "2025-05-12",
            "next_billing_date": "2025-05-13",
            "usage_counter": 0,
            "usage_limit": null,
            "usage_unit": "credit",
            "auto_increment_usage": false,
            "order": 256
        }
    ]
}

Modified at 2025-06-17 09:40:45

Subscriptions

Subscription Details