Skip to main content

​
List Plans

Returns all available subscription plans with their types and pricing. 
GET /external-partner/plans
Headers
HeaderValue
API-KEYYour partner API key
Accept-Languagear or en
Response 
{
  "success": true,
  "data": [
    {
      "id": 37,
      "name": "Max",
      "description": "Best for large families",
      "bag_size": 10,
      "bags_count": 2,
      "service": {
        "name": "clothes",
        "type": { "code": "clothes", "name": "Clothes" }
      },
      "plan_types": [
        {
          "id": 42,
          "name": "1 wash",
          "orders_count": 1,
          "price": 209,
          "price_per_pag": 104.5,
          "discount_percentage": 35
        },
        {
          "id": 43,
          "name": "4 washes",
          "orders_count": 4,
          "price": 799,
          "price_per_pag": 99.88,
          "discount_percentage": 37
        }
      ],
      "color": "#F4C26A"
    }
  ],
  "status_code": 200
}

​
Plan Structure

FieldDescription
idPlan ID — used in subscribe
bag_sizeMax kg per bag
bags_countNumber of bags included
plan_typesPurchase options (e.g. 1 wash, 4 washes)
plan_types[].idPlan type ID — used in subscribe
plan_types[].orders_countNumber of pickups included — pass to Available Days
plan_types[].priceTotal price in SAR
colorHex color for the plan card UI